# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cumulocity Tenant Tenant Options API
  version: 1.0.0
extends: openapi/cumulocity-tenant-options-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['/tenant/options'].get
  update:
    x-apievangelist-phrasing:
      intent: List tenant configuration options
      effect: read
      questions:
      - What configuration options are set on my tenant?
      - Which tenant option keys and values exist?
      instructions:
      - text: List all tenant options.
      - text: Show every tenant option category, key and value.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tenant/options'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a tenant configuration option
      effect: write
      questions:
      - How do I store a new configuration value on my tenant?
      - Can I add a tenant option under my own category?
      instructions:
      - text: Create tenant option {key} in category {category} with value {value}.
        slots:
          key: requestBody.key
          category: requestBody.category
          value: requestBody.value
      - text: Add a new option {category}.{key} set to {value}.
        slots:
          category: requestBody.category
          key: requestBody.key
          value: requestBody.value
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tenant/options/{category}/{key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read one tenant option
      effect: read
      questions:
      - What value is a specific tenant option set to?
      - How do I read one option by its category and key?
      instructions:
      - text: Show tenant option {key} in category {category}.
        slots:
          key: path.key
          category: path.category
      - text: Get the value of option {category}/{key}.
        slots:
          category: path.category
          key: path.key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tenant/options/{category}/{key}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a tenant option value
      effect: write
      questions:
      - How do I change the value of an existing tenant option?
      - Can I overwrite a configuration value stored on the tenant?
      instructions:
      - text: Set tenant option {category}/{key} to {value}.
        slots:
          category: path.category
          key: path.key
          value: requestBody.value
      - text: Change the existing option {key} in category {category} to {value}.
        slots:
          key: path.key
          category: path.category
          value: requestBody.value
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tenant/options/{category}/{key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a tenant option
      effect: destructive
      questions:
      - How do I remove a tenant option I no longer use?
      - Can I delete one configuration option by category and key?
      instructions:
      - text: Delete tenant option {key} in category {category}.
        slots:
          key: path.key
          category: path.category
      - text: Remove option {category}/{key} from the tenant.
        slots:
          category: path.category
          key: path.key
      method: generated
      generated: '2026-10-01'