# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Authentication API v1.1 Secret Management API
  version: 1.0.0
extends: openapi/here-secret-management-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: 7
- target: $.paths['/secrets'].get
  update:
    x-apievangelist-phrasing:
      intent: List my stored secrets
      effect: read
      questions:
      - What secrets have I stored for use in platform pipelines?
      - Can my app see the secrets it owns?
      instructions:
      - text: List my secrets.
      - text: Show up to {limit} of my stored secrets.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/secrets'].post
  update:
    x-apievangelist-phrasing:
      intent: Store a new secret for platform runtimes
      effect: write
      questions:
      - How do I store third-party credentials such as AWS keys for my pipelines to use?
      - How many secrets can one user or app keep at a time?
      - Can I set an expiry date on a secret when I create it?
      instructions:
      - text: Create an {type} secret with id {id} from contents {secret}.
        slots:
          type: requestBody.type
          id: requestBody.id
          secret: requestBody.secret
      - text: Store secret {id} of type {type} with contents {secret}, expiring {expires}.
        slots:
          id: requestBody.id
          type: requestBody.type
          secret: requestBody.secret
          expires: requestBody.expires
      method: generated
      generated: '2026-09-26'
- target: $.paths['/secrets/{secret}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a secret
      effect: read
      questions:
      - What are the settings of one stored secret?
      - Can I check whether a secret is enabled and when it expires?
      instructions:
      - text: Show secret {secret}.
        slots:
          secret: path.secret
      - text: Tell me when secret {secret} expires and whether it is enabled.
        slots:
          secret: path.secret
      method: generated
      generated: '2026-09-26'
- target: $.paths['/secrets/{secret}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a secret permanently
      effect: destructive
      questions:
      - How do I permanently delete a secret?
      - Can a deleted secret be recovered?
      instructions:
      - text: Delete secret {secret}.
        slots:
          secret: path.secret
      - text: Permanently remove stored secret {secret}.
        slots:
          secret: path.secret
      method: generated
      generated: '2026-09-26'
- target: $.paths['/secrets/{secret}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a secret's contents or settings
      effect: write
      questions:
      - How do I rotate the contents of a secret I already stored?
      - Can I change a secret's expiry date or filename?
      instructions:
      - text: Replace the contents of secret {secret} with {newContents}.
        slots:
          secret: path.secret
          newContents: requestBody.secret
      - text: Change secret {secret} to expire at {expires}.
        slots:
          secret: path.secret
          expires: requestBody.expires
      method: generated
      generated: '2026-09-26'
- target: $.paths['/secrets/{secret}/enable'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable a secret
      effect: write
      questions:
      - How do I turn a disabled secret back on?
      - Can I re-enable a secret without re-uploading it?
      instructions:
      - text: Enable secret {secret}.
        slots:
          secret: path.secret
      - text: Turn disabled secret {secret} back on.
        slots:
          secret: path.secret
      method: generated
      generated: '2026-09-26'
- target: $.paths['/secrets/{secret}/disable'].post
  update:
    x-apievangelist-phrasing:
      intent: Disable a secret
      effect: write
      questions:
      - How do I temporarily stop a secret being used without deleting it?
      - Can I switch a secret off and keep it for later?
      instructions:
      - text: Disable secret {secret}.
        slots:
          secret: path.secret
      - text: Switch off secret {secret} but keep it stored.
        slots:
          secret: path.secret
      method: generated
      generated: '2026-09-26'