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

# 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 Content API
  version: 1.0.0
extends: openapi/atlassian-content-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: 10
- target: $.paths['/wiki/rest/api/content'].get
  update:
    x-apievangelist-phrasing:
      intent: List Confluence pages and blog posts
      effect: read
      questions:
      - Can I list all the pages in a particular Confluence space?
      - Which blog posts were published on a given day?
      - Is there a way to find a page by its exact title in a space?
      instructions:
      - text: List the pages in Confluence space {spaceKey}.
        slots:
          spaceKey: query.spaceKey
      - text: Find content titled {title} in space {spaceKey}.
        slots:
          title: query.title
          spaceKey: query.spaceKey
      - text: List blog posts posted on {postingDay}.
        slots:
          postingDay: query.postingDay
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Confluence page or blog post
      effect: write
      questions:
      - How do I create a new Confluence page under a parent page?
      - Can I publish an existing draft through the create content call?
      instructions:
      - text: Create a Confluence {type} titled {title} in space {space}.
        slots:
          type: requestBody.type
          title: requestBody.title
          space: requestBody.space
      - text: Create page {title} under ancestor {ancestors} with body {body}.
        slots:
          title: requestBody.title
          ancestors: requestBody.ancestors
          body: requestBody.body
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/archive'].post
  update:
    x-apievangelist-phrasing:
      intent: Archive Confluence pages in bulk
      effect: write
      questions:
      - Can I archive a batch of old Confluence pages at once?
      - Does page archiving happen right away or as a background task?
      instructions:
      - text: Archive the Confluence pages {pages}.
        slots:
          pages: requestBody.pages
      - text: Move pages {pages} to the archive and give me the task ID.
        slots:
          pages: requestBody.pages
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/blueprint/instance/{draftId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Publish a shared blueprint draft
      effect: write
      questions:
      - How do I publish a shared draft that was created from a blueprint?
      - What fields are required when publishing a blueprint page draft?
      instructions:
      - text: Publish shared blueprint draft {draftId} as {title}.
        slots:
          draftId: path.draftId
          title: requestBody.title
      - text: Publish shared draft {draftId} titled {title} at version {version}.
        slots:
          draftId: path.draftId
          title: requestBody.title
          version: requestBody.version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/blueprint/instance/{draftId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish a legacy blueprint draft
      effect: write
      questions:
      - My blueprint page is an older legacy draft — how do I publish it?
      - Is the legacy blueprint draft publish going away?
      instructions:
      - text: Publish legacy blueprint draft {draftId} as {title}.
        slots:
          draftId: path.draftId
          title: requestBody.title
      - text: Publish the older legacy draft {draftId} titled {title} at version {version}.
        slots:
          draftId: path.draftId
          title: requestBody.title
          version: requestBody.version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search Confluence content with CQL
      effect: read
      questions:
      - How do I search Confluence with a CQL query like type=page and text~'roadmap'?
      - Can I page through CQL search results with a cursor?
      instructions:
      - text: Search Confluence content with CQL {cql}.
        slots:
          cql: query.cql
      - text: Run CQL query {cql} and return {limit} results.
        slots:
          cql: query.cql
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Confluence page or post by ID
      effect: read
      questions:
      - Can I fetch one Confluence page with its body by content ID?
      - Is it possible to retrieve an older version of a page?
      instructions:
      - text: Get Confluence content {id}.
        slots:
          id: path.id
      - text: Fetch version {version} of Confluence page {id}.
        slots:
          version: query.version
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Confluence page's title or body
      effect: write
      questions:
      - How do I edit the body of an existing Confluence page?
      - Why do I need to send the next version number when updating a page?
      instructions:
      - text: Update Confluence content {id} with body {body} as version {version}.
        slots:
          id: path.id
          body: requestBody.body
          version: requestBody.version
      - text: Rename Confluence page {id} to {title} at version {version}.
        slots:
          id: path.id
          title: requestBody.title
          version: requestBody.version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Trash or purge Confluence content
      effect: destructive
      questions:
      - How do I move a Confluence page to the trash?
      - Can I permanently purge a page that's already in the trash?
      instructions:
      - text: Move Confluence content {id} to the space trash.
        slots:
          id: path.id
      - text: Delete Confluence content {id} with status {status} to purge it from the trash.
        slots:
          id: path.id
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the latest update history of content
      effect: read
      questions:
      - Who last edited a Confluence page and when?
      - What's the most recent update recorded for a piece of content?
      instructions:
      - text: Get the history of Confluence content {id}.
        slots:
          id: path.id
      - text: Show the last update and creator details for page {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'