particle-iot / particle-iot/docs
Cloud API "Get Device Information" is out-of-date
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 148
- Forks
- 266
- Avg merge
- 14h 41m
- Merged PRs (30d)
- 16
Description
In the Cloud API, the "Get Device Information" section appears to be out of date.
There are several undocumented attributes that the API currently returns:
last_ip_address
product_id1
platform_id
cellular
status
pinned_build_target
1 product_id is documented, but is missing information relating to the Electron; If the Electron's default product_id is different than the Core or the Photon, it should probably be listed at the same location in the Docs. This is the information I was actually looking for when I discovered that there are a whole bunch of missing things here.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the linked Cloud API “Get Device Information” section and search the documentation for that heading. Compare the documented response with the listed returned attributes, add the missing fields, and clarify the Electron product_id information; done means the section matches the current API response.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100