API Documentation available in the gridX Developer Community

🎤 Announcements
4

You kept on speaking, and we didn’t stop listening. @s.wuerth nudged us to finally push out changelogs for API changes.You might already have noticed it, depending on which private API categories you have access to.
If you haven’t: We’re generating changelogs for each API change automagically now on each release.

For stable APIs, we still make non-breaking changes that will be described in the logs.
Beta APIs might be subject to breaking changes, too. We’ll dig deeper into our currently evolving versioning strategy soon.

You can find them here:

Don’t worry if they are still empty - not all of the APIs have seen changes recently. But you can already subscribe to the logs relevant for you and stay in the know.

Here's a contrived example of how they (will) look like

POST /systems

  • :warning: removed the required property ‘createdAt’ from the response with the ‘201’ status
  • :warning: removed the optional property ‘productOptionUpdatedAt’ from the response with the ‘201’ status
  • added the optional property ‘productOptionUpdatedAtFoo’ to the response with the ‘201’ status

GET /systems/{systemID}

  • :warning: removed the required property ‘createdAt’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘productOptionUpdatedAt’ from the response with the ‘200’ status
  • added the optional property ‘productOptionUpdatedAtFoo’ to the response with the ‘200’ status

PATCH /systems/{systemID}

  • :warning: removed the required property ‘createdAt’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘productOptionUpdatedAt’ from the response with the ‘200’ status
  • added the optional property ‘productOptionUpdatedAtFoo’ to the response with the ‘200’ status

You can use the information from the changelogs to quickly see new features or updates in the APIs as they become available and see whether you can optimize your API usage based on that. As always: If you notice any odd behavior, let us know!

And if you’re curious how we built this: We use oasdiff wrapped into a GitHub action and another one to post the result to the forum. Similar to what we did with the specs and snippets as described :point_up_2:. It’s evolved into a nice toolchain, and we’ll probably write it down in detail somewhere. Would you be interested? Let us know!

image
image1005×846 101 KB

💡 Tip: Subscribe to API Change Logs