Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Project Connector API

7 actions 7 updates phrasing extends openapi/harness-project-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}/projects/{project}/connectors'].get
$.paths['/v1/orgs/{org}/projects/{project}/connectors'].post
$.paths['/v1/orgs/{org}/projects/{project}/connectors/{connector}'].get
$.paths['/v1/orgs/{org}/projects/{project}/connectors/{connector}'].put
$.paths['/v1/orgs/{org}/projects/{project}/connectors/{connector}'].delete
$.paths['/v1/orgs/{org}/projects/{project}/connectors/{connector}/test-connection'].get

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 Project Connector API
  version: 1.0.0
extends: openapi/harness-project-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}/projects/{project}/connectors'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's connectors
      effect: read
      questions:
      - Which connectors are configured in my project?
      - Can I include connectors inherited from the org and account when listing a project's?
      instructions:
      - text: List the connectors in project {project} of org {org}.
        slots:
          project: path.project
          org: path.org
      - text: Search project {project} connectors in org {org} for {search_term}.
        slots:
          project: path.project
          org: path.org
          search_term: query.search_term
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/connectors'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a connector in a project
      effect: write
      questions:
      - How do I add a Git or Artifactory connector to a project?
      - What does creating a project-level connector require?
      instructions:
      - text: Create connector {connector} in project {project} of org {org}.
        slots:
          connector: requestBody.connector
          project: path.project
          org: path.org
      - text: Add a new project-scoped connector to {project} under {org} with definition {connector}.
        slots:
          project: path.project
          org: path.org
          connector: requestBody.connector
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/connectors/{connector}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a project connector
      effect: read
      questions:
      - What settings does a particular project connector have?
      - Which connector types can be retrieved at project scope?
      instructions:
      - text: Show connector {connector} in project {project} of org {org}.
        slots:
          connector: path.connector
          project: path.project
          org: path.org
      - text: Get the details of project {project} connector {connector} under {org}.
        slots:
          project: path.project
          connector: path.connector
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/connectors/{connector}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a project connector
      effect: write
      questions:
      - Can I change the credentials or URL on a project connector?
      - How do I edit an existing connector inside a project?
      instructions:
      - text: Update connector {connector_id} in project {project} of org {org} with {connector}.
        slots:
          connector_id: path.connector
          project: path.project
          org: path.org
          connector: requestBody.connector
      - text: Save new settings {connector} to project {project} connector {connector_id} in {org}.
        slots:
          connector: requestBody.connector
          project: path.project
          connector_id: path.connector
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/connectors/{connector}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a project connector
      effect: destructive
      questions:
      - How do I remove a connector from a project?
      - Is deleting a project connector permanent?
      instructions:
      - text: Delete connector {connector} from project {project} in org {org}.
        slots:
          connector: path.connector
          project: path.project
          org: path.org
      - text: Remove project {project}'s connector {connector} under {org}.
        slots:
          project: path.project
          connector: path.connector
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/connectors/{connector}/test-connection'].get
  update:
    x-apievangelist-phrasing:
      intent: Test a project connector's connection
      effect: read
      questions:
      - Is my project connector actually able to connect?
      - Can I verify a connector's credentials without running a pipeline?
      instructions:
      - text: Test the connection of connector {connector} in project {project} of org {org}.
        slots:
          connector: path.connector
          project: path.project
          org: path.org
      - text: Check whether project {project} connector {connector} in {org} can reach its target.
        slots:
          project: path.project
          connector: path.connector
          org: path.org
      method: generated
      generated: '2026-09-26'