# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Chef Automate API Documentation Tokens API
  version: 1.0.0
extends: openapi/progress-software-tokens-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: 5
- target: $.paths['/apis/iam/v2/tokens'].get
  update:
    x-apievangelist-phrasing:
      intent: List API tokens
      effect: read
      questions:
      - What API tokens exist, including admin ones?
      - Can I see every token in Chef Automate?
      instructions:
      - text: List all API tokens.
      - text: Show me every admin and non-admin token.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/apis/iam/v2/tokens'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an API token
      effect: write
      questions:
      - How do I create a non-admin API token?
      - Is the token value generated automatically if I don't set one?
      instructions:
      - text: Create token {id} named {name}.
        slots:
          id: requestBody.id
          name: requestBody.name
      - text: Create an inactive token {id} called {name} in projects {projects}.
        slots:
          id: requestBody.id
          name: requestBody.name
          projects: requestBody.projects
      method: generated
      generated: '2026-10-01'
- target: $.paths['/apis/iam/v2/tokens/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an API token
      effect: read
      questions:
      - What are the details of a specific token?
      - Is a given token still active?
      instructions:
      - text: Show token {id}.
        slots:
          id: path.id
      - text: Get the details of token {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/apis/iam/v2/tokens/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an API token
      effect: write
      questions:
      - How do I deactivate a token without deleting it?
      - Does updating a token reset fields I leave out?
      instructions:
      - text: Rename token {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Deactivate token {id} and keep its name {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/apis/iam/v2/tokens/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an API token
      effect: destructive
      questions:
      - Can I permanently delete a token and remove it from policies?
      - How do I get rid of a leaked token?
      instructions:
      - text: Delete token {id}.
        slots:
          id: path.id
      - text: Remove API token {id} from all policies.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'