# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Chef Automate API Documentation Secrets Service API
  version: 1.0.0
extends: openapi/progress-software-secretsservice-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['/api/v0/secrets'].post
  update:
    x-apievangelist-phrasing:
      intent: Store a new credential secret
      effect: write
      questions:
      - How do I save SSH credentials so compliance scans can log into nodes?
      - Which secret types are supported, like winrm, sudo or cloud keys?
      instructions:
      - text: Create a {type} secret named {name} with data {data}.
        slots:
          type: requestBody.type
          name: requestBody.name
          data: requestBody.data
      - text: Store new credentials {name} of type {type} tagged {tags}.
        slots:
          name: requestBody.name
          type: requestBody.type
          tags: requestBody.tags
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/secrets/id/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a secret's metadata
      effect: read
      questions:
      - Can I view a stored secret's name and type?
      - Will reading a secret return its password or key?
      instructions:
      - text: Get secret {id}.
        slots:
          id: path.id
      - text: Show the name, type and tags of credential {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/secrets/id/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a secret
      effect: destructive
      questions:
      - How do I delete stored credentials?
      - What happens to nodes that were using a secret after it's deleted?
      instructions:
      - text: Delete secret {id}.
        slots:
          id: path.id
      - text: Remove the stored credential {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/secrets/id/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update part of a secret
      effect: write
      questions:
      - How do I change just the password on a stored credential?
      - Do fields I leave out stay the same when I update a secret?
      instructions:
      - text: Update the data of secret {id} to {data}.
        slots:
          id: path.id
          data: requestBody.data
      - text: Rename secret {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/secrets/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search and list secrets
      effect: read
      questions:
      - Which credentials are stored, and can I filter them by type?
      - Can I sort my secrets by last modified?
      instructions:
      - text: List secrets matching filters {filters}.
        slots:
          filters: requestBody.filters
      - text: Show stored secrets sorted by {sort} in {order} order.
        slots:
          sort: requestBody.sort
          order: requestBody.order
      method: generated
      generated: '2026-10-01'