Rest API specification does not pass OpenAPI 2.0 validation requirements

Posts about the simPRO API. Help/support/how-to etc.
Forum rules
  • Check the documentation first. Before posting questions, please check the documentation to ensure it doesn't already cover what you need.
  • No spam. All automated messages, advertisements, and links to competitor websites will be deleted immediately.
  • Post in relevant sub-forums only. Messages posted in the wrong topic area will be removed and placed in the correct sub-forum by moderators.
  • Respect other users. No flaming or abusing fellow forum members. Users who continue to post inflammatory, abusive comments will be deleted from the forum after two warnings are issued by moderators.
  • Harassment. No threats or harassment of other users will be tolerated. Any instance of threatening or harassing behavior is grounds for deletion from the forums.
  • Adult content. No profanity or pornography is allowed. Posts containing adult material will be deleted.
  • Bandwidth. All images and signatures must be 500 x 500 pixels or smaller. Posts containing over-sized images and signatures will be removed.
  • Illegal content. No re-posting of copyrighted materials or other illegal content is allowed. Any posts containing illegal content or copyrighted materials will be deleted.
Post Reply
charris_clockshark
Posts: 1
Joined: Fri Jul 07, 2023 12:44 am

Rest API specification does not pass OpenAPI 2.0 validation requirements

Post by charris_clockshark » Fri Jul 07, 2023 12:50 am

Hello,

The OpenAPI specification provided here does not seem to conform to the correct validation requirements for OpenAPI.
https://developer.simprogroup.com/apidoc/swagger.zip

This causes problems when attempting to generate an appropriate client such as bad model names.
Attached is a list of validation errors as the specification currently exists.

Additionally, on closer inspection, it seems like the definitions are useless because they aren't being referenced in the paths that get defined.
See the input and output model structure defined here: https://swagger.io/docs/specification/2 ... -structure
The specification should use `$ref` under the schema node to refer to a model defined in the definitions section.

OpenAPI publishes schema validation tools. There is even a validator that can be used online:
https://apitools.dev/swagger-parser/online

Can we get an API specification that passes OpenAPI 2.0 validation? Thank you.
Attachments
Swagger schema validation failed..7z
(114.94 KiB) Downloaded 137 times
Top
Post Reply

Return to “General Discussion”