Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Proxy API

6 actions 6 updates phrasing extends openapi/harness-proxy-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 6

$.info
$.paths['/cf/admin/proxy/keys'].get
$.paths['/cf/admin/proxy/keys'].post
$.paths['/cf/admin/proxy/keys/{identifier}'].get
$.paths['/cf/admin/proxy/keys/{identifier}'].delete
$.paths['/cf/admin/proxy/keys/{identifier}'].patch

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 Proxy API
  version: 1.0.0
extends: openapi/harness-proxy-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: 5
- target: $.paths['/cf/admin/proxy/keys'].get
  update:
    x-apievangelist-phrasing:
      intent: List Relay Proxy keys
      effect: read
      questions:
      - What feature flag Relay Proxy keys exist in my account?
      - Can I find a proxy key by name?
      instructions:
      - text: List the proxy keys in account {accountIdentifier}.
        slots:
          accountIdentifier: query.accountIdentifier
      - text: Find proxy keys named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cf/admin/proxy/keys'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Relay Proxy key
      effect: write
      questions:
      - How do I create a key for the feature flags Relay Proxy?
      - Which organizations and environments can a new proxy key access?
      instructions:
      - text: Create proxy key {identifier} named {name} for organizations {organizations}.
        slots:
          identifier: requestBody.identifier
          name: requestBody.name
          organizations: requestBody.organizations
      - text: Create proxy key {name} ({identifier}) with access to {organizations} and description {description}.
        slots:
          name: requestBody.name
          identifier: requestBody.identifier
          organizations: requestBody.organizations
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cf/admin/proxy/keys/{identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Relay Proxy key
      effect: read
      questions:
      - What environments does a specific proxy key have access to?
      - Can I look up one proxy key by identifier?
      instructions:
      - text: Show proxy key {identifier}.
        slots:
          identifier: path.identifier
      - text: Get the details of proxy key {identifier}.
        slots:
          identifier: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cf/admin/proxy/keys/{identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Relay Proxy key
      effect: destructive
      questions:
      - How do I revoke a Relay Proxy key?
      - Will deleting a proxy key cut off the proxy using it?
      instructions:
      - text: Delete proxy key {identifier}.
        slots:
          identifier: path.identifier
      - text: Revoke proxy key {identifier}.
        slots:
          identifier: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cf/admin/proxy/keys/{identifier}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change which environments a proxy key can access
      effect: write
      questions:
      - Can I give a proxy key access to more environments?
      - How do I unassign an environment from a proxy key?
      instructions:
      - text: Update environment access on proxy key {identifier} with instructions {instructions}.
        slots:
          identifier: path.identifier
          instructions: requestBody.instructions
      - text: Unassign environments from proxy key {identifier}.
        slots:
          identifier: path.identifier
      method: generated
      generated: '2026-09-26'