docs icon indicating copy to clipboard operation
docs copied to clipboard

Published 20 hours ago • verified publisher icon balena-io

Clarify use of <DEVICE ID> in API Documentation

Open vipulgupta2048 opened this issue 3 years ago • 2 comments

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.

vipulgupta2048 avatar Apr 29 '21 05:04 vipulgupta2048

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

jellyfish-bot avatar Apr 29 '21 05:04 jellyfish-bot

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

jellyfish-bot avatar Jul 02 '21 00:07 jellyfish-bot