Skip to content

feat: add tsoa for API type control and documentation #1501

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

Open
Andreybest wants to merge 4 commits into
base: main
Choose a base branch
from
Open

feat: add tsoa for API type control and documentation #1501

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
474500d
feat: add tsoa for API type control and documentation
Andreybest Apr 10, 2026
19cb00c
fix: fix review comments
Andreybest Apr 22, 2026
538deb1
Merge branch 'main' into 1430-api-checking-docs
Andreybest Apr 22, 2026
9520a31
fix: regenerate package-lock.json
Andreybest Apr 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,3 +276,6 @@ website/.docusaurus

# Generated from testing
/test/fixtures/test-package/package-lock.json

# tsoa generated files (regenerated by `npm run build-tsoa`)
src/service/generatedRoutes.ts
2 changes: 1 addition & 1 deletion docs/Architecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -432,7 +432,7 @@ Allows defining ways to authenticate to the API. This is useful for securing cus

If `apiAuthentication` is left empty, API endpoints will be publicly accesible.

Currently, only JWT auth is supported. This is implemented via the [`jwtAuthHandler` middleware](/src/service/passport/jwtAuthHandler.ts). Aside of validating incoming access tokens, it can also assign roles based on the token payload.
Currently, only JWT auth is supported. This is implemented via the [`@Security('jwt')` decorator](/src/service/authentication.ts). Aside of validating incoming access tokens, it can also assign roles based on the token payload.

##### Setting up JWT Authentication

Expand Down
Loading
Loading