Skip to content

docs: update Spectral link #86

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

Merged
WoH merged 2 commits into from
Jun 17, 2024
Merged

docs: update Spectral link #86

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
92c4741
docs: update examples.md
iPagar Jun 14, 2024
99ae24c
docs: update descriptions.md
iPagar Jun 14, 2024
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
2 changes: 1 addition & 1 deletion docs/descriptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ In order stay true to our efforts to avoid code duplication, tsoa uses JSDoc bas
tsoa does not check if you provide descriptions.

We recommend using a linter
(we love [Spectral](https://stoplight.io/p/docs/gh/stoplightio/spectral)) to ensure your specifications aren't just correct,
(we love [Spectral](https://stoplight.io/open-source/spectral)) to ensure your specifications aren't just correct,
but also contain descriptions and correct [examples](./examples).
:::

Expand Down
2 changes: 1 addition & 1 deletion docs/examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Incorrect examples will not break your compilation, because OpenAPI [explicitly
You may also just want to demonstrate tsoa's validation :smirk:

We recommend using a linter
(we love [Spectral](https://stoplight.io/p/docs/gh/stoplightio/spectral)) to ensure your specifications aren't just correct,
(we love [Spectral](https://stoplight.io/open-source/spectral)) to ensure your specifications aren't just correct,
but also contain [descriptions](./descriptions) and correct examples.
:::

Expand Down