Merge pull request #2808 from balena-io/resources-release-versioning

API/Resources: Add docs about the release versioning fields
balena-io · Sep 19, 2023 · 152b6b9 · 152b6b9
2 parents c2e8830 + 547e491
commit 152b6b9
Showing 1 changed file with 25 additions and 0 deletions.
diff --git a/config/dictionaries/resource.json b/config/dictionaries/resource.json
@@ -818,6 +818,15 @@
       "created_at",
       "belongs_to__application",
       "is_created_by__user",
+      "raw_version",
+      "semver",
+      "semver_major",
+      "semver_minor",
+      "semver_patch",
+      "semver_prerelease",
+      "semver_build",
+      "revision",
+      "variant",
       "commit",
       "composition",
       "status",
@@ -839,6 +848,22 @@
         "endpoint": "/v6/release",
         "filters": "?\\$filter=belongs_to__application%20eq%20<FLEET ID>"
       },
+      {
+        "id": "release-raw-version",
+        "summary": "Get the release raw_version field",
+        "description": "The raw_version field is returned only when explicitly requested with $select.",
+        "method": "GET",
+        "endpoint": "/v6/release(<ID>)",
+        "filters": "?\\$select=raw_version"
+      },
+      {
+        "id": "release-from-fleet-and-raw-version",
+        "summary": "Get a release ID given a specific fleet and version",
+        "description": "",
+        "method": "GET",
+        "endpoint": "/v6/release",
+        "filters": "?\\$filter=belongs_to__application%20eq%20<FLEET ID>%20and%20raw_version%20eq%20'<RAW VERSION>'&\\$select=id"
+      },
       {
         "id": "release-from-fleet-and-commit",
         "summary": "Get a release ID given a specific fleet and commit",