chore: Adjust JSON schema #206
Conversation
WalkthroughThe changes to the Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- schema.json (4 hunks)
🔇 Additional comments (4)
schema.json (4)
205-210: LGTM: Static section header changes are consistent.The changes to the static section's request and response headers are consistent with the main headers section and use the same Headers definition appropriately.
226-227: LGTM: HTTP3 property addition is well-structured.The HTTP3 property is correctly added and follows the same pattern as the existing HTTP2 property.
495-504: LGTM: Headers definition is well-designed.The new Headers definition is a good improvement over HashmapString:
- Enforces minimum of one property
- Validates header names against HTTP conventions
- Ensures non-empty string values
145-146:⚠️ Potential issueFix typo in headers description and verify reference change.
- There's a typo in both descriptions: "Customer" should be "Custom"
- The change from
HashmapStringtoHeadersreference looks good, as it adds additional validation for header names.Let's verify no other parts of the schema still reference HashmapString:
Also applies to: 149-150
Add documentation for HTTP3 experimental
|
@rustatian Should be good now. |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
schema.json (1)
503-512: Consider adding examples to Headers definition.The Headers definition is well-structured with appropriate validations. Consider adding examples to demonstrate valid header names and values, similar to other definitions in the schema.
"Headers": { "type": "object", "minProperties": 1, "patternProperties": { "^[a-zA-Z0-9._-]+$": { "type": "string", "minLength": 1 + "examples": [ + "X-Custom-Header" + ] } }, "additionalProperties": false, + "examples": { + "X-Custom-Header": "value", + "X-Request-ID": "correlation-id" + } }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- schema.json (4 hunks)
🔇 Additional comments (3)
schema.json (3)
145-146: LGTM! Headers definition updates improve clarity and consistency.The changes consistently update all header properties to use the new
Headersdefinition and provide clearer descriptions specifying "Custom HTTP headers".Also applies to: 149-150, 205-210
226-227: LGTM! HTTP3 property correctly added.The HTTP3 configuration is properly integrated alongside existing HTTP2 configuration.
470-502: Consider clarifying the experimental status impact.The HTTP3 definition is well-structured with proper validations. Consider enhancing the experimental warning to clarify what happens if experimental features are not enabled (e.g., will it be ignored, cause an error, etc?).
Add documentation for HTTP3 experimental
Reason for This PR
Followup to consolidated schemas. Also the HTTP3 section was missing.
Description of Changes
Adjusted schema; dereferenced
HashmapStringfrom main repoAdded HTTP 3 schema (with experimental warning)
License Acceptance
By submitting this pull request, I confirm that my contribution is made under
the terms of the MIT license.
PR Checklist
[Author TODO: Meet these criteria.][Reviewer TODO: Verify that these criteria are met. Request changes if not]git commit -s).CHANGELOG.md.Summary by CodeRabbit
New Features
Headersdefinition to improve header management.Improvements
trusted_subnetswith default values for common private networks.max_request_sizeandinternal_error_codeproperties.