Configuring the plugin
Configuring the pluginAdding a description to the API

Adding a description to the API

Use the excerpt field to provide a description for the different Custom Post Type entities in this plugin:

  • Persisted Queries
  • Custom Endpoints
  • Schema Configurations
  • Access Control Lists
  • Cache Control Lists
  • Field Deprecation Lists

The description is shown in the table listing the entities for each Custom Post Type, under column Description:

Persisted queries with description
Persisted queries with description

The description is also displayed when visualizing the entity:

Persisted query source with description

Providing the description

When editing the entity, use the excerpt field to provide a description:

Excerpt as description