Skip to content

Conversation

eclipse1985
Copy link

What This PR Changes

  • We have only 2 API types, so the article has been restructured a bit
  • The original mean was to be a sort of index, so API details should go in other places

Contribution Guidelines

@eclipse1985 eclipse1985 changed the title Fmirabito/iot cloud api changes IoT API Article changes Dec 14, 2022
@gatsby-cloud
Copy link

gatsby-cloud bot commented Dec 14, 2022

✅ docs-content deploy preview ready

@karlsoderby karlsoderby changed the base branch from main to karlsoderby/iot-cloud-api December 14, 2022 12:47
@eclipse1985 eclipse1985 requested a review from alranel December 20, 2022 15:01
Copy link
Contributor

@alranel alranel left a 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)

@eclipse1985 eclipse1985 changed the base branch from karlsoderby/iot-cloud-api to main December 27, 2022 12:24
@eclipse1985 eclipse1985 force-pushed the fmirabito/iot-cloud-api-changes branch from 06b46e5 to d4308b0 Compare December 27, 2022 12:26
@karlsoderby karlsoderby requested a review from alranel January 3, 2023 09:58
@karlsoderby karlsoderby merged commit 4ae64ca into main Jan 18, 2023
@karlsoderby karlsoderby deleted the fmirabito/iot-cloud-api-changes branch January 18, 2023 15:20
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 this pull request may close these issues.

3 participants