# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Project Secret API
  version: 1.0.0
extends: openapi/harness-project-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}/projects/{project}/secrets'].get
  update:
    x-apievangelist-phrasing:
      intent: List secrets in a project
      effect: read
      questions:
      - Which secrets are stored in my Harness project?
      - Can I filter project secrets by type or search by name?
      instructions:
      - text: List secrets in project {project} of org {org}.
        slots:
          project: path.project
          org: path.org
      - text: Search secrets of type {type} matching {term} in {org}/{project}.
        slots:
          type: query.type
          term: query.search_term
          org: path.org
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/secrets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a secret in a project
      effect: write
      questions:
      - How do I add a new secret to a project?
      - Can I upload a file as a project secret?
      instructions:
      - text: Create secret {secret} with spec {spec} in project {project} of org {org}.
        slots:
          secret: requestBody.secret
          spec: requestBody.spec
          project: path.project
          org: path.org
      - text: Upload file {file} as secret {secret} with spec {spec} in {org}/{project}.
        slots:
          file: requestBody.file
          secret: requestBody.secret
          spec: requestBody.spec
          org: path.org
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/secrets/validate-secret-ref'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a secret manager path can be referenced
      effect: read
      questions:
      - Can I verify a secret manager path is referenceable before I create a secret for it?
      - Is there a way to validate a secret reference in a project?
      instructions:
      - text: Validate that secret reference {secret} can be referenced in {org}/{project}.
        slots:
          secret: requestBody.secret
          org: path.org
          project: path.project
      - text: Check whether the secret manager path in {secret} is usable from project {project} of org {org}.
        slots:
          secret: requestBody.secret
          project: path.project
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/secrets/{secret}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one project secret's details
      effect: read
      questions:
      - What secret manager and type does a specific project secret use?
      - Can I retrieve a project secret's metadata by its identifier?
      instructions:
      - text: Get secret {secret} in project {project} of org {org}.
        slots:
          secret: path.secret
          project: path.project
          org: path.org
      - text: Show the metadata of project secret {secret} in {org}/{project}.
        slots:
          secret: path.secret
          org: path.org
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/secrets/{secret}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a project secret
      effect: write
      questions:
      - How do I rotate the value of an existing project secret?
      - Can I replace the file behind a file-type project secret?
      instructions:
      - text: Update project secret {id} in {org}/{project} with {secret} and spec {spec}.
        slots:
          id: path.secret
          org: path.org
          project: path.project
          secret: requestBody.secret
          spec: requestBody.spec
      - text: Replace the file of secret {id} in {org}/{project} with {file}, using {secret} and spec {spec}.
        slots:
          id: path.secret
          org: path.org
          project: path.project
          file: requestBody.file
          secret: requestBody.secret
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/secrets/{secret}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a project secret
      effect: destructive
      questions:
      - How do I remove a secret from a project?
      - Can a project secret be deleted by its identifier?
      instructions:
      - text: Delete secret {secret} from project {project} of org {org}.
        slots:
          secret: path.secret
          project: path.project
          org: path.org
      - text: Remove project secret {secret} from {org}/{project} permanently.
        slots:
          secret: path.secret
          org: path.org
          project: path.project
      method: generated
      generated: '2026-09-26'