# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for JFrog Catalog REST Labels API
  version: 1.0.0
extends: openapi/jfrog-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['/labels'].get
  update:
    x-apievangelist-phrasing:
      intent: List Catalog labels
      effect: read
      questions:
      - What custom labels have been defined in the Catalog?
      - Can I see all the labels available to tag packages with?
      instructions:
      - text: List all Catalog labels.
      - text: Show every custom package label.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/labels'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Catalog label
      effect: write
      questions:
      - How do I create a new label for organizing packages?
      - Can I give a new label a color and description?
      instructions:
      - text: Create label {name} with color {color}.
        slots:
          name: requestBody.name
          color: requestBody.color
      - text: Add a Catalog label {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/labels/{labelName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Catalog label
      effect: read
      questions:
      - How do I see the description and color of one label?
      - What details are stored for a specific Catalog label?
      instructions:
      - text: Show label {labelName}.
        slots:
          labelName: path.labelName
      - text: Get the details of Catalog label {labelName}.
        slots:
          labelName: path.labelName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/labels/{labelName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Catalog label
      effect: write
      questions:
      - How do I rename an existing label?
      - Can I change a label's color after creating it?
      instructions:
      - text: Rename label {labelName} to {name}.
        slots:
          labelName: path.labelName
          name: requestBody.name
      - text: Change label {labelName}'s color to {color}, keeping name {name}.
        slots:
          labelName: path.labelName
          color: requestBody.color
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/labels/{labelName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Catalog label
      effect: destructive
      questions:
      - Does deleting a label detach it from every package?
      - How do I remove a label from the Catalog entirely?
      instructions:
      - text: Delete label {labelName}.
        slots:
          labelName: path.labelName
      - text: Remove Catalog label {labelName} everywhere.
        slots:
          labelName: path.labelName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/labels/{labelName}/packages'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply a label to packages
      effect: write
      questions:
      - How do I tag several packages with the same label at once?
      - Can I attach a label to a list of packages?
      instructions:
      - text: Apply label {labelName} to packages {packages}.
        slots:
          labelName: path.labelName
          packages: requestBody.packages
      - text: Tag {packages} with the {labelName} label.
        slots:
          labelName: path.labelName
          packages: requestBody.packages
      method: generated
      generated: '2026-10-01'
- target: $.paths['/labels/{labelName}/packages'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a label from packages
      effect: destructive
      questions:
      - How do I take a label off some packages without deleting the label?
      - Can I untag specific packages from a label?
      instructions:
      - text: Remove label {labelName} from packages {packages}.
        slots:
          labelName: path.labelName
          packages: requestBody.packages
      - text: Untag {packages} from {labelName}.
        slots:
          labelName: path.labelName
          packages: requestBody.packages
      method: generated
      generated: '2026-10-01'