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): fixed missing schema key #414

Merged
merged 1 commit into from
Sep 26, 2020
Merged

Conversation

syncush
Copy link
Collaborator

@syncush syncush commented Sep 25, 2020

Question Answer
Bug fix
New feature
Breaking change
Deprecations
Documentation
Tests added

Further information:
A schema key was missing

Copy link
Collaborator

@enudler enudler left a comment

Choose a reason for hiding this comment

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

hi
can you please update:

docs/devguide/docs/swagger-docs.yaml

this is the spec that is published as redoc in our docs

@syncush
Copy link
Collaborator Author

syncush commented Sep 25, 2020

@enudler then if we have 2 docs -> it means we must make it into a one place

@enudler
Copy link
Collaborator

enudler commented Sep 25, 2020

@syncush i wish.. put the problem that our swagger validator and the redoc needs slight changes from each other :|

@syncush
Copy link
Collaborator Author

syncush commented Sep 25, 2020

Can you please provide an example of a needed change, there must be a way

@enudler
Copy link
Collaborator

enudler commented Sep 25, 2020

it was quite a long ago when we decided on it
but as far as I remember redoc didn't support discriminators

to test this you can do:

cd docs/devguide mkdocs serve
and go to

http://localhost:8000/indexapiref.html#operation/create-a-test

you will see that it doesn't list the request body very well..

@enudler
Copy link
Collaborator

enudler commented Sep 25, 2020

btw it can be also the opposite, that redoc does it well and we used slightly changed swagger to support validators

@syncush
Copy link
Collaborator Author

syncush commented Sep 25, 2020

@enudler I added a validator test for the openapi3 spec

@enudler enudler merged commit f39d7f8 into master Sep 26, 2020
@enudler enudler deleted the fix-openapi-missing-key branch September 26, 2020 17:13
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.

None yet

2 participants