OpenAPI specification for easier integration #84
Unanswered
MaximeRougieux
asked this question in
Ideas
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
Hi, thank you for the work on the API documentation, it is very well detailed so far.
I'm launching a new project that will communicate with multiple ArcXP APIs, including the Content API, and at first I was pleased to see there is a swagger embedded in the docs, because I was planning on using OpenAPI generator to generate an ArcXP HTTP client for my language. But then I saw that the APIs documentation were actually not following the OpenAPI standards.
Indeed, there are very detailed examples in the Swagger docs, but the Schema section is almost empty and does not follow the structure that seem to be used in the example section. Unfortunately, that's what is used by tools like OpenAPI generators to generate an HTTP client. Note that I'm talking about the response section of the schema, as the parameters section seem to be perfectly documented.
Considering this is an industry standard, and the popularity of the ArcXP platform, I was surprised to see that, is there a particular reason this is not implemented? Would that be in your interest to improve the documentation schema for ArcXP APIs?
Beta Was this translation helpful? Give feedback.
All reactions