# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Automation Anywhere Credential Vault Lockers API
  version: 1.0.0
extends: openapi/automation-anywhere-lockers-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['/lockers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a locker in the Credential Vault
      effect: write
      questions:
      - How do I create a Locker to group credentials for bots?
      - What is a Locker in the Credential Vault used for?
      instructions:
      - text: Create a locker named {name}.
        slots:
          name: requestBody.name
      - text: Create locker {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lockers/list'].post
  update:
    x-apievangelist-phrasing:
      intent: Search lockers I have access to
      effect: read
      questions:
      - Which Lockers do I have access to?
      - Can I search Lockers by name?
      instructions:
      - text: List all lockers I can access.
      - text: Search lockers matching {filter}.
        slots:
          filter: requestBody.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lockers/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a locker's details
      effect: read
      questions:
      - What are the name, description and configuration of a specific Locker?
      - Can I look up a Locker by its ID?
      instructions:
      - text: Show the details of locker {id}.
        slots:
          id: path.id
      - text: Get the configuration of locker {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lockers/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or redescribe a locker
      effect: write
      questions:
      - Can I rename an existing Locker?
      - Who is allowed to change a Locker's name or description?
      instructions:
      - text: Rename locker {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Update locker {id} with name {name} and description {description}.
        slots:
          id: path.id
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lockers/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a locker
      effect: destructive
      questions:
      - Are the credentials deleted when I delete their Locker?
      - Can I permanently remove a Locker I no longer need?
      instructions:
      - text: Delete locker {id}.
        slots:
          id: path.id
      - text: Permanently remove locker {id} and its credential associations.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lockers/{id}/credentials'].get
  update:
    x-apievangelist-phrasing:
      intent: List the credentials inside a locker
      effect: read
      questions:
      - Which credentials are stored in a particular Locker?
      - What credential attributes can bots consume through a Locker?
      instructions:
      - text: List the credentials in locker {id}.
        slots:
          id: path.id
      - text: Show which credentials and attributes locker {id} exposes to bots.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lockers/{id}/credentials/{credentialId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change which credential attributes a locker exposes
      effect: write
      questions:
      - Can I limit which attributes of a credential are exposed to consumer roles through a Locker?
      - How do I edit a credential's configuration inside a Locker?
      instructions:
      - text: Expose attributes {attributes} of credential {credentialId} through locker {id}.
        slots:
          attributes: requestBody.attributes
          credentialId: path.credentialId
          id: path.id
      - text: Update how credential {credentialId} is configured inside locker {id}.
        slots:
          credentialId: path.credentialId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/lockers/{id}/credentials/{credentialId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a credential from a locker
      effect: destructive
      questions:
      - Can I take a credential out of a Locker without deleting it from the vault?
      - What happens to consumer access when a credential is removed from a Locker?
      instructions:
      - text: Remove credential {credentialId} from locker {id}.
        slots:
          credentialId: path.credentialId
          id: path.id
      - text: Take credential {credentialId} out of locker {id} but keep it in the Credential Vault.
        slots:
          credentialId: path.credentialId
          id: path.id
      method: generated
      generated: '2026-10-01'