API/Resources: Add docs for the device type resource
#2907
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
config/dictionaries/resource.json
Outdated
Comment on lines
455
to
456
| "summary": "Get the details of a device type by ID.", | ||
| "description": "The bearer token is optional for targeting public device types, but is required for private ones.", |
There was a problem hiding this comment.
Suggested change
| "summary": "Get the details of a device type by ID.", | |
| "description": "The bearer token is optional for targeting public device types, but is required for private ones.", | |
| "summary": "Get device type by ID", | |
| "description": "You can add a bearer token to the request for target private device types", |
By ID it be better to specify exactly what ID we need for this request. Explicitly mentioning is better.
If you like the description, then please change that for all entries.
config/dictionaries/resource.json
Outdated
| }, | ||
| { | ||
| "id": "device-type-by-handle", | ||
| "summary": "Get the details of a device type by its SLUG.", |
There was a problem hiding this comment.
Suggested change
| "summary": "Get the details of a device type by its SLUG.", | |
| "summary": "Get device type by slug", |
What slug is that? Where can people find it?
config/dictionaries/resource.json
Outdated
| }, | ||
| { | ||
| "id": "device-type-by-name", | ||
| "summary": "Get the details of a device type by its NAME.", |
There was a problem hiding this comment.
Suggested change
| "summary": "Get the details of a device type by its NAME.", | |
| "summary": "Get device type by its NAME", |
Whose name?
config/dictionaries/resource.json
Outdated
| }, | ||
| { | ||
| "id": "get-supported-device-types", | ||
| "summary": "Get all supported device types.", |
There was a problem hiding this comment.
Suggested change
| "summary": "Get all supported device types.", | |
| "summary": "Get all supported device types", |
Will the list include BalenaOS release ones?
Change-type: minor
vipulgupta2048
approved these changes
Feb 19, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Change-type: minor