fix: improve schema descriptions (Group 5)#3471
Merged
souvikghosh04 merged 4 commits intomainfrom Apr 29, 2026
Merged
Conversation
…d depth-limit (Group 5) Fixes #3365 #3368 #3369 #3370 #3371 - #3365: data-source.health.enabled - replaced placeholder text - #3368: permissions[].role - added missing description (3 locations) - #3369: permissions[].actions - added missing description (3 locations) - #3370: data-source.options - clarified vague description (2 locations) - #3371: runtime.graphql.depth-limit - documented null and -1 semantics
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves the metadata quality of DAB’s JSON Schema (schemas/dab.draft.schema.json) so VS Code IntelliSense and other schema-driven tooling show accurate, non-placeholder descriptions for common configuration properties.
Changes:
- Clarifies
data-source.optionsdescription to better reflect database-specific configuration. - Fixes placeholder/misleading descriptions for
data-source.health.enabledandruntime.graphql.depth-limit. - Adds missing descriptions for
permissions[].roleandpermissions[].actionsacross the repeated schema locations.
Comments suppressed due to low confidence (3)
schemas/dab.draft.schema.json:1351
- The wildcard branch uses
pattern: "[*]", which matches any string containing*(e.g., "abc*") rather than only the literal "" described here. To align schema validation with the description/intended values, consider switching to an anchored regex (e.g.,^\\*$) or an explicit enum of "".
"description": "The operations permitted for this role. Use \"*\" to allow all, or specify an array of actions.",
"oneOf": [
{
"type": "string",
"pattern": "[*]"
},
schemas/dab.draft.schema.json:1427
- The wildcard branch uses
pattern: "[*]", which matches any string containing*(e.g., "abc*") rather than only the literal "" described here. To align schema validation with the description/intended values, consider switching to an anchored regex (e.g.,^\\*$) or an explicit enum of "".
"description": "The operations permitted for this role. Use \"*\" to allow all, or specify an array of actions.",
"oneOf": [
{
"type": "string",
"pattern": "[*]"
},
schemas/dab.draft.schema.json:956
- The wildcard branch uses
pattern: "[*]", which matches any string containing*(e.g., "abc*") rather than only the literal "" described here. To align schema validation with the description/intended values, consider switching to an anchored regex (e.g.,^\\*$) or an explicit enum of "".
"description": "The operations permitted for this role. Use \"*\" to allow all, or specify an array of actions.",
"oneOf": [
{
"type": "string",
"pattern": "[*]"
},
Aniruddh25
approved these changes
Apr 28, 2026
Co-authored-by: Copilot <copilot@github.com>
Aniruddh25
approved these changes
Apr 28, 2026
RubenCerna2079
approved these changes
Apr 29, 2026
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
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.
Why make this change?
Closes #3470
Fixes #3365, #3368, #3369, #3370, #3371
Schema descriptions were missing, placeholder, or misleading — affecting VS Code IntelliSense and tooling that reads JSON Schema metadata.
What is this change?
Updates \schemas/dab.draft.schema.json\ descriptions:
How was this tested?
Schema-only metadata change — no runtime behavior affected. JSON validated.