Skip to content

fix: improve schema descriptions (Group 5) #3471

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
souvikghosh04 wants to merge 4 commits into
base: main
Choose a base branch
from
Open

fix: improve schema descriptions (Group 5) #3471

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9089653
fix: improve schema descriptions for health, permissions, options, an…
souvikghosh04 Apr 27, 2026
1e26354
Merge branch 'main' into Usr/sogh/grp5-descriptions
souvikghosh04 Apr 28, 2026
a61a95f
update description and nits
souvikghosh04 Apr 28, 2026
7f0f9dd
Merge branch 'main' into Usr/sogh/grp5-descriptions
Aniruddh25 Apr 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 13 additions & 7 deletions schemas/dab.draft.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand All @@ -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
},
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -243,7 +243,7 @@
},
"depth-limit": {
"type": [ "integer", "null" ],
"description": "Maximum allowed depth of a GraphQL query.",
"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": {
Expand Down Expand Up @@ -946,9 +946,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",
Expand Down Expand Up @@ -1339,9 +1341,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",
Expand Down Expand Up @@ -1413,9 +1417,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",
Expand Down