Skip to content

Schema description#1834

Merged
spawnia merged 3 commits intowebonyx:masterfrom
kasparsklavins:patch-3
Jan 20, 2026
Merged

Schema description#1834
spawnia merged 3 commits intowebonyx:masterfrom
kasparsklavins:patch-3

Conversation

@kasparsklavins
Copy link
Copy Markdown
Contributor

@kasparsklavins kasparsklavins commented Jan 17, 2026

Schema description can be provided either using SDL:

"Schema description"
schema {
  query: Query
}

or, by providing a "description" option to \GraphQL\Type\Schema:

$schema = new \GraphQL\Type\Schema([
    'description' => 'Schema description',
    'query' => $queryType,
]);

@kasparsklavins kasparsklavins force-pushed the patch-3 branch 2 times, most recently from 6245e3c to 85650e4 Compare January 18, 2026 00:05
kasparsklavins
kasparsklavins commented Jan 18, 2026
View reviewed changes
spawnia
spawnia reviewed Jan 19, 2026
View reviewed changes
Copy link
Copy Markdown
Collaborator

@spawnia spawnia left a comment

Choose a reason for hiding this comment

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

Looks pretty clean, nice work. Happy to include this with a tiny bit of polish.

@spawnia spawnia merged commit 4843748 into webonyx:master Jan 20, 2026
20 checks passed
@spawnia
Copy link
Copy Markdown
Collaborator

spawnia commented Jan 20, 2026

Thank you, released with https://github.com/webonyx/graphql-php/releases/tag/v15.30.0

@kasparsklavins
Copy link
Copy Markdown
Contributor Author

kasparsklavins commented Jan 20, 2026

Afaik, with this graphql-php should be fully compliant with October 2021 specification. Or is anything still missing?

@spawnia
Copy link
Copy Markdown
Collaborator

spawnia commented Jan 20, 2026

@kasparsklavins Support for the @specifiedBy directive is still missing, see #1140.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@spawnia spawnia spawnia approved these changes

Assignees

No one assigned

Labels

enhancement

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add support for adding description to schema

2 participants

@kasparsklavins @spawnia