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

migrate from springfox-swagger to springdoc-openapi #1027

Closed
Tracked by #1025
TheGreatRefrigerator opened this issue Jul 29, 2021 · 4 comments · Fixed by #1380
Closed
Tracked by #1025

migrate from springfox-swagger to springdoc-openapi #1027

TheGreatRefrigerator opened this issue Jul 29, 2021 · 4 comments · Fixed by #1380

Comments

@TheGreatRefrigerator
Copy link
Contributor

TheGreatRefrigerator commented Jul 29, 2021

Currenlty swagger 2 is still used as API specs.
OpenAPI specs have been out for some time an are the go to standard nowadays.

It might be possible to integrate the custom keys used to define parameter dependencies in a more openapi spec native way (to be investigated).

Should be tackled together with ors-website's capability to render openapi.

@MichaelsJP
Copy link
Member

This would be great. Could also give us additional abilities in the direction of auto-generated API clients: https://github.com/OpenAPITools/openapi-generator.

@TheGreatRefrigerator
Copy link
Contributor Author

TheGreatRefrigerator commented Apr 5, 2023

  • parameter dependencies, possible native now?
  • extra/custom parameter attributes x-valid-when etc. possible?
  • use 3.1 features? summary attribute & new json schema multi type lists

@MichaelsJP
Copy link
Member

MichaelsJP commented Apr 17, 2023

parameter dependencies, possible native now?

Regarding that one, is this what we're looking for?
https://json-schema.org/understanding-json-schema/reference/conditionals.html

It's also listed here. Just search for dependentSchemas and dependentRequired

@MichaelsJP
Copy link
Member

I'ts not visible that springdoc-openapi will integrate these parameters. For the short-term we should use x- to add dependencies. For the medium, longterm, we can think of a class overwrite that adds the functionality, as e.g., the openapi-generator supports at least the dependentRequired tag for the client generation.

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

Successfully merging a pull request may close this issue.

3 participants