docs: enforce all spec-compliant OpenAPI/redocly rules #1723
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This updates the redocly rules per Redocly/redocly-cli-cookbook#12 to enforce all error-level rules in the `spec-compliant` ruleset. Closes getodk/central#1226, as this should enforce a higher standard than the `minimal` ruleset.
alxndrsn
changed the title
alxndrsn
pushed a commit
to alxndrsn/odk-central-backend
that referenced
this pull request
Dec 20, 2025
Add missing rules from the `spec-compliant` ruleset at `warn` level for recommended rules. See: https://github.com/Redocly/redocly-cli-cookbook/tree/main/rulesets/spec-compliant Follow up to getodk#1723
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This updates the redocly rules per Redocly/redocly-cli-cookbook#12 to enforce all error-level (required) rules in the
spec-compliantruleset.See: https://github.com/Redocly/redocly-cli-cookbook/tree/main/rulesets/spec-compliant
Closes getodk/central#1226, as this should enforce a higher standard than the
minimalruleset.What has been done to verify that this works as intended?
make api-docs-lintlocallyWhy is this the best possible solution? Were any other approaches considered?
Turns on some more rules, without requiring any changes to docs yaml.
How does this change affect users? Describe intentional changes to behavior and behavior that could have accidentally been affected by code changes. In other words, what are the regression risks?
Should help prevent regressions for people using the docs for OpenAPI-based integrations.
Does this change require updates to the API documentation? If so, please update docs/api.yaml as part of this PR.
Surprisingly no.
Before submitting this PR, please make sure you have:
make testand confirmed all checks still pass OR confirm CircleCI build passes