Skip to content

Add description support for schema documentation - #39

Closed
rnsmith wants to merge 13 commits into
mwilliamson:masterfrom
healx:add-schema-descriptions
Closed

rnsmith wants to merge 13 commits into
mwilliamson:masterfrom
healx:add-schema-descriptions

Conversation

@rnsmith

@rnsmith rnsmith commented Sep 22, 2026

Copy link
Copy Markdown

Summary

  • Adds an optional description= kwarg to ObjectType, InterfaceType, InputObjectType, field(), param(), and input_field()
  • Propagates those descriptions into the generated GraphQLObjectType / GraphQLInterfaceType / GraphQLInputObjectType / GraphQLField / GraphQLArgument / GraphQLInputField in create_graphql_schema, so they surface in introspection and GraphiQL
  • Bumps version to 0.5.0

Needed by the knowledge-base app, which wants to start documenting its GraphQL schema (starting with the top-level diseases query) but currently has nowhere to attach a description — graphlayer drops it silently today.

Test plan

  • pytest tests/ — 276 passed (270 existing + 6 new covering description propagation for object/interface/input-object types, fields, params, and input fields)

alexhermida and others added 13 commits February 11, 2025 16:18
Update graphql-core requirement
Upgrade&fix Graphiql and sqlalchemy examples
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Add offset() method to _SqlQuery for skip-based pagination. The offset
is preserved through query chaining (where, order_by, limit, group_by,
index_by) and works with joins.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
[DT-2731] Enables pagination support
Bump version from 0.3.0 to 0.4.0
…, fields, params and input fields

Threads an optional description= kwarg through the graph-side schema
builders (ObjectType, InterfaceType, InputObjectType, field, param,
input_field) and propagates it into the generated GraphQLObjectType /
GraphQLInterfaceType / GraphQLInputObjectType / GraphQLField /
GraphQLArgument / GraphQLInputField, so descriptions show up in
introspection and GraphiQL.

Bump version to 0.5.0.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@rnsmith

rnsmith commented Sep 22, 2026

Copy link
Copy Markdown
Author

Opened against the wrong repo by mistake (meant to target our internal fork, not upstream) — closing.

@rnsmith rnsmith closed this Sep 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants