Add annotations to hide endpoints from OpenAPI docs

djfdyuruiry / ts-lambda-api

Build REST API's using Typescript & AWS Lambda

MIT License

54 stars 15 forks source link

Add annotations to hide endpoints from OpenAPI docs #44

Closed revbingo closed 4 years ago

revbingo commented 4 years ago

We have an API that is intended to be public but also has a few endpoints that are intended to be used internally. This change adds @apiIgnoreController and @apiIgnore annotations to allow controllers or individual endpoints to be omitted from the generated OpenAPI spec