ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes Credential Vault Operations API

6 actions 6 updates phrasing extends openapi/thousandeyes-credential-vault-operations-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for ThousandEyes's API. It is a proposal applied on top of the contract, not a document ThousandEyes publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/operations/credential-vault/{id}'].get
$.paths['/operations/credential-vault/{id}'].put
$.paths['/operations/credential-vault/{id}'].delete
$.paths['/operations/credential-vault'].get
$.paths['/operations/credential-vault'].post

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 ThousandEyes Credential Vault Operations API
  version: 1.0.0
extends: openapi/thousandeyes-credential-vault-operations-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: 5
- target: $.paths['/operations/credential-vault/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Credential Vault operation
      effect: read
      questions:
      - Can I look up a single Credential Vault operation by ID?
      - What secrets and status does a Credential Vault operation hold?
      instructions:
      - text: Show Credential Vault operation {id}.
        slots:
          id: path.id
      - text: Get the details of vault operation {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/operations/credential-vault/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Credential Vault operation
      effect: write
      questions:
      - How do I change the secrets on an existing Credential Vault operation?
      - Can I rename or change the status of a vault operation?
      instructions:
      - text: Update the secrets of Credential Vault operation {id} to {secrets}.
        slots:
          id: path.id
          secrets: requestBody.secrets
      - text: Rename vault operation {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/operations/credential-vault/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Credential Vault operation
      effect: destructive
      questions:
      - Will deleting a Credential Vault operation disable tests that depend on it?
      - What confirmation is required before a vault operation is removed?
      instructions:
      - text: 'Delete Credential Vault operation {id} and confirm disabling affected objects: {confirmDisabledObjects}.'
        slots:
          id: path.id
          confirmDisabledObjects: query.confirmDisabledObjects
      - text: Remove vault operation {id}, accepting that dependent tests get disabled ({confirmDisabledObjects}).
        slots:
          id: path.id
          confirmDisabledObjects: query.confirmDisabledObjects
      method: generated
      generated: '2026-09-26'
- target: $.paths['/operations/credential-vault'].get
  update:
    x-apievangelist-phrasing:
      intent: List Credential Vault operations
      effect: read
      questions:
      - Which Credential Vault operations exist in my account group?
      - What happens if I list vault operations without naming an account group?
      instructions:
      - text: List all Credential Vault operations.
      - text: Show the vault operations in account group {aid}.
        slots:
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/operations/credential-vault'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Credential Vault operation
      effect: write
      questions:
      - How do I create an operation that pulls secrets from a credential vault?
      - What name and secrets are required for a new Credential Vault operation?
      instructions:
      - text: Create a Credential Vault operation named {name} with secrets {secrets}.
        slots:
          name: requestBody.name
          secrets: requestBody.secrets
      - text: Add a new vault operation called {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'