TextQL · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for TextQL Secret Service API

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

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/textql.rpc.public.secret.SecretService/DeleteSecret'].post
$.paths['/textql.rpc.public.secret.SecretService/GetMembersWithSecrets'].post
$.paths['/textql.rpc.public.secret.SecretService/ListSecrets'].post
$.paths['/textql.rpc.public.secret.SecretService/PutSecret'].post
$.paths['/textql.rpc.public.secret.SecretService/UpdateSecret'].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 TextQL Secret Service API
  version: 1.0.0
extends: openapi/textql-secretservice-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: 5
- target: $.paths['/textql.rpc.public.secret.SecretService/DeleteSecret'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a secret
      effect: destructive
      questions:
      - How do I remove a stored secret?
      - Can a deleted secret be recovered?
      instructions:
      - text: Delete the secret named {name}.
        slots:
          name: requestBody.name
      - text: Permanently remove secret {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.secret.SecretService/GetMembersWithSecrets'].post
  update:
    x-apievangelist-phrasing:
      intent: List members who have stored secrets
      effect: read
      questions:
      - Which teammates have stored secrets in TextQL?
      - Who owns secrets in our organization?
      instructions:
      - text: List members who have secrets.
      - text: Show every member owning a secret, timing out after {timeout_ms} ms.
        slots:
          timeout_ms: header.Connect-Timeout-Ms
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.secret.SecretService/ListSecrets'].post
  update:
    x-apievangelist-phrasing:
      intent: List secrets
      effect: read
      questions:
      - What secrets do I have saved?
      - Can I see the names of stored credentials without their values?
      instructions:
      - text: List my secrets.
      - text: Show all stored secrets with a {timeout_ms} ms timeout.
        slots:
          timeout_ms: header.Connect-Timeout-Ms
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.secret.SecretService/PutSecret'].post
  update:
    x-apievangelist-phrasing:
      intent: Store a new secret
      effect: write
      questions:
      - How do I save an API key so TextQL can use it?
      - Can a secret be kept private to me?
      instructions:
      - text: Store secret {name} with value {value}.
        slots:
          name: requestBody.name
          value: requestBody.value
      - text: Save private secret {name} as {value}, described as {description}.
        slots:
          name: requestBody.name
          value: requestBody.value
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.secret.SecretService/UpdateSecret'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an existing secret
      effect: write
      questions:
      - Can I rotate the value of a secret I already stored?
      - Is it possible to change a secret's description or link?
      instructions:
      - text: Rotate secret {name} to the new value {value}.
        slots:
          name: requestBody.name
          value: requestBody.value
      - text: Change the link on secret {name} to {link}.
        slots:
          name: requestBody.name
          link: requestBody.link
      method: generated
      generated: '2026-10-01'