← Back to schema index

PlaygroundTemplatesResponse

JSON:API envelope wrapping the categories and templates available for the playground, filtered by the calling user's permissions.

Properties

FieldTypeDescription
data*objectResponse body. Everything hangs off here, per the JSON:API envelope.
type*stringResource type, fixed for this operation. Part of the resource identity in the JSON:API envelope. Always `playground_templates`.
attributes*objectThe resource's own data, kept apart from its identity.
categories*arrayCategories ordered according to the sidebar-order.json manifest (W2): first those in `groups.reference`, then `groups.admin`, then the rest alphabetically. Without manifest: non-admin first (preserving YAML order), then `Admin: *`.
total*integerTotal count of templates the caller is allowed to see (sum of `templates.length` across all `categories`).

Used in operations

  • GET /v1/playground/templates