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

Turn oas3-unused-components-schema into a more versatile rule #1073

Closed
nulltoken opened this issue Apr 8, 2020 · 3 comments
Closed

Turn oas3-unused-components-schema into a more versatile rule #1073

nulltoken opened this issue Apr 8, 2020 · 3 comments
Labels
enhancement New feature or request OpenAPI Issues related to the OpenAPI ruleset p/medium

Comments

@nulltoken
Copy link
Contributor

nulltoken commented Apr 8, 2020

User story.
OpenaApi 3.x Components section list a lot of reusable objects. But we currently only focus on schemas orphaned objects. We could do so much more!!!

Proposal:

  • Slightly tweak the function to make it accept an array of reusable objects locations and process them all as potential sources. The given property may have to be tweaked as well ($?).
  • Rename this rule into oas3-unused-components-object
  • Extend the test suites to cover those additional paths

Would this proposal be considered as a possible addition:

  • Create another issue targeting the oas2 ruleset (and another one for the soon to be released asyncapi ruleset)
@nulltoken
Copy link
Contributor Author

@philsturgeon Thoughts?

@philsturgeon
Copy link
Contributor

Yeah I think we could have:

  • oas2-unused-definition
  • oas3-unused-component
  • async-unused-component

Let's do this as a followup task when #965 is done.

@philsturgeon philsturgeon added enhancement New feature or request p/medium labels Apr 8, 2020
@P0lip P0lip added the OpenAPI Issues related to the OpenAPI ruleset label Sep 30, 2020
@P0lip
Copy link
Contributor

P0lip commented Feb 26, 2021

I think we can consider this closed thanks to #1440

@P0lip P0lip closed this as completed Feb 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request OpenAPI Issues related to the OpenAPI ruleset p/medium
Projects
None yet
Development

No branches or pull requests

3 participants