Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Account Connector API

7 actions 7 updates phrasing extends openapi/harness-account-connector-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/connectors'].get

$.paths['/v1/connectors'].post

$.paths['/v1/connectors/{connector}'].get

$.paths['/v1/connectors/{connector}'].put

$.paths['/v1/connectors/{connector}'].delete

$.paths['/v1/connectors/{connector}/test-connection'].get

OpenAPI Overlay

# 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 Connector API
  version: 1.0.0
extends: openapi/harness-account-connector-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/connectors'].get
  update:
    x-apievangelist-phrasing:
      intent: List account-level connectors
      effect: read
      questions:
      - Which connectors are set up at the account level?
      - Can I include connectors from child orgs and projects in the list?
      instructions:
      - text: List my account connectors.
      - text: Search account connectors for {search}, including child scopes ({recursive}).
        slots:
          search: query.search_term
          recursive: query.recursive
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/connectors'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an account-level connector
      effect: write
      questions:
      - How do I add a new connector to my account?
      - Can I register a git or cloud connector that every project in the account can use?
      instructions:
      - text: Create account connector {connector}.
        slots:
          connector: requestBody.connector
      - text: 'Register a new account-scoped connector with this definition: {connector}.'
        slots:
          connector: requestBody.connector
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/connectors/{connector}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account-level connector
      effect: read
      questions:
      - What is configured on a particular account connector?
      - Can I look up an account connector by its identifier?
      instructions:
      - text: Get account connector {connector}.
        slots:
          connector: path.connector
      - text: Show the configuration of connector {connector}.
        slots:
          connector: path.connector
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/connectors/{connector}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an account-level connector
      effect: write
      questions:
      - How do I change the settings of an existing account connector?
      - Can I rotate the credentials an account connector references?
      instructions:
      - text: Update account connector {connector} with {definition}.
        slots:
          connector: path.connector
          definition: requestBody.connector
      - text: Replace connector {connector}'s configuration with {definition}.
        slots:
          connector: path.connector
          definition: requestBody.connector
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/connectors/{connector}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account-level connector
      effect: destructive
      questions:
      - How do I remove a connector from my account?
      - Will deleting an account connector break pipelines that use it?
      instructions:
      - text: Delete account connector {connector}.
        slots:
          connector: path.connector
      - text: Remove connector {connector} from the account.
        slots:
          connector: path.connector
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/connectors/{connector}/test-connection'].get
  update:
    x-apievangelist-phrasing:
      intent: Test an account connector's connection
      effect: read
      questions:
      - Is my account connector able to reach its target?
      - Can I check whether a connector's credentials still work?
      instructions:
      - text: Test the connection of connector {connector}.
        slots:
          connector: path.connector
      - text: Check that account connector {connector} can connect.
        slots:
          connector: path.connector
      method: generated
      generated: '2026-09-26'