Confluence · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluence Cloud REST Template API

7 actions 7 updates phrasing extends openapi/confluence-template-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Confluence's API. It is a proposal applied on top of the contract, not a document Confluence publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info

$.paths['/wiki/rest/api/template'].put

$.paths['/wiki/rest/api/template'].post

$.paths['/wiki/rest/api/template/blueprint'].get

$.paths['/wiki/rest/api/template/page'].get

$.paths['/wiki/rest/api/template/{contentTemplateId}'].get

$.paths['/wiki/rest/api/template/{contentTemplateId}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Confluence Cloud REST Template API
  version: 1.0.0
extends: openapi/confluence-template-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/wiki/rest/api/template'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a content template
      effect: write
      questions:
      - How do I edit an existing page template's body or name?
      - Can blueprint templates be modified through the API?
      instructions:
      - text: Update template {templateId} with name {name}, type {templateType} and body {body}.
        slots:
          templateId: requestBody.templateId
          name: requestBody.name
          templateType: requestBody.templateType
          body: requestBody.body
      - text: Change the description of template {templateId} to {description}.
        slots:
          templateId: requestBody.templateId
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/template'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a content template
      effect: write
      questions:
      - How do I add a new page template to a space?
      - Can I create a global template rather than a space-specific one?
      instructions:
      - text: Create a {templateType} template named {name} with body {body}.
        slots:
          templateType: requestBody.templateType
          name: requestBody.name
          body: requestBody.body
      - text: Create template {name} of type {templateType} in space {space} using body {body}.
        slots:
          name: requestBody.name
          templateType: requestBody.templateType
          space: requestBody.space
          body: requestBody.body
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/template/blueprint'].get
  update:
    x-apievangelist-phrasing:
      intent: List blueprint templates
      effect: read
      questions:
      - Which blueprint templates are available in a space?
      - Are global blueprints inherited by every space?
      instructions:
      - text: List all global blueprint templates.
      - text: List the blueprint templates available in space {spaceKey}.
        slots:
          spaceKey: query.spaceKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/template/page'].get
  update:
    x-apievangelist-phrasing:
      intent: List content templates
      effect: read
      questions:
      - What user-created page templates exist on the site?
      - Can I see only the content templates defined in one space?
      instructions:
      - text: List all global content templates.
      - text: List the content templates in space {spaceKey}.
        slots:
          spaceKey: query.spaceKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/template/{contentTemplateId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a content template
      effect: read
      questions:
      - What is in the body of a specific template?
      - Can I see which space or blueprint a template belongs to?
      instructions:
      - text: Show template {contentTemplateId}.
        slots:
          contentTemplateId: path.contentTemplateId
      - text: Get the body and details of template {contentTemplateId}.
        slots:
          contentTemplateId: path.contentTemplateId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/template/{contentTemplateId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete or reset a template
      effect: destructive
      questions:
      - What happens when I remove a modified blueprint template?
      - How do I delete a content template I created?
      instructions:
      - text: Remove template {contentTemplateId}.
        slots:
          contentTemplateId: path.contentTemplateId
      - text: Delete content template {contentTemplateId} from its space.
        slots:
          contentTemplateId: path.contentTemplateId
      method: generated
      generated: '2026-10-01'