Validation of OpenAPI Spec?
See original GitHub issueI think we started a discussion somewhere about this, but I could not find it.
Maybe at API level we could defines an interface to report OpenAPI validation issues.
Example of an invalid spec:
OASFactory.createSchema()
.ref("#/components/schemas/SomeObj")
.type(Schema.SchemaType.OBJECT) // Wrong value because "$ref" is present
.description("The hello type") // Wrong value because "$ref" is present
KaiZen:
KaiZen have a ValidationItem to report a severity, a message and a position.
The position is strongly coupled with the source file (JSON), which might be not ideal in our case because the model can be derived from the Annotations or built from scratch using the OASFactory
.
But if someone build a parser that uses the Eclipse-MP-OpenAPI model, then having the location in the source file (JSON or YAML) might also be interesting.
Issue Analytics
- State:
- Created 5 years ago
- Comments:5 (5 by maintainers)
Top Results From Across the Web
How to validate OpenAPI definitions - Swagger
How to validate OpenAPI definitions in Swagger Editor using GitHub Actions. ... The OpenAPI Specification (OAS) defines a standard, ...
Read more >Handling API validation with OpenAPI (Swagger) documents ...
Using the OpenAPI specification, I created an nodejs express app that uses the spec to enforce validation on the endpoints I wrote, ...
Read more >OpenAPI Codegen - openVALIDATION
The validation integrated in OpenAPI Specification is based on the JSON Schema Validation specification. Each of the specified validation options mainly ...
Read more >How to validate openapi 3.0.0 yaml spec? - Stack Overflow
I have a yaml specification that has been updated from swagger 2.0 to openapi 3.0. 0. The file itself is about 7,000 lines...
Read more >Swagger & OpenAPI Online Validator - API Dev Tools
Swagger/OpenAPI online validator · Validate against Swagger/OpenAPI schema · Validate against Swagger/OpenAPI spec.
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
One of the things we discussed at the hangout today was:
mp.openapi.validation
Document is valid
) by callingopenapi/validation
The validation support would be optional for vendors. Thoughts?
Closing for now, please reopen if there is still interest in this feature.