ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes Credentials API

6 actions 6 updates phrasing extends openapi/thousandeyes-credentials-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['/credentials'].get
$.paths['/credentials'].post
$.paths['/credentials/{id}'].get
$.paths['/credentials/{id}'].put
$.paths['/credentials/{id}'].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 ThousandEyes Credentials API
  version: 1.0.0
extends: openapi/thousandeyes-credentials-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['/credentials'].get
  update:
    x-apievangelist-phrasing:
      intent: List transaction test credentials
      effect: read
      questions:
      - Which stored credentials can my transaction tests use?
      - Can I list credentials for a specific account group?
      instructions:
      - text: List all credentials.
      - text: Show credentials in account group {aid}.
        slots:
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/credentials'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a transaction test credential
      effect: write
      questions:
      - Can I store a password for web transaction scripts to use?
      - What permission do I need to add a new credential?
      instructions:
      - text: Create a credential named {name} with value {value}.
        slots:
          name: requestBody.name
          value: requestBody.value
      - text: Store a new transaction test credential called {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/credentials/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a transaction test credential
      effect: read
      questions:
      - Can I view the details of one stored credential?
      - Who can see a transaction test credential?
      instructions:
      - text: Show credential {id}.
        slots:
          id: path.id
      - text: Get the details of transaction credential {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/credentials/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a transaction test credential
      effect: write
      questions:
      - Can I rotate the secret stored in an existing credential?
      - Is it possible to rename a credential?
      instructions:
      - text: Set the value of credential {id} to {value}.
        slots:
          id: path.id
          value: requestBody.value
      - text: Rename credential {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/credentials/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a transaction test credential
      effect: destructive
      questions:
      - Can I delete a credential that transaction tests no longer use?
      - What permission is needed to remove a credential?
      instructions:
      - text: Delete credential {id}.
        slots:
          id: path.id
      - text: Remove transaction test credential {id} from account group {aid}.
        slots:
          id: path.id
          aid: query.aid
      method: generated
      generated: '2026-09-26'