-
Notifications
You must be signed in to change notification settings - Fork 80
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
Update specs to OpenAPI 3.0.1 #1120
Conversation
|
5194446
to
174760a
Compare
Rebased but I still need to update service-checker to also look for the base URL at |
We are not going to deploy this very soon, so no rush |
@clarakosi I think we are finally getting ready to deploy this :) Could you (a) rebase on top of current master (a lot of things have changed!); and (b) bump hyperswitch' version to 0.12.2, please? |
@clarakosi euh, this moved to v0.12.3 :P |
2abad4e
to
3cf9836
Compare
3e8943c
to
8ab854c
Compare
One small comment, otherwise it's great! |
Bug: T218218
Great! |
Dependent on Hyperswitch PR
I should’ve caught this earlier but the online swagger validator we were using does not support v3.
Instead of waiting for swagger-cli to update its dependency (swagger-parser using openapi-schema-validation v0.4.2 instead of v3.0.3) I’ve elected to use openapi-schema-validation v3.0.3 directly. I am open to other suggestions.
Summary of major changes in v3:
swagger: 2.0
has been replaced withopenapi: 3.0.1
definitions
was renamed toschemas
andsecurityDefinitions
tosecuritySchemes
and they all were moved inside componentsservers
replaces thebasePath
keywords used in OpenAPI 2.01. ISSUE/ Additional work: Service checker expects a basePath. It needs to be updated to also look for servers[0].url2. https://github.com/wikimedia/operations-software-service-checker/blob/master/servicechecker/swagger.py#L109
produces
replaced withcontent
inresponse
. Must include media type & schema.consumes
has been replaced withrequestBody
type
inparameters
to show up underschema
Unclear/ Need help:I’m not fully sure how redirect works in the codebase. For example, with
html/{title}
&&html/{title}/{revision}
we have it accepting a boolean (in spec) but some of the tests are providing the valueno
to the query. I’ve gone through some of the code in sys/ but I am having a hard time tracking it down.