# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for DoiT Labels API
  version: 1.0.0
extends: openapi/doit-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: 7
- target: $.paths['/analytics/v1/labels'].get
  update:
    x-apievangelist-phrasing:
      intent: List labels
      effect: read
      questions:
      - Which labels exist for organizing our reports?
      - Can I filter or sort labels?
      instructions:
      - text: List all labels.
      - text: List labels matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/labels'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a label
      effect: write
      questions:
      - How do I create a colored label for tagging reports?
      - What do I need to make a new label?
      instructions:
      - text: Create label {name} with color {color}.
        slots:
          name: requestBody.name
          color: requestBody.color
      - text: Add a new {color} label called {name}.
        slots:
          name: requestBody.name
          color: requestBody.color
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/labels/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a label
      effect: read
      questions:
      - How do I see a single label's name and color?
      - Can I fetch one label by ID?
      instructions:
      - text: Get label {id}.
        slots:
          id: path.id
      - text: Show me label {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/labels/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a label
      effect: destructive
      questions:
      - How do I delete a label we no longer use?
      - Can I remove a label entirely?
      instructions:
      - text: Delete label {id}.
        slots:
          id: path.id
      - text: Remove label {id} from the account.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/labels/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or recolor a label
      effect: write
      questions:
      - How do I rename an existing label?
      - Can I change a label's color?
      instructions:
      - text: Rename label {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Change label {id} color to {color}.
        slots:
          id: path.id
          color: requestBody.color
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/labels/{id}/assignments'].get
  update:
    x-apievangelist-phrasing:
      intent: See what a label is assigned to
      effect: read
      questions:
      - Which reports and objects carry a particular label?
      - What is currently tagged with a given label?
      instructions:
      - text: List objects assigned to label {id}.
        slots:
          id: path.id
      - text: Show everything tagged with label {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/labels/{id}/assignments'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign or unassign objects to a label
      effect: write
      questions:
      - How do I tag several reports with a label at once?
      - Can I remove objects from a label in the same call as adding others?
      instructions:
      - text: Assign {add} to label {id}.
        slots:
          add: requestBody.add
          id: path.id
      - text: Unassign {remove} from label {id}.
        slots:
          remove: requestBody.remove
          id: path.id
      method: generated
      generated: '2026-10-01'