Skip to content

[api docs] increase schema validation strictness and start to fix issues #1633

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
jbylina wants to merge 7 commits into
base: master
Choose a base branch
from
Open

[api docs] increase schema validation strictness and start to fix issues #1633

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c480f45
Increase redocly strictness, and ignore existing issues
jbylina Oct 20, 2025
b1c01d8
docs: make http status codes strings to comply with: https://spec.ope…
jbylina Oct 20, 2025
757e7c4
docs: document Individual Form tag and add license info to API spec
jbylina Oct 20, 2025
454277d
ignore entire rules, instead of ignoring individual errors in file
jbylina Oct 23, 2025
383ca9b
Move license above description
jbylina Oct 23, 2025
1dec835
sort skipped rules
jbylina Oct 23, 2025
8f11bcf
make extends first in args list
jbylina Oct 23, 2025
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
14 changes: 13 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,4 +167,16 @@ api-docs:

.PHONY: api-docs-lint
api-docs-lint:
npx --no @redocly/cli lint --extends=minimal docs/api.yaml
npx --no @redocly/cli lint \
--extends recommended \
--skip-rule no-ambiguous-paths \
--skip-rule no-invalid-media-type-examples \
--skip-rule no-unused-components \
--skip-rule operation-2xx-response \
--skip-rule operation-4xx-response \
--skip-rule operation-operationId \
--skip-rule operation-operationId-url-safe \
--skip-rule path-not-include-query \
--skip-rule path-parameters-defined \
--skip-rule security-defined \
docs/api.yaml
Loading