wagtail_graphql.inventory package¶

Submodules¶

class wagtail_graphql.inventory.base.BaseModelInventory¶

Bases: object

Base class for an inventory of Django models.

create_model_graphql_type(model, fields)¶: Create a GraphQL object type for a model and fields specified.

get_model_fields_for(model)¶: Find all GraphQL field definitions set on the registered models.

resolve_graphql_types()¶: Convert models and field definitions into GraphQL types.

resolve_model_fields_for(model)¶: Discover GraphQL fields definition for a particular model.

resolve_models()¶: Discover the models that need registering with the inventory.

class wagtail_graphql.inventory.models.ModelInventory¶

Inventory of models that are not pages nor snippets.

create_model_graphql_type(model, fields)¶: Create a GraphQL object type for a model and fields specified.

resolve_models()¶: Resolve registered Django models omitting pages and snippets. The models need to subclass wagtail_graphql.models.GraphQLEnabledModel.

class wagtail_graphql.inventory.pages.PageInventory¶

Store metadata about Wagtail page models exposed to GraphQL.

create_model_graphql_type(model, fields)¶: Create a GraphQL type for the specified page model.

resolve_models()¶: Find all Wagtail page models eligible to be in the GraphQL endpoint. They need to subclass wagtail_graphql.models.GraphQLEnabledModel.

class wagtail_graphql.inventory.snippets.SnippetInventory¶

Inventory of snippet models.

create_model_graphql_type(model, fields)¶: Create a GraphQL object type for a model and fields specified.

resolve_models()¶: Discover the models that need registering with the inventory.

class wagtail_graphql.inventory.Inventory¶

Bases: object

Store metadata about objects exposed to the GraphQL endpoints.