API Evangelist conversational phrasing for Atlassian The Confluence Cloud REST Content States 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 States API
  version: 1.0.0
extends: openapi/atlassian-content-states-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: 11
- target: $.paths['/wiki/rest/api/content/{id}/state'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a page's content state
      effect: read
      questions:
      - What status label, like In progress or Ready for review, is on a Confluence page?
      - Can I check the content state of a page's draft rather than its published version?
      instructions:
      - text: Get the content state of page {id}.
        slots:
          id: path.id
      - text: Show the content state on the {status} version of content {id}.
        slots:
          status: query.status
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/state'].put
  update:
    x-apievangelist-phrasing:
      intent: Set the content state on a page
      effect: write
      questions:
      - How do I mark a single Confluence page as Ready for review?
      - Can I create a custom content state with my own name and color while setting it on a page?
      instructions:
      - text: Set the content state of page {id} to {name} with color {color}.
        slots:
          id: path.id
          name: requestBody.name
          color: requestBody.color
      - text: Apply existing content state {state_id} to the {status} version of page {id}.
        slots:
          state_id: requestBody.id
          status: query.status
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/state'].delete
  update:
    x-apievangelist-phrasing:
      intent: Clear the content state from a page
      effect: destructive
      questions:
      - How do I remove the status label from one Confluence page?
      - Does clearing a page's content state create a new version?
      instructions:
      - text: Remove the content state from page {id}.
        slots:
          id: path.id
      - text: Clear the status label on the {status} version of content {id}.
        slots:
          status: query.status
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/state/available'].get
  update:
    x-apievangelist-phrasing:
      intent: List content states available for a page
      effect: read
      questions:
      - Which status labels can I choose from for this particular page?
      - Why do I only see three custom content states for a page?
      instructions:
      - text: List the content states I can set on page {id}.
        slots:
          id: path.id
      - text: Show the space and recent custom states available for content {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content-states'].get
  update:
    x-apievangelist-phrasing:
      intent: List my custom content states
      effect: read
      questions:
      - Which custom content states have I created in Confluence?
      - Can I see all of my own custom page statuses, not just the recent three?
      instructions:
      - text: List every custom content state I've created.
      - text: Show my personal custom page statuses.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content-states'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a content state on many pages at once
      effect: write
      questions:
      - How do I mark a batch of Confluence pages as Verified in one go?
      - Is bulk-setting content states run as a long-running task?
      instructions:
      - text: Set content state {contentState} on the {status} versions of pages {ids}.
        slots:
          contentState: requestBody.contentState
          status: query.status
          ids: requestBody.ids
      - text: Start a bulk task applying state {contentState} to pages {ids} ({status} versions).
        slots:
          contentState: requestBody.contentState
          ids: requestBody.ids
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content-states/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove content states from many pages
      effect: destructive
      questions:
      - Can I clear status labels from a whole set of pages at once?
      - How do I bulk-remove content states from draft pages?
      instructions:
      - text: Remove content states from the {status} versions of pages {ids}.
        slots:
          status: query.status
          ids: requestBody.ids
      - text: Start a bulk task clearing page statuses on {ids}, {status} versions.
        slots:
          ids: requestBody.ids
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content-states/task/{taskId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a bulk content state task's progress
      effect: read
      questions:
      - Has my bulk content state update finished yet?
      - What is the status of a long-running set or remove content states task?
      instructions:
      - text: Check the progress of content state task {taskId}.
        slots:
          taskId: path.taskId
      - text: Tell me whether bulk page status task {taskId} has completed.
        slots:
          taskId: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/space/{spaceKey}/state'].get
  update:
    x-apievangelist-phrasing:
      intent: List suggested content states in a space
      effect: read
      questions:
      - Which page statuses does a Confluence space suggest to its authors?
      - What space-level content states are defined for my space?
      instructions:
      - text: List the suggested content states in space {spaceKey}.
        slots:
          spaceKey: path.spaceKey
      - text: Show the space content states configured for {spaceKey}.
        slots:
          spaceKey: path.spaceKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/space/{spaceKey}/state/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a space's content state settings
      effect: read
      questions:
      - Are content states even allowed in this Confluence space?
      - Is a space restricting authors from using custom content states?
      instructions:
      - text: Get the content state settings for space {spaceKey}.
        slots:
          spaceKey: path.spaceKey
      - text: Check whether custom or space content states are restricted in {spaceKey}.
        slots:
          spaceKey: path.spaceKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/space/{spaceKey}/state/content'].get
  update:
    x-apievangelist-phrasing:
      intent: Find pages in a space with a given content state
      effect: read
      questions:
      - Which pages in a space are currently marked In progress?
      - Can I page through all content that has a particular status label?
      instructions:
      - text: Find content in space {spaceKey} with content state {state_id}.
        slots:
          spaceKey: path.spaceKey
          state_id: query.state-id
      - text: List up to {limit} pages in {spaceKey} carrying state {state_id}.
        slots:
          limit: query.limit
          spaceKey: path.spaceKey
          state_id: query.state-id
      method: generated
      generated: '2026-10-01'