Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Provider API

6 actions 6 updates phrasing extends openapi/harness-provider-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['/ng/api/provider'].get
$.paths['/ng/api/provider'].post
$.paths['/ng/api/provider/{providerIdentifier}'].get
$.paths['/ng/api/provider/{providerIdentifier}'].put
$.paths['/ng/api/provider/{providerIdentifier}'].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 Provider API
  version: 1.0.0
extends: openapi/harness-provider-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['/ng/api/provider'].get
  update:
    x-apievangelist-phrasing:
      intent: List providers in the account
      effect: read
      questions:
      - Which providers are configured in my account?
      - Is there a list of every provider defined at account level?
      instructions:
      - text: List all providers in account {accountIdentifier}.
        slots:
          accountIdentifier: query.accountIdentifier
      - text: Show the provider configurations for {accountIdentifier}.
        slots:
          accountIdentifier: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/provider'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a provider
      effect: write
      questions:
      - How do I add a new provider configuration to my account?
      - Can I set a provider's spec when I first create it?
      instructions:
      - text: Create provider {identifier} named {name} in account {accountIdentifier}.
        slots:
          identifier: requestBody.identifier
          name: requestBody.name
          accountIdentifier: query.accountIdentifier
      - text: Add a provider called {name} with spec {spec} and description {description}.
        slots:
          name: requestBody.name
          spec: requestBody.spec
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/provider/{providerIdentifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a provider by identifier
      effect: read
      questions:
      - How do I look up one provider's configuration by its identifier?
      - What spec is set on a particular provider?
      instructions:
      - text: Get provider {providerIdentifier} in account {accountIdentifier}.
        slots:
          providerIdentifier: path.providerIdentifier
          accountIdentifier: query.accountIdentifier
      - text: Show the details of provider {providerIdentifier}.
        slots:
          providerIdentifier: path.providerIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/provider/{providerIdentifier}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a provider
      effect: write
      questions:
      - Can I change the spec of a provider that's already configured?
      - How do I rename an existing provider?
      instructions:
      - text: Update provider {providerIdentifier} with spec {spec}.
        slots:
          providerIdentifier: path.providerIdentifier
          spec: requestBody.spec
      - text: Rename existing provider {providerIdentifier} to {name}.
        slots:
          providerIdentifier: path.providerIdentifier
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/provider/{providerIdentifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a provider
      effect: destructive
      questions:
      - How do I remove a provider I no longer use?
      - Can I delete a provider by its identifier?
      instructions:
      - text: Delete provider {providerIdentifier} from account {accountIdentifier}.
        slots:
          providerIdentifier: path.providerIdentifier
          accountIdentifier: query.accountIdentifier
      - text: Remove the {providerIdentifier} provider.
        slots:
          providerIdentifier: path.providerIdentifier
      method: generated
      generated: '2026-09-26'