API Evangelist conversational phrasing for glossaries Categories 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 Categories API
  version: 1.0.0
extends: openapi/qliksense-categories-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: 6
- target: $.paths['/api/v1/glossaries/{id}/categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List categories in a glossary
      effect: read
      questions:
      - Which categories are defined in a business glossary?
      - Can I page through and sort a glossary's categories?
      instructions:
      - text: List the categories in glossary {id}.
        slots:
          id: path.id
      - text: List {limit} categories of glossary {id} sorted by {sort}.
        slots:
          limit: query.limit
          id: path.id
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/glossaries/{id}/categories'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a glossary category
      effect: write
      questions:
      - Can I add a new category to organise terms in a glossary?
      - Is it possible to nest a category under a parent category?
      instructions:
      - text: Create category {name} in glossary {id}.
        slots:
          name: requestBody.name
          id: path.id
      - text: Add category {name} under parent {parentId} in glossary {id}.
        slots:
          name: requestBody.name
          parentId: requestBody.parentId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/glossaries/{id}/categories/{categoryId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a glossary category
      effect: read
      questions:
      - Can I view the details of one category in a glossary?
      - Who are the stewards of a particular glossary category?
      instructions:
      - text: Show category {categoryId} in glossary {id}.
        slots:
          categoryId: path.categoryId
          id: path.id
      - text: Get the stewards and description of category {categoryId} in glossary {id}.
        slots:
          categoryId: path.categoryId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/glossaries/{id}/categories/{categoryId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a glossary category
      effect: write
      questions:
      - Can I fully rewrite a category's name, parent and stewards in one call?
      - Which fields are replaced when I update a whole glossary category?
      instructions:
      - text: Replace category {categoryId} in glossary {id} with name {name}.
        slots:
          categoryId: path.categoryId
          id: path.id
          name: requestBody.name
      - text: Move category {categoryId} of glossary {id} under parent {parentId}.
        slots:
          categoryId: path.categoryId
          id: path.id
          parentId: requestBody.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/glossaries/{id}/categories/{categoryId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a glossary category
      effect: destructive
      questions:
      - Can I remove a category from a glossary?
      - Is deleting a glossary category permanent?
      instructions:
      - text: Delete category {categoryId} from glossary {id}.
        slots:
          categoryId: path.categoryId
          id: path.id
      - text: Remove the unused category {categoryId} in glossary {id}.
        slots:
          categoryId: path.categoryId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/glossaries/{id}/categories/{categoryId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch individual category properties
      effect: write
      questions:
      - Can I change just one property of a glossary category with JSON Patch?
      - Is a partial edit of a category possible without resending everything?
      instructions:
      - text: Patch category {categoryId} in glossary {id} with JSON Patch operations.
        slots:
          categoryId: path.categoryId
          id: path.id
      - text: Apply a partial JSON Patch edit to category {categoryId} of glossary {id}.
        slots:
          categoryId: path.categoryId
          id: path.id
      method: generated
      generated: '2026-10-01'