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

Clarify use of <DEVICE ID> in API Documentation #1881

Open
vipulgupta2048 opened this issue Apr 29, 2021 · 2 comments · May be fixed by #1961
Open

Clarify use of <DEVICE ID> in API Documentation #1881

vipulgupta2048 opened this issue Apr 29, 2021 · 2 comments · May be fixed by #1961

Comments

@vipulgupta2048
Copy link
Member

Folks often get confused with the use of DEVICE_ID in the API. It's a unique property that is visible nowhere on the UI to refer to a device apart from the UUID. Having a definition about DEVICE_ID on the resources page where folks are using it might prove to be helpful.

For example, at the top of this page https://www.balena.io/docs/reference/api/resources/device/ we can add a definition for DEVICE_ID to mention what it is for folks to refer before executing any queries.

@jellyfish-bot
Copy link

[vipulgupta2048] This issue has attached support thread https://jel.ly.fish/2c7e1a80-1af9-419a-89b7-25d278391b1c

@jellyfish-bot
Copy link

[jakogut] This issue has attached support thread https://jel.ly.fish/20e29b5e-fa8d-49b9-88f3-d831b1573afa

@jakogut jakogut linked a pull request Jul 2, 2021 that will close this issue
@vipulgupta2048 vipulgupta2048 linked a pull request Jul 6, 2021 that will close this issue
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 a pull request may close this issue.

2 participants