Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Account Secret API

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

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/v1/secrets'].get
$.paths['/v1/secrets'].post
$.paths['/v1/secrets/validate-secret-ref'].post
$.paths['/v1/secrets/{secret}'].get
$.paths['/v1/secrets/{secret}'].put
$.paths['/v1/secrets/{secret}'].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 Harness Account Secret API
  version: 1.0.0
extends: openapi/harness-account-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/secrets'].get
  update:
    x-apievangelist-phrasing:
      intent: List account-level secrets
      effect: read
      questions:
      - Which secrets are stored at the account level in Harness?
      - Can I filter account secrets by type or search them by name?
      instructions:
      - text: List all account-level secrets.
      - text: Find account secrets of type {type} matching {term}.
        slots:
          type: query.type
          term: query.search_term
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/secrets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an account-level secret
      effect: write
      questions:
      - How do I store a new text or file secret at the account scope?
      - Can I create a private account secret that only I can see?
      instructions:
      - text: Create account secret {secret} with spec {spec}.
        slots:
          secret: requestBody.secret
          spec: requestBody.spec
      - text: Upload file {file} as a new account-level secret {secret}.
        slots:
          file: requestBody.file
          secret: requestBody.secret
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/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 exists at a secret manager path before referencing it?
      - Will my account be able to reference this external secret path?
      instructions:
      - text: Validate that secret reference {secret} can be resolved.
        slots:
          secret: requestBody.secret
      - text: Check whether the secret manager path in {secret} is referenceable.
        slots:
          secret: requestBody.secret
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/secrets/{secret}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account-level secret
      effect: read
      questions:
      - What type and secret manager does an account secret use?
      - Can I look up one account-level secret's details by identifier?
      instructions:
      - text: Show account secret {secret}.
        slots:
          secret: path.secret
      - text: Get the details of account-level secret {secret}.
        slots:
          secret: path.secret
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/secrets/{secret}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an account-level secret
      effect: write
      questions:
      - How do I rotate the value of an existing account secret?
      - Can I replace the file behind an account-level file secret?
      instructions:
      - text: Update account secret {secret} with spec {spec}.
        slots:
          secret: path.secret
          spec: requestBody.spec
      - text: Replace the file of existing account secret {secret} with {file}.
        slots:
          secret: path.secret
          file: requestBody.file
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/secrets/{secret}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account-level secret
      effect: destructive
      questions:
      - How do I permanently remove a secret stored at the account level?
      - Can I delete an account secret by its identifier?
      instructions:
      - text: Delete account secret {secret}.
        slots:
          secret: path.secret
      - text: Remove the account-level secret {secret}.
        slots:
          secret: path.secret
      method: generated
      generated: '2026-09-26'