Merge branch 'main' of github.com:edutap-eu/documentation

edutap-eu · Dec 9, 2024 · edd7239 · edd7239
2 parents 7fb604f + a0a7436
commit edd7239
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 6 deletions.
diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml
@@ -43,7 +43,7 @@ jobs:
       run: |
         make docs
     - name: Upload artifact
-      uses: actions/upload-pages-artifact@v1
+      uses: actions/upload-pages-artifact@v3
       with:
         # Upload entire repository
         path: 'html'

diff --git a/source/glossary.md b/source/glossary.md
@@ -1,7 +1,7 @@
 (glossary)=
 # Glossary
 
-`````{glossary}
+```{glossary}
 ---
 sorted:
 ---

diff --git a/source/packages/edutap_wallet_google/index.md b/source/packages/edutap_wallet_google/index.md
@@ -6,7 +6,7 @@ It provides an API to
 - create, read, update, disable, and list Wallet Classes, Wallet Objects, and related items,
 - issue passes.
 
-The package contains validating data-models made with [Pydantic](https://docs.pydantic.dev/).
+The package contains validating data-models of the Google data structures made with [Pydantic](https://docs.pydantic.dev/).
 
 Behind the scenes it provides a session manager for authorized HTTPS communication with the Google Restful API.
 An extensible registry for additional models of classes and objects ensures extendibility.

diff --git a/source/packages/edutap_wallet_google/installation.md b/source/packages/edutap_wallet_google/installation.md
@@ -34,6 +34,12 @@ tox -e lint
 
 ## Configuration
 
+Configuration is done using environment variables.
+
+If available, dotenv-files (`.env`) are respected.
+
+### How to connect with Google
+
 In order to create new Wallet Classes and Wallet Objects you need to have a Google Developer account and a Google Wallet API project.
 
 To authenticate with the Google API, you need to provide a credentials file and an issuer ID.
@@ -59,3 +65,8 @@ Copy the value and point the environment variable `EDUTAP_WALLET_GOOGLE_ISSUER_I
 ```bash
 export EDUTAP_WALLET_GOOGLE_ISSUER_ID=1234567890123456789
 ```
+
+### Debugging
+
+The traffic from and to Google can be logged to a file.
+If the environment variable `EDUTAP_WALLET_GOOGLE_RECORD_API_CALLS_DIR` is set to a writeable directory, all traffic is recorded there.
diff --git a/source/packages/edutap_wallet_google/reference.md b/source/packages/edutap_wallet_google/reference.md
@@ -44,9 +44,6 @@ Models can be the different top-level wallet-classes or -objects, but also issue
 
    GenericClass
    GenericObject
-   Notifications
-   ExpiryNotification
-   UpcomingNotification
 
 .. rubric:: Message
 
@@ -118,8 +115,22 @@ Models can be the different top-level wallet-classes or -objects, but also issue
 
 ### Data-Types
 
+
 ```{eval-rst}
 
+.. currentmodule:: edutap.wallet_google.models.generic
+
+.. rubric:: Generic
+
+`edutap.wallet_google.models.generic`
+
+.. autosummary::
+   :toctree: _autosummary
+
+   Notifications
+   ExpiryNotification
+   UpcomingNotification
+
 .. currentmodule:: edutap.wallet_google.models.retail
 
 .. rubric:: Retail