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

fix(docs): Correct OpenAPI definition by fixing missing reference #10664

Merged
merged 1 commit into from
Aug 10, 2024

Conversation

teleboas
Copy link
Member

@teleboas teleboas commented Aug 9, 2024

The api.yaml file contained a reference to a non-existent ./responses/change_ref_properties.yaml file, causing validation to fail. This PR adds the missing file to ensure the OpenAPI definition is valid.

Related issue(s) and discussion

@teleboas teleboas requested a review from a team as a code owner August 9, 2024 06:18
@github-actions github-actions bot added the 📚 Documentation Documentation issues improve the project for everyone. label Aug 9, 2024
…0659)

The `api.yaml` file contained a reference to a non-existent `./responses/change_ref_properties.yaml` file, causing validation to fail.
This commit adds the missing file to ensure the OpenAPI definition is valid.
@teleboas teleboas force-pushed the fix/10659-invalid-openapi-definition branch from ddd88a6 to 308f6ae Compare August 9, 2024 14:31
Copy link

sonarcloud bot commented Aug 9, 2024

Copy link
Member

@teolemon teolemon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's really cool :-) will it allow us for automatic SDK generation? do we still have some stuff to sort out (I remember @alexgarel talking about wildcards)

@teleboas teleboas merged commit 4f0f10e into main Aug 10, 2024
13 checks passed
@teleboas teleboas deleted the fix/10659-invalid-openapi-definition branch August 10, 2024 05:36
@alexgarel
Copy link
Member

thanks @teleboas !

@teolemon ATM I fear our API is too much on the edge for automatic SDK generation to really be useful (because of extensive use of pattern properties)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 Documentation Documentation issues improve the project for everyone.
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Invalid Swagger/OpenAPI Definition for API v2 and v3
4 participants