Automation Anywhere · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Automation Anywhere Credential Vault Attribute Values API

5 actions 5 updates phrasing extends openapi/automation-anywhere-attribute-values-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Automation Anywhere's API. It is a proposal applied on top of the contract, not a document Automation Anywhere publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/credentials/{id}/attributevalues'].get
$.paths['/credentials/{id}/attributevalues'].post
$.paths['/credentials/{id}/attributevalues/{attributeValueId}'].put
$.paths['/credentials/{id}/attributevalues/{attributeValueId}'].delete

OpenAPI Overlay

Raw ↑
# 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 Attribute Values API
  version: 1.0.0
extends: openapi/automation-anywhere-attribute-values-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: 4
- target: $.paths['/credentials/{id}/attributevalues'].get
  update:
    x-apievangelist-phrasing:
      intent: List a credential's attribute values
      effect: read
      questions:
      - What values are currently stored on each attribute of a Credential Vault credential?
      - Can I see only the attribute values scoped to one user for a credential?
      instructions:
      - text: Show the attribute values stored on credential {id}.
        slots:
          id: path.id
      - text: List credential {id}'s values for attribute {credentialAttributeId} belonging to user {userId}.
        slots:
          id: path.id
          credentialAttributeId: query.credentialAttributeId
          userId: query.userId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/credentials/{id}/attributevalues'].post
  update:
    x-apievangelist-phrasing:
      intent: Set new attribute values on a credential
      effect: write
      questions:
      - Where do I store the actual password or secret for a credential's attribute definitions?
      - Can I set several secret values on a credential in one request?
      instructions:
      - text: 'Set these new attribute values on credential {id}: {attributeValues}.'
        slots:
          id: path.id
          attributeValues: requestBody.attributeValues
      - text: Store initial secret values for the attributes of credential {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/credentials/{id}/attributevalues/{attributeValueId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rotate one stored attribute value on a credential
      effect: write
      questions:
      - Can I rotate a password on an existing credential without changing its structure?
      - What's the way to change a single existing secret value in the Credential Vault?
      instructions:
      - text: Change attribute value {attributeValueId} on credential {id} to {value}.
        slots:
          attributeValueId: path.attributeValueId
          id: path.id
          value: requestBody.value
      - text: Rotate the stored secret {attributeValueId} of credential {id}.
        slots:
          attributeValueId: path.attributeValueId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/credentials/{id}/attributevalues/{attributeValueId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a stored attribute value from a credential
      effect: destructive
      questions:
      - Can I wipe one stored secret from a credential but keep the attribute definition?
      - Is deleting a credential attribute value permanent?
      instructions:
      - text: Delete attribute value {attributeValueId} from credential {id}.
        slots:
          attributeValueId: path.attributeValueId
          id: path.id
      - text: Permanently clear the stored value {attributeValueId} on credential {id} but leave its attribute in place.
        slots:
          attributeValueId: path.attributeValueId
          id: path.id
      method: generated
      generated: '2026-10-01'