# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Confluence Label API
  version: 1.0.0
extends: openapi/confluence-label-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: 8
- target: $.paths['/pages/{id}/labels'].get
  update:
    x-apievangelist-phrasing:
      intent: List the labels on a page
      effect: read
      questions:
      - What labels are tagged on a specific Confluence page?
      - Can I filter a page's labels by prefix, like only global ones?
      instructions:
      - text: List the labels on page {id}.
        slots:
          id: path.id
      - text: Show the {prefix} labels on page {id}.
        slots:
          prefix: query.prefix
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/labels/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a label by its id
      effect: read
      questions:
      - How do I look up a label's name when all I have is its id?
      - What details come back for a single label?
      instructions:
      - text: Get label {id}.
        slots:
          id: path.id
      - text: Look up the name and prefix of label {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attachments/{id}/labels'].get
  update:
    x-apievangelist-phrasing:
      intent: List the labels on an attachment
      effect: read
      questions:
      - Which labels are applied to an uploaded file?
      - Can I sort an attachment's labels?
      instructions:
      - text: List the labels on attachment {id}.
        slots:
          id: path.id
      - text: Show attachment {id}'s labels sorted by {sort}.
        slots:
          id: path.id
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/blogposts/{id}/labels'].get
  update:
    x-apievangelist-phrasing:
      intent: List the labels on a blog post
      effect: read
      questions:
      - What labels does a given blog post carry?
      - Can I page through a blog post's labels with a cursor?
      instructions:
      - text: List the labels on blog post {id}.
        slots:
          id: path.id
      - text: Get the {prefix} labels on blog post {id}.
        slots:
          prefix: query.prefix
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom-content/{id}/labels'].get
  update:
    x-apievangelist-phrasing:
      intent: List the labels on custom content
      effect: read
      questions:
      - Which labels are attached to an app's custom content item?
      - Can I limit how many labels come back for custom content?
      instructions:
      - text: List the labels on custom content {id}.
        slots:
          id: path.id
      - text: Get up to {limit} labels from custom content {id}.
        slots:
          limit: query.limit
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/labels'].get
  update:
    x-apievangelist-phrasing:
      intent: List every label on the site
      effect: read
      questions:
      - What labels exist across the whole Confluence site?
      - Can I look up several labels at once by their ids?
      instructions:
      - text: List all labels on the site.
      - text: Get the labels with ids {label-id}.
        slots:
          label-id: query.label-id
      - text: List every site label with prefix {prefix}.
        slots:
          prefix: query.prefix
      method: generated
      generated: '2026-10-01'
- target: $.paths['/spaces/{id}/labels'].get
  update:
    x-apievangelist-phrasing:
      intent: List the labels on a space itself
      effect: read
      questions:
      - Which labels are applied to a space as a whole, not its pages?
      - Can I sort the labels tagged on a space by its id?
      instructions:
      - text: List the labels on space {id}.
        slots:
          id: path.id
      - text: Show labels applied to space {id} sorted by {sort}.
        slots:
          id: path.id
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/spaces/{id}/content/labels'].get
  update:
    x-apievangelist-phrasing:
      intent: List labels used on content in a space
      effect: read
      questions:
      - What labels are used across the pages and blog posts inside a space?
      - Can I see which tags a space's content uses, filtered by prefix?
      instructions:
      - text: List the labels used on content in space {id}.
        slots:
          id: path.id
      - text: Get {prefix} labels from pages and blog posts in space {id}.
        slots:
          prefix: query.prefix
          id: path.id
      method: generated
      generated: '2026-10-01'