Merge branch 'master' of github.com:elabftw/elabapi-python

* 'master' of github.com:elabftw/elabapi-python:
  examples: JSON-ify 'metadata' explicitly (#48)
  feat: fetch openapi.yaml file from release assets (#49)

Author: NicolasCARPi

examples/02-patch-metadata-per-category.py

@@ -1,4 +1,7 @@
 #!/usr/bin/env python
+import json
+from json import JSONDecodeError
+
 import elabapi_python
 from client import api_client
 
@@ -11,10 +14,45 @@
 # create an instance of Items api
 itemsApi = elabapi_python.ItemsApi(api_client)
 
-metadata = '{"elabftw": {"extra_fields_groups": [{"id": 1,"name": "Drug settings"},{"id": 2,"name": "Mice info"}]},"extra_fields": {"Drug addition": {"type": "datetime-local","value": "","group_id": 1,"required": true,"description": "Time when drug is added"},"Drug concentration": {"type": "number","unit": "mM","units": ["mM","μM","nM"],"value": "","group_id": 1,"required": true},"Mouse sex": {"type": "select","value": "Male","options": ["Male","Female"],"group_id": 2}}}'
+metadata = {
+    "elabftw": {
+        "extra_fields_groups": [
+            {"id": 1, "name": "Drug settings"},
+            {"id": 2, "name": "Mice info"},
+        ]
+    },
+    "extra_fields": {
+        "Drug addition": {
+            "type": "datetime-local",
+            "value": "",
+            "group_id": 1,
+            "required": True,
+            "description": "Time when drug is added",
+        },
+        "Drug concentration": {
+            "type": "number",
+            "unit": "mM",
+            "units": ["mM", "μM", "nM"],
+            "value": "",
+            "group_id": 1,
+            "required": True,
+        },
+        "Mouse sex": {
+            "type": "select",
+            "value": "Male",
+            "options": ["Male", "Female"],
+            "group_id": 2,
+        },
+    },
+}
 
 for item in itemsApi.read_items(cat=RESOURCE_CATEGORY_ID, limit=9999):
     # skip items with metadata already
     if not item.metadata:
-        print(f'Patching item {item.id}')
-        itemsApi.patch_item(item.id, body={'metadata': metadata})
+        print(f"Patching item {item.id}")
+        try:
+            itemsApi.patch_item(item.id, body={"metadata": json.dumps(metadata)})
+        except JSONDecodeError as e:
+            raise ValueError(
+                "'metadata' passed to API request body contains invalid JSON."
+            ) from e

helper.sh

@@ -21,12 +21,26 @@ else
     generator_flag="-g"
 fi
 
-# where to grab the definition file
-openapi_yaml_url="https://raw.githubusercontent.com/elabftw/elabftw/master/apidoc/v2/openapi.yaml"
 # folder with the generated python code
 lib="generated"
 html="html"
 
+# we fetch the openapi.yaml file from release
+gh_api_release_url="https://api.github.com/repos/elabftw/elabftw/releases/latest"
+
+browser_url="$(
+  curl -fsSL \
+    -H "Accept: application/vnd.github+json" \
+    -H "User-Agent: elabftw-script" \
+    "$gh_api_release_url" \
+  | jq -r '.assets[] | select(.name == "openapi.yaml") | .browser_download_url'
+)"
+
+if [ -z "$browser_url" ] || [ "$browser_url" = "null" ]; then
+  echo "openapi.yaml not found in latest release assets" >&2
+  exit 1
+fi
+
 function cleanup {
     rm -rfv "$lib"
     rm -rfv "$html"
@@ -35,17 +49,17 @@ function cleanup {
 # generate the lib from remote spec
 function generate {
     cleanup
-    docker run --user "$(id -u)":"$(id -u)" --rm -v "${PWD}":/local "$docker_image" generate -i "$openapi_yaml_url" "$generator_flag" python -o /local/"$lib" -c /local/config.json --git-user-id elabftw --git-repo-id elabapi-python
+    docker run --user "$(id -u)":"$(id -u)" --rm -v "${PWD}":/local "$docker_image" generate -i "$browser_url" "$generator_flag" python -o /local/"$lib" -c /local/config.json --git-user-id elabftw --git-repo-id elabapi-python
 }
 
 function generate-html {
     cleanup
-    docker run --user "$(id -u)":"$(id -u)" --rm -v "${PWD}":/local "$docker_image" generate -i "$openapi_yaml_url" "$generator_flag" html2 -o /local/"$html" -c /local/config.json --git-user-id elabftw --git-repo-id elabapi-python
+    docker run --user "$(id -u)":"$(id -u)" --rm -v "${PWD}":/local "$docker_image" generate -i "$browser_url" "$generator_flag" html2 -o /local/"$html" -c /local/config.json --git-user-id elabftw --git-repo-id elabapi-python
 }
 
 # don't use user/group ids in GH actions
 function generate-ci {
-    docker run --rm -v "${PWD}":/local "$docker_image" generate -i "$openapi_yaml_url" "$generator_flag" python -o /local/"$lib" -c /local/config.json --git-user-id elabftw --git-repo-id elabapi-python
+    docker run --rm -v "${PWD}":/local "$docker_image" generate -i "$browser_url" "$generator_flag" python -o /local/"$lib" -c /local/config.json --git-user-id elabftw --git-repo-id elabapi-python
     # fix permissions
     sudo chown -R "$(id -u)":"$(id -gn)" "$lib"
 }