Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve validation of generator input #9

Open
kierans opened this issue Nov 30, 2023 · 0 comments
Open

Improve validation of generator input #9

kierans opened this issue Nov 30, 2023 · 0 comments
Assignees
Labels
@api-sdk-creator/generator Tag for the @api-sdk-creator/generator module

Comments

@kierans
Copy link
Member

kierans commented Nov 30, 2023

The current POC of the generator combines validation with transformation which isn't the best idea.

Validation should be broken into a separate phase and not only checks that the input is valid against the various JSON schemas that define the Open API spec, but also that semantics of the spec makes sense, for example, do $refs resolve correctly.

In order to perform schema validation correctly, there needs to be a list of the various schemas used and how they're comprised as schemas extend/consume other schemas.

The first version of the validator should target Open API versions 3.0.x and 3.1.x while being extendable to add Swagger 2 support

@kierans kierans added the @api-sdk-creator/generator Tag for the @api-sdk-creator/generator module label Nov 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@api-sdk-creator/generator Tag for the @api-sdk-creator/generator module
Projects
None yet
Development

No branches or pull requests

2 participants