Skip to content

Exempt custom_-prefixed YAML fields from strict validation - #9795

Open
avaitla wants to merge 2 commits into
rilldata:mainfrom
avaitla:avaitla/custom-yaml-fields
Open

Exempt custom_-prefixed YAML fields from strict validation#9795
avaitla wants to merge 2 commits into
rilldata:mainfrom
avaitla:avaitla/custom-yaml-fields

Conversation

@avaitla

@avaitla avaitla commented Aug 7, 2026

Copy link
Copy Markdown

Unknown fields prefixed with custom_ are reserved for user-defined metadata and no longer fail strict YAML parsing, at any nesting depth. All other unknown fields still produce a parse error.

Closes #9794

What we've tried to do here is simply silence the errors (by filtering them out) and keeping the change as simple and surgical as possible.

Checklist:

  • Covered by tests
  • Ran it and it works as intended
  • Reviewed the diff before requesting a review
  • Checked for unhandled edge cases
  • Linked the issues it closes
  • Checked if the docs need to be updated. If so, create a separate Linear DOCS issue
  • Intend to cherry-pick into the release branch
  • I'm proud of this work!

Unknown fields prefixed with `custom_` are reserved for user-defined
metadata and no longer fail strict YAML parsing, at any nesting depth.
All other unknown fields still produce a parse error.

Closes rilldata#9794
@avaitla
avaitla marked this pull request as ready for review August 7, 2026 01:35
Adds a note to the YAML Syntax overview (generated from the project
schema) explaining that unknown fields prefixed with `custom_` are
ignored by validation and can hold user-defined metadata.
@nishantmonu51 nishantmonu51 added Type:Feature New feature request Size:M Medium change: 100-499 lines labels Aug 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Size:M Medium change: 100-499 lines Type:Feature New feature request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Strict YAML validation rejects custom_-prefixed metadata fields in project files

2 participants