# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Org Secret API
  version: 1.0.0
extends: openapi/harness-org-secret-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: 6
- target: $.paths['/v1/orgs/{org}/secrets'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's secrets
      effect: read
      questions:
      - Which secrets are defined in my organization?
      - Can I include secrets from projects under the org in the list?
      instructions:
      - text: List secrets in org {org}.
        slots:
          org: path.org
      - text: Search org {org} secrets for {term} of type {type}.
        slots:
          org: path.org
          term: query.search_term
          type: query.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/secrets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a secret in an organization
      effect: write
      questions:
      - How do I add a new secret at the organization level?
      - Can I upload a file as an org-scoped secret?
      instructions:
      - text: Create secret {secret} in org {org}.
        slots:
          secret: requestBody.secret
          org: path.org
      - text: Create a file secret in org {org} from {file}.
        slots:
          org: path.org
          file: requestBody.file
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/secrets/validate-secret-ref'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a secret manager path can be referenced
      effect: read
      questions:
      - Can I confirm a secret in my external secret manager is referenceable before saving it?
      - Is there a way to validate a secret reference path at the org level?
      instructions:
      - text: Validate that secret reference {secret} can be used in org {org}.
        slots:
          secret: requestBody.secret
          org: path.org
      - text: Check org {org} can reference secret manager path {secret}.
        slots:
          secret: requestBody.secret
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/secrets/{secret}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one organization secret
      effect: read
      questions:
      - What are the details of one secret in my organization?
      - Can I see the type and settings of an org secret by its identifier?
      instructions:
      - text: Get secret {secret} in org {org}.
        slots:
          secret: path.secret
          org: path.org
      - text: Show details of org {org} secret {secret}.
        slots:
          secret: path.secret
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/secrets/{secret}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an organization secret
      effect: write
      questions:
      - How do I rotate the value of an org-level secret?
      - Can I change an existing organization secret's settings?
      instructions:
      - text: Update secret {secret} in org {org} with spec {spec}.
        slots:
          secret: path.secret
          org: path.org
          spec: requestBody.spec
      - text: Rotate org {org} secret {secret} using file {file}.
        slots:
          secret: path.secret
          org: path.org
          file: requestBody.file
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/secrets/{secret}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an organization secret
      effect: destructive
      questions:
      - What's the way to remove a secret from my organization?
      - Can an org-level secret be deleted by its identifier?
      instructions:
      - text: Delete secret {secret} from org {org}.
        slots:
          secret: path.secret
          org: path.org
      - text: Remove org {org} secret {secret} permanently.
        slots:
          secret: path.secret
          org: path.org
      method: generated
      generated: '2026-09-26'