# 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 Labels API
  version: 1.0.0
extends: openapi/atlassian-content-labels-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: 4
- target: $.paths['/wiki/rest/api/content/{id}/label'].get
  update:
    x-apievangelist-phrasing:
      intent: List labels on a Confluence page
      effect: read
      questions:
      - Which labels are attached to a Confluence page?
      - Can I filter a page's labels by prefix such as global or my?
      instructions:
      - text: List the labels on Confluence content {id}.
        slots:
          id: path.id
      - text: Show {prefix} labels on page {id}.
        slots:
          prefix: query.prefix
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/label'].post
  update:
    x-apievangelist-phrasing:
      intent: Add labels to a Confluence page
      effect: write
      questions:
      - How do I tag a Confluence page with new labels without losing the existing ones?
      - Can I add several labels to a page at once?
      instructions:
      - text: Add labels to Confluence content {id}.
        slots:
          id: path.id
      - text: Tag page {id} with additional labels, keeping its current ones.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/label'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a label by name via query
      effect: destructive
      questions:
      - Can I remove a label that contains a slash from a Confluence page?
      - Why can't labels be removed from archived content?
      instructions:
      - text: Remove the label named {name} from Confluence content {id} using the query parameter form.
        slots:
          name: query.name
          id: path.id
      - text: Untag page {id} by passing label {name} as a query parameter.
        slots:
          id: path.id
          name: query.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/label/{label}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a label from a page
      effect: destructive
      questions:
      - How do I take a single label off a Confluence page?
      - Can I delete a label from a page by putting its name in the URL path?
      instructions:
      - text: Remove label {label} from Confluence content {id}.
        slots:
          label: path.label
          id: path.id
      - text: Delete label {label} from page {id} by its path name.
        slots:
          label: path.label
          id: path.id
      method: generated
      generated: '2026-10-01'