Skip to content

docs: Document JSON Schema format keyword validation#2041

Draft
promptless-for-oss wants to merge 1 commit intohelm:mainfrom
Promptless:promptless/document-json-schema-format-validation
Draft

docs: Document JSON Schema format keyword validation#2041
promptless-for-oss wants to merge 1 commit intohelm:mainfrom
Promptless:promptless/document-json-schema-format-validation

Conversation

@promptless-for-oss
Copy link
Copy Markdown
Contributor

Open this suggestion in Promptless to view citations and reasoning process

Documents that values.schema.json supports the JSON Schema format keyword for validating string formats like ipv4, ipv6, email, uri, hostname, and date-time. Adds an example showing how to use format validation in the Schema Files section.

Trigger Events

helm/helm PR #31937: fix(chartutil): enable format assertions in JSON schema validation

Promptless Research (5 files, 1 webpage, 1 GitHub PR)

  • Reviewed helm/helm#31937
  • Viewed .long_term_context/product_knowledge/product_overview.md
  • Viewed .long_term_context/doc_workflow/client_instructions.md
  • Viewed .long_term_context/style/client_style_guide.md
  • Read webpage from github.com
  • Viewed docs/topics/charts.mdx
  • Viewed docs/helm/helm_lint.md

Agent Response

I've reviewed PR #31937 and created a documentation suggestion.

Summary

PR #31937 fixes a bug where helm lint and other schema validation commands were not enforcing JSON Schema format keywords (like ipv4, ipv6, email, uri, etc.) in values.schema.json files. This was a behavioral change that users should be aware of.

Documentation Update

I added a new section to the Schema Files documentation in docs/topics/charts.mdx that:

  1. Explains that JSON Schema format keywords are supported for validating string formats
  2. Provides an example showing how to use format: "ipv4" and format: "email" in a schema
  3. Lists common format keywords: ipv4, ipv6, email, uri, hostname, and date-time

Suggestion created: Document JSON Schema format keyword validation

The existing documentation covered type validation, minimum/maximum constraints, and required fields, but did not mention format keywords at all. This update fills that gap and documents the feature that PR #31937 ensures is now properly working.


Tip: Tag @Promptless in GitHub PR comments to guide documentation changes during code review 🐙

Signed-off-by: promptless-for-oss <promptless-for-oss@users.noreply.github.com>
Comment thread docs/topics/charts.mdx
}
```

JSON Schema supports the `format` keyword for validating string formats like
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: PR #31937 fixes a bug where format assertions were not being enforced during JSON Schema validation. The fix enables compiler.AssertFormat() in pkg/chart/common/util/jsonschema.go, ensuring format keywords like ipv4, ipv6, and email are validated. This documentation explains the feature that is now properly working.
View source

@TerryHowe TerryHowe added awaiting release Feature needs to be merged and released before docs update hold Do not merge yet labels Mar 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting release Feature needs to be merged and released before docs update hold Do not merge yet size/S

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants