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.

Sign up for GitHub

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

Jump to bottom

Enhancement: Add include_in_schema option on Routers and/or Controllers #2267

Closed
audiovention opened this issue Sep 1, 2023 · 2 comments · Fixed by #2295
Closed

Enhancement: Add include_in_schema option on Routers and/or Controllers #2267

audiovention opened this issue Sep 1, 2023 · 2 comments · Fixed by #2295
Labels
Enhancement This is a new feature or request Good First Issue This is good for newcomers to take on Help Wanted 🆘 This is good for people to work on

Comments

@audiovention
Copy link

audiovention commented Sep 1, 2023 •
edited by polar-sh bot
Loading

Summary

I'd like to exclude entire Controllers from my OpenAPI docs, with the current state I need to add include_in_schema=False on every single route handler in the controller.
It would be very convenient if I could specify this option on the Controller level (and possibly on the router level as well), and it would be propagated downwards.

Basic Example

No response

Drawbacks and Impact

No response

Unresolved questions

No response

Funding

  • If you would like to see an issue prioritized, make a pledge towards it!
  • We receive the pledge once the issue is completed & verified
Fund with Polar
@audiovention audiovention added the Enhancement This is a new feature or request label Sep 1, 2023
@Goldziher Goldziher added Help Wanted 🆘 This is good for people to work on Good First Issue This is good for newcomers to take on labels Sep 9, 2023
@Goldziher
Copy link
Contributor

This is a sensible ask IMO.

@Alc-Alc do you wanna give it a go?

@Alc-Alc
Copy link
Contributor

Alc-Alc commented Sep 10, 2023

This is a sensible ask IMO.

@Alc-Alc do you wanna give it a go?

Sure, I am working on this

@Alc-Alc Alc-Alc mentioned this issue Sep 11, 2023
Merged
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Enhancement This is a new feature or request Good First Issue This is good for newcomers to take on Help Wanted 🆘 This is good for people to work on
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(layered-include_in_schema): Add include_in_schema option for all layers litestar-org/litestar
3 participants
@Goldziher @Alc-Alc @audiovention