# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for glossaries Terms API
  version: 1.0.0
extends: openapi/qliksense-terms-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['/api/v1/glossaries/{id}/terms'].get
  update:
    x-apievangelist-phrasing:
      intent: List terms in a glossary
      effect: read
      questions:
      - Which business terms are defined in a glossary?
      - Can I filter a glossary's terms?
      instructions:
      - text: List the terms in glossary {id}.
        slots:
          id: path.id
      - text: List terms of glossary {id} matching {filter}.
        slots:
          id: path.id
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/glossaries/{id}/terms'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a glossary term
      effect: write
      questions:
      - Can I add a new business term to a glossary?
      - Is it possible to put a new term in categories and give it an abbreviation?
      instructions:
      - text: Create term {name} in glossary {id}.
        slots:
          name: requestBody.name
          id: path.id
      - text: Add term {name} with abbreviation {abbreviation} to glossary {id}.
        slots:
          name: requestBody.name
          abbreviation: requestBody.abbreviation
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/glossaries/{id}/terms/{termId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a glossary term
      effect: read
      questions:
      - What does a particular business term mean in our glossary?
      - Who are the stewards of one glossary term?
      instructions:
      - text: Show term {termId} in glossary {id}.
        slots:
          termId: path.termId
          id: path.id
      - text: Get the definition of term {termId} from glossary {id}.
        slots:
          termId: path.termId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/glossaries/{id}/terms/{termId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a glossary term
      effect: write
      questions:
      - Can I rewrite a term's name, description and categories in one call?
      - Which fields must be resent when replacing a whole term?
      instructions:
      - text: Replace term {termId} in glossary {id} with name {name}.
        slots:
          termId: path.termId
          id: path.id
          name: requestBody.name
      - text: Rewrite the description of term {termId} in glossary {id} to {description}.
        slots:
          termId: path.termId
          id: path.id
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/glossaries/{id}/terms/{termId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a glossary term
      effect: destructive
      questions:
      - Can I remove an obsolete term from a glossary?
      - Is deleting a glossary term permanent?
      instructions:
      - text: Delete term {termId} from glossary {id}.
        slots:
          termId: path.termId
          id: path.id
      - text: Remove obsolete term {termId} in glossary {id}.
        slots:
          termId: path.termId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/glossaries/{id}/terms/{termId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch glossary term properties
      effect: write
      questions:
      - Can I change just one property of a term with JSON Patch?
      - Is a partial edit of a term possible without resending everything?
      instructions:
      - text: Patch term {termId} in glossary {id} with JSON Patch operations.
        slots:
          termId: path.termId
          id: path.id
      - text: Apply a partial edit to term {termId} of glossary {id}.
        slots:
          termId: path.termId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/glossaries/{id}/terms/{termId}/actions/change-status'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a term's status
      effect: write
      questions:
      - Can I mark a glossary term as verified?
      - Who is allowed to verify a term, and who can edit it afterwards?
      instructions:
      - text: Set the status of term {termId} in glossary {id} to {status}.
        slots:
          termId: path.termId
          id: path.id
          status: query.status
      - text: Verify term {termId} in glossary {id} by changing its status to {status}.
        slots:
          termId: path.termId
          id: path.id
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/glossaries/{id}/terms/{termId}/revisions'].get
  update:
    x-apievangelist-phrasing:
      intent: List revisions of a term
      effect: read
      questions:
      - Can I see how a glossary term has changed over time?
      - Where do I find earlier versions of a term definition?
      instructions:
      - text: List revisions of term {termId} in glossary {id}.
        slots:
          termId: path.termId
          id: path.id
      - text: Show the previous {limit} versions of term {termId} in glossary {id}.
        slots:
          limit: query.limit
          termId: path.termId
          id: path.id
      method: generated
      generated: '2026-10-01'