From 90896531dd47ed9c34143538230fd4a04af7abec Mon Sep 17 00:00:00 2001 From: souvikghosh04 Date: Mon, 27 Apr 2026 19:55:26 +0530 Subject: [PATCH 1/2] fix: improve schema descriptions for health, permissions, options, and 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 --- schemas/dab.draft.schema.json | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/schemas/dab.draft.schema.json b/schemas/dab.draft.schema.json index f8a06fe61c..320cb3941f 100644 --- a/schemas/dab.draft.schema.json +++ b/schemas/dab.draft.schema.json @@ -32,7 +32,7 @@ "type": "string" }, "options": { - "description": "Database specific properties for the backend database", + "description": "Database-specific connection and configuration properties. Available options depend on the database-type.", "type": "object" }, "health": { @@ -42,7 +42,7 @@ "properties": { "enabled": { "$ref": "#/$defs/boolean-or-string", - "description": "Enable health check endpoint for something", + "description": "Enable health check for this data source.", "default": true, "additionalProperties": false }, @@ -97,7 +97,7 @@ "then": { "properties": { "options": { - "description": "Database specific properties for the backend database", + "description": "Database-specific connection and configuration properties. Available options depend on the database-type.", "type": "object", "additionalProperties": false, "properties": { @@ -241,7 +241,7 @@ }, "depth-limit": { "type": [ "integer", "null" ], - "description": "Maximum allowed depth of a GraphQL query.", + "description": "Maximum allowed depth of a GraphQL query. Default: null (no limit). Use -1 via CLI to remove a previously set limit.", "default": null }, "multiple-mutations": { @@ -944,9 +944,11 @@ "additionalProperties": false, "properties": { "role": { - "type": "string" + "type": "string", + "description": "The role to which this permission applies (e.g. anonymous, authenticated, or a custom role)." }, "actions": { + "description": "The operations permitted for this role. Use \"*\" to allow all, or specify an array of actions.", "oneOf": [ { "type": "string", @@ -1337,9 +1339,11 @@ "additionalProperties": false, "properties": { "role": { - "type": "string" + "type": "string", + "description": "The role to which this permission applies (e.g. anonymous, authenticated, or a custom role)." }, "actions": { + "description": "The operations permitted for this role. Use \"*\" to allow all, or specify an array of actions.", "oneOf": [ { "type": "string", @@ -1411,9 +1415,11 @@ "additionalProperties": false, "properties": { "role": { - "type": "string" + "type": "string", + "description": "The role to which this permission applies (e.g. anonymous, authenticated, or a custom role)." }, "actions": { + "description": "The operations permitted for this role. Use \"*\" to allow all, or specify an array of actions.", "oneOf": [ { "type": "string", From a61a95f9aba98f4731d7e7f122fc3ecd30707d3f Mon Sep 17 00:00:00 2001 From: souvikghosh04 Date: Tue, 28 Apr 2026 18:33:05 +0530 Subject: [PATCH 2/2] update description and nits Co-authored-by: Copilot --- schemas/dab.draft.schema.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/schemas/dab.draft.schema.json b/schemas/dab.draft.schema.json index ce83d69606..54fc524fd4 100644 --- a/schemas/dab.draft.schema.json +++ b/schemas/dab.draft.schema.json @@ -243,7 +243,7 @@ }, "depth-limit": { "type": [ "integer", "null" ], - "description": "Maximum allowed depth of a GraphQL query. Default: null (no limit). Use -1 via CLI to remove a previously set limit.", + "description": "Maximum allowed depth of a GraphQL query. Only positive integers are enforced. Default: null (no limit). Use -1 to explicitly remove a previously set limit.", "default": null }, "multiple-mutations": { @@ -950,7 +950,7 @@ "description": "The role to which this permission applies (e.g. anonymous, authenticated, or a custom role)." }, "actions": { - "description": "The operations permitted for this role. Use \"*\" to allow all, or specify an array of actions.", + "description": "The operations permitted for this role. Use '*' to allow all, or specify an array of actions.", "oneOf": [ { "type": "string", @@ -1345,7 +1345,7 @@ "description": "The role to which this permission applies (e.g. anonymous, authenticated, or a custom role)." }, "actions": { - "description": "The operations permitted for this role. Use \"*\" to allow all, or specify an array of actions.", + "description": "The operations permitted for this role. Use '*' to allow all, or specify an array of actions.", "oneOf": [ { "type": "string", @@ -1421,7 +1421,7 @@ "description": "The role to which this permission applies (e.g. anonymous, authenticated, or a custom role)." }, "actions": { - "description": "The operations permitted for this role. Use \"*\" to allow all, or specify an array of actions.", + "description": "The operations permitted for this role. Use '*' to allow all, or specify an array of actions.", "oneOf": [ { "type": "string",