Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Org Connector API

7 actions 7 updates phrasing extends openapi/harness-org-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/orgs/{org}/connectors'].get

$.paths['/v1/orgs/{org}/connectors'].post

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

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

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

$.paths['/v1/orgs/{org}/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 Org Connector API
  version: 1.0.0
extends: openapi/harness-org-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/orgs/{org}/connectors'].get
  update:
    x-apievangelist-phrasing:
      intent: List connectors in an organization
      effect: read
      questions:
      - What connectors are set up at the organization level?
      - Can I include connectors from child projects when listing an org's connectors?
      instructions:
      - text: List connectors in org {org}.
        slots:
          org: path.org
      - text: Search org {org} connectors for {search_term}.
        slots:
          org: path.org
          search_term: query.search_term
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/connectors'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an organization connector
      effect: write
      questions:
      - How do I add a new connector at the org level?
      - What does a connector definition need when creating one for an org?
      instructions:
      - text: Create connector {connector} in org {org}.
        slots:
          connector: requestBody.connector
          org: path.org
      - text: 'Add this new connector definition to organization {org}: {connector}'
        slots:
          org: path.org
          connector: requestBody.connector
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/connectors/{connector}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization connector
      effect: read
      questions:
      - What is configured on a specific org-level connector?
      - Which connector types can be retrieved this way?
      instructions:
      - text: Get connector {connector} in org {org}.
        slots:
          connector: path.connector
          org: path.org
      - text: Show the settings of org {org} connector {connector}.
        slots:
          org: path.org
          connector: path.connector
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/connectors/{connector}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an organization connector
      effect: write
      questions:
      - How do I change the settings of an existing org connector?
      - Can I replace a connector's configuration at the org level?
      instructions:
      - text: Update connector {connector} in org {org} with the new definition {body}.
        slots:
          connector: path.connector
          org: path.org
          body: requestBody.connector
      - text: Replace the configuration of org {org} connector {connector}.
        slots:
          org: path.org
          connector: path.connector
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/connectors/{connector}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an organization connector
      effect: destructive
      questions:
      - How do I delete a connector from an organization?
      - Can I remove an org-level Git connector nobody uses?
      instructions:
      - text: Delete connector {connector} from org {org}.
        slots:
          connector: path.connector
          org: path.org
      - text: Remove the org {org} connector named {connector}.
        slots:
          org: path.org
          connector: path.connector
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/connectors/{connector}/test-connection'].get
  update:
    x-apievangelist-phrasing:
      intent: Test an organization connector's connection
      effect: read
      questions:
      - Is my org-level connector able to connect right now?
      - How do I check an org connector's credentials still work?
      instructions:
      - text: Test the connection of connector {connector} in org {org}.
        slots:
          connector: path.connector
          org: path.org
      - text: Check connectivity for org {org} connector {connector}.
        slots:
          org: path.org
          connector: path.connector
      method: generated
      generated: '2026-09-26'