# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Aembit Cloud Client Workload API
  version: 1.0.0
extends: openapi/aembit-client-workload-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/api/v1/client-workloads'].get
  update:
    x-apievangelist-phrasing:
      intent: List client workloads
      effect: read
      questions:
      - Which client workloads are defined in my tenant?
      - Can I filter or group client workloads?
      - How do I page through client workloads in a resource set?
      instructions:
      - text: List my client workloads.
      - text: List client workloads matching {filter}.
        slots:
          filter: query.filter
      - text: Show client workloads in resource set {resourceSet}.
        slots:
          resourceSet: header.X-Aembit-ResourceSet
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/client-workloads'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a client workload
      effect: write
      questions:
      - How do I fully update a client workload's identities?
      - Can I enforce SSO on an existing client workload?
      instructions:
      - text: Replace client workload {name} with identities {identities}.
        slots:
          name: requestBody.name
          identities: requestBody.identities
      - text: 'Update client workload {name} to enforce SSO: {enforceSso}.'
        slots:
          name: requestBody.name
          enforceSso: requestBody.enforceSso
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/client-workloads'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a client workload
      effect: write
      questions:
      - How do I register a new client workload?
      - Can I identify a client workload by several identities when creating it?
      instructions:
      - text: Create client workload {name} identified by {identities}.
        slots:
          name: requestBody.name
          identities: requestBody.identities
      - text: Add a new client workload {name} in resource set {resourceSet}.
        slots:
          name: requestBody.name
          resourceSet: requestBody.resourceSet
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/client-workloads/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a client workload
      effect: read
      questions:
      - How is a specific client workload identified?
      - How many access policies use this client workload?
      instructions:
      - text: Show client workload {id}.
        slots:
          id: path.id
      - text: Get the identities configured on client workload {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/client-workloads/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a client workload
      effect: destructive
      questions:
      - Can I remove a client workload that is no longer deployed?
      - What is the way to delete a client workload by ID?
      instructions:
      - text: Delete client workload {id}.
        slots:
          id: path.id
      - text: Remove the retired client workload {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/client-workloads/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename, toggle or re-identify a client workload
      effect: write
      questions:
      - Can I change only the identities of a client workload?
      - Is it possible to deactivate a client workload without deleting it?
      instructions:
      - text: Deactivate client workload {id}.
        slots:
          id: path.id
      - text: Set the identities of client workload {id} to {identities}.
        slots:
          id: path.id
          identities: requestBody.identities
      - text: Rename client workload {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/client-workloads/identifiers'].get
  update:
    x-apievangelist-phrasing:
      intent: List the supported client identifier types
      effect: read
      questions:
      - What kinds of identifiers can I use to recognize a client workload?
      - Which client identifier options are available?
      instructions:
      - text: List the client identifier types.
      - text: Show me every supported client identifier.
      method: generated
      generated: '2026-09-26'