You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
config: commit the JSON schema and point the example at it - #1006
No actionable comments were generated in the recent review.
Walkthrough
The pull request adds a JSON Schema for relay configuration, links it from the example YAML and documentation, and adds a test that checks the committed schema against generated output.
Changes: Configuration schema
Layer / File(s)
Summary
Publish and reference the configuration schema config.schema.json, config.example.yaml, docs/config.md, changelog.d/added/config-schema-file.md
Adds a Draft 2020-12 schema for relay configuration. The example YAML and configuration documentation reference the schema. A changelog entry records the addition.
Passes the schema path to the test target. The test compares the committed schema with generated output. Developer documentation describes schema updates and regeneration.
openmoq/moqx#1004 reports optional fields listed as required in the generated schema. The committed schema has required lists that appear to address this objective, but the supplied context does not verify the generator fix.
Possibly related PRs
openmoq/moqx#1005 changes schema generation behavior that affects the committed schema in this pull request.
Merge Risk: Minimal · up to 29725
This change adds a committed JSON schema for editor support and a test that fails when the schema is stale. It does not change runtime behavior, and no merge-blocking issue was found.
Pre-merge checks: 5
Check name
Status
Explanation
Title check
The title names the two main changes: committing the JSON schema file (config.schema.json) and updating config.example.yaml to reference it. The changeset matches both parts, so the title reflects the…
Description check
The description states that editors with yaml-language-server read the modeline in config.example.yaml. This relates directly to the changeset, which adds that modeline and the schema file, so the des…
Linked Issues check
Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check
Check skipped because no linked issues were found for this pull request.
Changelog Entry
The PR adds a user-visible change and includes a matching changelog entry. The PR ships config.schema.json and adds a YAML schema modeline to config.example.yaml. Editors with YAML schema support …
Full details: Title check
Explanation
The title names the two main changes: committing the JSON schema file (config.schema.json) and updating config.example.yaml to reference it. The changeset matches both parts, so the title reflects the main change.
Full details: Description check
Explanation
The description states that editors with yaml-language-server read the modeline in config.example.yaml. This relates directly to the changeset, which adds that modeline and the schema file, so the description is on-topic.
Full details: Changelog Entry
Explanation
The PR adds a user-visible change and includes a matching changelog entry. The PR ships config.schema.json and adds a YAML schema modeline to config.example.yaml. Editors with YAML schema support can now load the schema. This is an operator-facing addition, so the changelog rule applies. The diff adds changelog.d/added/config-schema-file.md (new file, one line): - [config.schema.json](/docs/config.md#tooling), the config's JSON schema, ships in the repo; editors with YAML schema support load it by path or by its raw GitHub URL at the release tag. This follows changelog.d/README.md: - The section added is valid. - The file name config-schema-file has no dot and is unique in its section. - The file holds a single list item without a PR link. It also follows CONTRIBUTING.md#changelog. The entry describes what an operator can observe, names the config file, and links the doc section that covers the change (docs/config.md#tooling). No further entry is needed.
Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Reviewing files that changed from the base of the PR and between 04254a5 and 2972540.
Files selected for processing: 3
changelog.d/added/config-schema-file.md
config.example.yaml
docs/config.md
Files skipped from review as they are similar to previous changes: 3
changelog.d/added/config-schema-file.md
config.example.yaml
docs/config.md
Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.
Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.
- Editors with YAML schema support (yaml-language-server) read the
modeline in config.example.yaml.
- The modeline path is relative to the example file.
- At any tag or branch, it names the schema of the same commit.
- No release asset is needed.
- A config outside the repo replaces the modeline path with the raw
GitHub URL at its release tag: the first modeline wins.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Reviewed-by: Codex (gpt-6.1-sol)
Reviewed-by: Codex (gpt-6.2-sol)
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
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 change is