API Evangelist conversational phrasing for Glossaries API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Glossaries API
  version: 1.0.0
extends: openapi/qliksense-glossaries-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'].get
  update:
    x-apievangelist-phrasing:
      intent: List business glossaries
      effect: read
      questions:
      - Which business glossaries exist in my tenant?
      - Can I get a total count of glossaries while paging?
      instructions:
      - text: List all glossaries.
      - text: List {limit} glossaries sorted by {sort}.
        slots:
          limit: query.limit
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/glossaries'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a business glossary
      effect: write
      questions:
      - Can I start a new business glossary for my team?
      - Who is allowed to create a glossary?
      instructions:
      - text: Create a glossary named {name}.
        slots:
          name: requestBody.name
      - text: Create glossary {name} in space {spaceId} with description {description}.
        slots:
          name: requestBody.name
          spaceId: requestBody.spaceId
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/glossaries/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a glossary
      effect: read
      questions:
      - Can I see the overview and description of one glossary?
      - Where do I look up a single glossary by its ID?
      instructions:
      - text: Show glossary {id}.
        slots:
          id: path.id
      - text: Get the overview of glossary {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/glossaries/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a glossary
      effect: write
      questions:
      - Can I rewrite a glossary's name, overview and description all at once?
      - Which fields must be resent when replacing a glossary?
      instructions:
      - text: Replace glossary {id} with name {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Rewrite glossary {id} with overview {overview}.
        slots:
          id: path.id
          overview: requestBody.overview
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/glossaries/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a glossary and its terms
      effect: destructive
      questions:
      - Can I delete an entire glossary?
      - Are the terms removed too when a glossary is deleted?
      instructions:
      - text: Delete glossary {id}.
        slots:
          id: path.id
      - text: Remove glossary {id} along with all of its terms.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/glossaries/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch glossary properties
      effect: write
      questions:
      - Can I change just one property of a glossary with JSON Patch?
      - Is a partial glossary edit possible without resending everything?
      instructions:
      - text: Patch glossary {id} with JSON Patch operations.
        slots:
          id: path.id
      - text: Apply a partial edit to glossary {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/glossaries/{id}/actions/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a glossary
      effect: read
      questions:
      - Can I export a glossary with its categories and terms to a file?
      - Which formats can a glossary export use?
      instructions:
      - text: Export glossary {id}.
        slots:
          id: path.id
      - text: Export glossary {id} in {format} format.
        slots:
          id: path.id
          format: query.format
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/glossaries/actions/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import a glossary from a file
      effect: write
      questions:
      - Can I import a glossary definition file with its terms and categories?
      - Which glossary file formats are supported for import?
      instructions:
      - text: Import a glossary named {name} with terms {terms}.
        slots:
          name: requestBody.name
          terms: requestBody.terms
      - text: Import a glossary into space {spaceId}, looking up stewards by email {lookupUserOnEmail}.
        slots:
          spaceId: query.spaceId
          lookupUserOnEmail: query.lookupUserOnEmail
      method: generated
      generated: '2026-10-01'