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

Provide Customizers for Path, PathItem, Schemas, (and all OAS components) #2029

Closed
BillyBolton opened this issue Jan 2, 2023 · 1 comment
Labels
question Further information is requested

Comments

@BillyBolton
Copy link

BillyBolton commented Jan 2, 2023

Is your feature request related to a problem? Please describe.

  • A clear and concise description of what the problem is. Ex. I'm always frustrated

Dynamically exposing APIs using an Operation's extensions, as recommended here can be an expensive process since traversing the OAS tree to fetch an Operatoin's parent Path/PathItems can only be done top-down. Customizers that springdoc provides, such as the OperationCustomizer is a useful way to directly access the Operation components directly prior to the OAS is being generated. Customizers are not supported for every OAS component, however, resulting in expensive processing to hide associated Path, PathItem, Operations, and Schemas as defined by the singular Operation extension.

  • What is the actual result using OpenAPI Description (yml or json)?

Should support both yaml and json but no result is needed to describe the output besides being valid.

Describe the solution you'd like

  • A clear and concise description of what you want to happen.

Customizers should be provided for all OAS components, especially for Path, PathItem, and Schema components.

Describe alternatives you've considered

  • A clear and concise description of any alternative solutions or features you've
    considered.

I've implemented a solution, that unfortunately I cannot share, by iterating through the entire OAS tree. This process is expensive though and I am looking for a way that is more efficient and consistent with what Springdoc already provides support for.

Additional context

  • Add any other context or screenshots about the feature request here.

N/A

@bnasslahsen
Copy link
Contributor

@BillyBolton,

The existing Customizers are fairly enough.
If you feel you have an added value to propose, feel free to propose a PR.

@bnasslahsen bnasslahsen added the question Further information is requested label Feb 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants