Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API/Resources: Add docs listing the balenaOS versions of a device type #2908

Merged
merged 1 commit into from
Mar 14, 2024
+23 −0
Merged

API/Resources: Add docs listing the balenaOS versions of a device type #2908

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions config/dictionaries/resource.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -670,6 +670,29 @@
}
]
},
{
"id": "balenaos_versions",
"name": "List balenaOS versions",
"fields": [],
"examples": [
{
"id": "list-balenaos-versions-for-device-type",
"summary": "List the supported balenaOS versions for a device type",
"description": "To request a list of the supported balenaOS versions for a particular device type, the `DEVICE TYPE SLUG` parameter is required. Even though this query only selects the `raw_version` field, you can additionally specify any of the fields found in the release resource. The Authorization header is optional.",
"method": "GET",
"endpoint": "/v6/release",
"filters": "?\\$select=raw_version&\\$filter=(is_final%20eq%20true)%20and%20(is_invalidated%20eq%20false)%20and%20(status%20eq%20'success')%20and%20(semver_major%20gt%200)%20and%20(belongs_to__application/any(bta:(bta/is_host%20eq%20true)%20and%20(bta/is_for__device_type/any(dt:dt/slug%20eq%20'<DEVICE TYPE SLUG>'))))&\\$orderby=semver_major%20desc,semver_minor%20desc,semver_patch%20desc,revision%20desc"
},
{
"id": "list-balenaos-versions-for-private-device-type",
"summary": "List the supported balenaOS versions for a private device type",
"description": "Same as above, but in order to access private device types, you must provide an authentication token.",
"method": "GET",
"endpoint": "/v6/release",
"filters": "?\\$select=raw_version&\\$filter=(is_final%20eq%20true)%20and%20(is_invalidated%20eq%20false)%20and%20(status%20eq%20'success')%20and%20(semver_major%20gt%200)%20and%20(belongs_to__application/any(bta:(bta/is_host%20eq%20true)%20and%20(bta/is_for__device_type/any(dt:dt/slug%20eq%20'<DEVICE TYPE SLUG>'))))&\\$orderby=semver_major%20desc,semver_minor%20desc,semver_patch%20desc,revision%20desc"
}
]
},
{
"id": "download",
"name": "Download balenaOS",
Expand Down
Loading