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.

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

Conversation

thgreasi
Copy link
Member

@thgreasi thgreasi commented Feb 19, 2024

Since these do not use the release_tags for picking the versions, I've put this as draft and merge it after https://github.com/balena-io/balena-api/pull/4821 gets released, which bacfills the semver fields of all releases from their release_tags, so that users don't get confused by the v0.0.0 versions.

Depends-on: https://github.com/balena-io/balena-api/pull/4821
Change-type: minor
See: https://balena.zulipchat.com/#narrow/stream/345889-balena-io.2Fos/topic/Determine.20list.20of.20supported.20OS.28hostapp.29.20for.20a.20device-type/
See: https://balena.fibery.io/Work/Task/Add-docs-for-retrieving-the-OS-releases-via-the-hostApp-release-OData-endpoints-1848


Please make sure to read the CONTRIBUTING document before opening the PR for relevant information on contributing to the documentation. Thanks!

@thgreasi thgreasi requested review from a team March 14, 2024 15:32
@thgreasi thgreasi marked this pull request as ready for review March 14, 2024 15:43
@thgreasi thgreasi enabled auto-merge March 14, 2024 15:47
@thgreasi thgreasi disabled auto-merge March 14, 2024 15:55
@chrisys
Copy link
Member

chrisys commented Mar 14, 2024

I'd suggest putting the public device type first, above and before the private DT one, with description:

'To request a list of the supported balenaOS versions for a particular device type, the deviceType 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.'

Then the private DT one would have:

'Same as above, but in order to access private device types, you must provide an authentication token'

@thgreasi thgreasi marked this pull request as draft March 14, 2024 16:13
{
"id": "list-balenaos-versions-for-private-device-type",
"summary": "List the supported balenaOS versions for a private device type",
"description": "In order to be able to access balenaOS versions of a private device type, you need to provide your bearer token. The `deviceType` 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.",
Copy link
Member

@myarmolinsky myarmolinsky Mar 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"description": "In order to be able to access balenaOS versions of a private device type, you need to provide your bearer token. The `deviceType` 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.",
"description": "In order to be able to access balenaOS versions of a private device type, you need to provide your bearer token. The `deviceType` parameter is required. Even though this query by default only selects the `raw_version` field, you can additionally specify any of the fields found in the `release` resource.",

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo in your suggestion @myarmolinsky

Copy link
Member Author

@thgreasi thgreasi Mar 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel that's a bit redundant tbh @myarmolinsky , since the query either selects or doesn't, it's not a default function parameter of a function for example. Lets leave Chris' perfection intact :)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo in your suggestion @myarmolinsky

Thank you :P

@thgreasi thgreasi marked this pull request as ready for review March 14, 2024 16:29
@thgreasi thgreasi merged commit 3283e7e into master Mar 14, 2024
47 checks passed
@thgreasi thgreasi deleted the os-versions branch March 14, 2024 16:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants