Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian The Confluence Cloud REST Template API

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

Generated by API Evangelist Written by API Evangelist tooling for Atlassian's API. It is a proposal applied on top of the contract, not a document Atlassian 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 Atlassian The Confluence Cloud REST Template API
  version: 1.0.0
extends: openapi/atlassian-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 Confluence content template
      effect: write
      questions:
      - How do I edit the body of an existing Confluence page template?
      - Can blueprint templates be updated through the API?
      instructions:
      - text: Update template {templateId} named {name} of type {templateType} with body {body}.
        slots:
          templateId: requestBody.templateId
          name: requestBody.name
          templateType: requestBody.templateType
          body: requestBody.body
      - text: Replace the content of template {templateId} ({name}, {templateType}) with {body} and labels {labels}.
        slots:
          templateId: requestBody.templateId
          name: requestBody.name
          templateType: requestBody.templateType
          body: requestBody.body
          labels: requestBody.labels
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/template'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Confluence content template
      effect: write
      questions:
      - Can I create a reusable page template in a Confluence space?
      - What permission do I need to add a global template?
      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}.
        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 Confluence space?
      - Do spaces inherit all global blueprints?
      instructions:
      - text: List the global blueprint templates.
      - text: List blueprint templates 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 custom page templates have been created in a space?
      - Can I list all global content templates (not blueprints)?
      instructions:
      - text: List all global content templates.
      - text: List 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's in the body of a specific Confluence template?
      - Which space or blueprint does a template belong to?
      instructions:
      - text: Get content template {contentTemplateId}.
        slots:
          contentTemplateId: path.contentTemplateId
      - text: Show the body and space 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 revert a template
      effect: destructive
      questions:
      - What happens when I delete a modified blueprint template?
      - Can I remove a content template from a space?
      instructions:
      - text: Delete template {contentTemplateId}.
        slots:
          contentTemplateId: path.contentTemplateId
      - text: Revert modified blueprint template {contentTemplateId} to its original.
        slots:
          contentTemplateId: path.contentTemplateId
      method: generated
      generated: '2026-10-01'