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: OpenAPI spec invalid #710

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Conversation

jspdown
Copy link

@jspdown jspdown commented Sep 27, 2023

This PR fixes the generated OpenAPI spec document to be v2.0 compliant.

The most important changes are the removal of the deprecated/non-standard SmartAPI fields responsibleOrganization and responsibleDeveloper. And the removal of the non-standard protocol field at the top level.

These fields alone prevented the use of HTTPBin spec on most OAS compliant tooling.

@exhuma
Copy link

exhuma commented Sep 27, 2023

Are all those "required" additions really "required"? Note that I've only quickly squinted at this MR through the prism of the "diff" so I am missing some context. The int/number change looks definitely correct though.

nb: You might want to move this PR over to https://github.com/psf/httpbin

@jspdown
Copy link
Author

jspdown commented Oct 2, 2023

@exhuma Thanks for your feedback.

The Parameter object defined in the OAS v2 specification has a special requirement when the type of a parameter is path:

If the parameter is in "path", this property is required and its value MUST be true.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#fixed-fields-7

About psf/httpbin, I wasn't aware of this fork. I will make sure to submit the PR there as well.

@immanuelfodor
Copy link

Checking the PRs there, could you please send it to the fork, too?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants