docs: make redocly config explicit#1650
Merged
alxndrsn merged 6 commits intogetodk:masterfrom Oct 31, 2025
Merged
Conversation
added 3 commits
October 25, 2025 10:27
Per discussion on getodk#1633, it looks like redocly config needs to be more explicit. This PR extract the current `minimal` redocly config from source (https://github.com/Redocly/redocly-cli/blob/2367722a9fb173e55626dccbdac7b6694dd8b199/packages/core/src/config/minimal.ts#L52-L112) into a config file. This should simplify tracking of future changes to this config. Similarity to existing config can be confirmed with: ```sh $ diff <(npx --no @redocly/cli lint --extends=minimal docs/api.yaml 2>&1) <(npx --no @redocly/cli lint --config docs/redocly.conf.yaml docs/api.yaml 2>&1) 1,2d0 < No configurations were provided -- using built in recommended configuration by default. < 1447c1445 < docs/api.yaml: validated in 451ms --- > docs/api.yaml: validated in 415ms ```
2 tasks
sadiqkhoja
approved these changes
Oct 31, 2025
alxndrsn
pushed a commit
to alxndrsn/odk-central-backend
that referenced
this pull request
Nov 19, 2025
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Per discussion on #1633, it looks like redocly config will need to be updated for better compatibility in the future.
This PR extract the current
minimalredocly config from source (https://github.com/Redocly/redocly-cli/blob/2367722a9fb173e55626dccbdac7b6694dd8b199/packages/core/src/config/minimal.ts#L52-L112) into a config file.This should simplify tracking of future changes to this config.
Similarity to existing config can be confirmed with:
What has been done to verify that this works as intended?
Why is this the best possible solution? Were any other approaches considered?
There isn't an alternative.
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 improve future support for parsing
docs/api.yamlfor users' OpenAPI clients.Does this change require updates to the API documentation? If so, please update docs/api.yaml as part of this PR.
No.
Before submitting this PR, please make sure you have:
make testand confirmed all checks still pass OR confirm CircleCI build passes