Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Testflinger Secrets API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/v1/secrets/{client_id}/{path}'].put
$.paths['/v1/secrets/{client_id}/{path}'].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 Testflinger Secrets API
  version: 1.0.0
extends: openapi/canonical-secrets-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: 2
- target: $.paths['/v1/secrets/{client_id}/{path}'].put
  update:
    x-apievangelist-phrasing:
      intent: Store a secret
      effect: write
      questions:
      - How do I store a secret that my test jobs can use?
      - Can a stored secret expire automatically?
      instructions:
      - text: Store secret {value} for client {client_id} at path {path}.
        slots:
          value: requestBody.value
          client_id: path.client_id
          path: path.path
      - text: 'Save secret {path} for {client_id} expiring after {expire_after}: {value}.'
        slots:
          path: path.path
          client_id: path.client_id
          expire_after: requestBody.expire_after
          value: requestBody.value
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/secrets/{client_id}/{path}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a secret
      effect: destructive
      questions:
      - How do I delete a secret I stored for my client?
      - What happens to jobs once a secret is removed?
      instructions:
      - text: Delete secret {path} for client {client_id}.
        slots:
          path: path.path
          client_id: path.client_id
      - text: Remove the secret stored at {path} under client {client_id}.
        slots:
          path: path.path
          client_id: path.client_id
      method: generated
      generated: '2026-10-01'