-
-
Notifications
You must be signed in to change notification settings - Fork 481
IoT API Article changes #730
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
Conversation
✅ docs-content deploy preview ready
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
“Applications” is a bit confusing to me because it seems to apply to both APIs, no? Personally, I would use “Configuration API” and “Data API” to base the name on the actual purpose and distinguish them better…
I would also improve a bit the structure of the article which is not super clear. For instance, the “backward compatibility policy” only applies to the REST API and not to the MQTT one.
Proposed structure:
- One-sentence intro “Arduino IoT Cloud has two different set of APIs. Read below to learn more”.
- Configuration API
- What you can achieve with it (practical examples, please avoid generic sentences like “Automate and integrate different IoT Solutions with a single, powerful Cloud”)
- What resources/actions are available through it
- Link to documentation
- Data API
- What you can achieve with it (practical examples)
- What resources/actions are available through it
- Link to documentation
I believe backward compatibility policy should be moved to the documentation page of each API or library, because they are different.
(Sorry for being so pedantic but I care a lot about documentation clarity)
06b46e5
to
d4308b0
Compare
What This PR Changes
Contribution Guidelines