Skip to content

fix: improve schema descriptions (Group 5)#3471

Merged
souvikghosh04 merged 4 commits intomainfrom
Usr/sogh/grp5-descriptions
Apr 29, 2026
Merged

fix: improve schema descriptions (Group 5)#3471
souvikghosh04 merged 4 commits intomainfrom
Usr/sogh/grp5-descriptions

Conversation

@souvikghosh04
Copy link
Copy Markdown
Contributor

@souvikghosh04 souvikghosh04 commented Apr 27, 2026

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:

Issue Property Fix
#3365 \data-source.health.enabled\ Updated description
#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 \
untime.graphql.depth-limit\ Documented null (no limit) and -1 (CLI remove limit) semantics

How was this tested?

Schema-only metadata change — no runtime behavior affected. JSON validated.

…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
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.options description to better reflect database-specific configuration.
  • Fixes placeholder/misleading descriptions for data-source.health.enabled and runtime.graphql.depth-limit.
  • Adds missing descriptions for permissions[].role and permissions[].actions across 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": "[*]"
                      },

Comment thread schemas/dab.draft.schema.json Outdated
Comment thread schemas/dab.draft.schema.json Outdated
Comment thread schemas/dab.draft.schema.json Outdated
Co-authored-by: Copilot <copilot@github.com>
@souvikghosh04 souvikghosh04 moved this from In Progress to Review In Progress in Data API builder Apr 28, 2026
@souvikghosh04 souvikghosh04 enabled auto-merge (squash) April 28, 2026 13:51
@souvikghosh04 souvikghosh04 merged commit acd6bf7 into main Apr 29, 2026
12 checks passed
@souvikghosh04 souvikghosh04 deleted the Usr/sogh/grp5-descriptions branch April 29, 2026 16:21
@github-project-automation github-project-automation Bot moved this from Review In Progress to Done in Data API builder Apr 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working cli config changes related to config

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Missing/Invalid Description (Group 5) [Bug]: messy schema reference data-source.health.enabled

4 participants