Confluence · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluence Cloud REST Content labels API

4 actions 4 updates phrasing extends openapi/confluence-content-labels-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 4

$.info
$.paths['/wiki/rest/api/content/{id}/label'].post
$.paths['/wiki/rest/api/content/{id}/label'].delete
$.paths['/wiki/rest/api/content/{id}/label/{label}'].delete

OpenAPI Overlay

Raw ↑ 
# 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 Content labels API
  version: 1.0.0
extends: openapi/confluence-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: 3
- target: $.paths['/wiki/rest/api/content/{id}/label'].post
  update:
    x-apievangelist-phrasing:
      intent: Add labels to content
      effect: write
      questions:
      - How do I tag a page with extra labels?
      - Does adding labels remove the labels already on content?
      instructions:
      - text: Add labels to content {id}.
        slots:
          id: path.id
      - text: Tag page {id} with new labels, keeping the existing 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:
      - How do I remove a label whose name contains a slash?
      - Can I untag content by passing the label name as a query value?
      instructions:
      - text: Remove the label named {name} from content {id} using the query parameter.
        slots:
          id: path.id
          name: query.name
      - text: Untag page {id} of label {name}, passing the name as a query value.
        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 content
      effect: destructive
      questions:
      - How do I take a label off a page?
      - Can I remove a label from archived content?
      instructions:
      - text: Remove label {label} from content {id}.
        slots:
          id: path.id
          label: path.label
      - text: Delete the {label} tag from page {id}.
        slots:
          id: path.id
          label: path.label
      method: generated
      generated: '2026-10-01'