Harness · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Harness Connectors API
17 actions
17 updates
phrasing
extends
openapi/harness-connectors-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.
What the actions change
x-apievangelist-phrasing
Targets 17 · first 16 shown; the file carries all of them
$.info
$.paths['/ng/api/connectors/ccmK8sList'].post
$.paths['/ng/api/connectors'].get
$.paths['/ng/api/connectors'].put
$.paths['/ng/api/connectors'].post
$.paths['/ng/api/connectors/{identifier}'].get
$.paths['/ng/api/connectors/{identifier}'].delete
$.paths['/ng/api/connectors/fieldValues'].get
$.paths['/ng/api/connectors/getceawstemplateurl'].post
$.paths['/ng/api/connectors/catalogue'].get
$.paths['/ng/api/connectors/stats'].get
$.paths['/ng/api/connectors/{connectorRef}/gcp-projects'].get
$.paths['/ng/api/connectors/listV2'].post
$.paths['/ng/api/connectors/listbyfqn'].post
$.paths['/ng/api/connectors/testConnection/{identifier}'].post
$.paths['/ng/api/connectors/testGitRepoConnection/{identifier}'].post
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 Connectors API
version: 1.0.0
extends: openapi/harness-connectors-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: 16
- target: $.paths['/ng/api/connectors/ccmK8sList'].post
update:
x-apievangelist-phrasing:
intent: List cloud cost Kubernetes connectors
effect: read
questions:
- Which Kubernetes connectors are set up for cloud cost management in my account?
- Can I filter my CCM Kubernetes connectors by connectivity status or tags?
instructions:
- text: List the CCM Kubernetes connectors in project {project}.
slots:
project: query.projectIdentifier
- text: Find cost-management Kubernetes connectors whose name matches {term}.
slots:
term: query.searchTerm
method: generated
generated: '2026-09-26'
- target: $.paths['/ng/api/connectors'].get
update:
x-apievangelist-phrasing:
intent: List connectors with simple filters
effect: read
questions:
- What connectors exist in my Harness project?
- Can I list only connectors of one type, like Git or cloud provider?
- Is there a way to page through connectors by category?
instructions:
- text: List connectors of type {type} in project {project}.
slots:
type: query.type
project: query.projectIdentifier
- text: Show connectors in category {category}, page {page}.
slots:
category: query.category
page: query.pageIndex
method: generated
generated: '2026-09-26'
- target: $.paths['/ng/api/connectors'].put
update:
x-apievangelist-phrasing:
intent: Update an existing connector
effect: write
questions:
- How do I change the credentials or settings of a connector I already created?
- Can I commit a connector change to a Git branch when it is stored in Git?
instructions:
- text: 'Update the connector with this definition: {connector}.'
slots:
connector: requestBody.connector
- text: Save the connector change {connector} to branch {branch} with commit message {message}.
slots:
connector: requestBody.connector
branch: query.branch
message: query.commitMsg
method: generated
generated: '2026-09-26'
- target: $.paths['/ng/api/connectors'].post
update:
x-apievangelist-phrasing:
intent: Create a new connector
effect: write
questions:
- How do I create a connector so Harness can reach my cloud, Git or artifact repository?
- Can a new connector's YAML be stored in a Git repository instead of Harness?
instructions:
- text: Create a new connector from {connector}.
slots:
connector: requestBody.connector
- text: Create connector {connector} and store it in repo {repo} on branch {branch}.
slots:
connector: requestBody.connector
repo: query.repoName
branch: query.branch
method: generated
generated: '2026-09-26'
- target: $.paths['/ng/api/connectors/{identifier}'].get
update:
x-apievangelist-phrasing:
intent: Get a connector's details
effect: read
questions:
- How do I see the configuration of one connector by its ID?
- What type and credentials reference does a specific connector use?
instructions:
- text: Get the details of connector {connector_id}.
slots:
connector_id: path.identifier
- text: Show connector {connector_id} in project {project}.
slots:
connector_id: path.identifier
project: query.projectIdentifier
method: generated
generated: '2026-09-26'
- target: $.paths['/ng/api/connectors/{identifier}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a connector
effect: destructive
questions:
- How do I delete a connector I no longer need?
- Can I force-delete a connector that other entities still reference?
instructions:
- text: Delete connector {connector_id}.
slots:
connector_id: path.identifier
- text: Force-delete connector {connector_id} from project {project}, force {force}.
slots:
connector_id: path.identifier
project: query.projectIdentifier
force: query.forceDelete
method: generated
generated: '2026-09-26'
- target: $.paths['/ng/api/connectors/fieldValues'].get
update:
x-apievangelist-phrasing:
intent: Get allowed field values for a connector type
effect: read
questions:
- What values can I pick for fields when creating a connector of a given type?
- Which auth types and options are allowed for a particular connector type?
instructions:
- text: List the allowed field values for connector type {type}.
slots:
type: query.connectorType
- text: Show which options I can set when creating a {type} connector.
slots:
type: query.connectorType
method: generated
generated: '2026-09-26'
- target: $.paths['/ng/api/connectors/getceawstemplateurl'].post
update:
x-apievangelist-phrasing:
intent: Get the AWS cost connector CloudFormation template URL
effect: read
questions:
- Where is the AWS CloudFormation template I need to set up a cloud cost connector?
- Can the AWS cost template include cost and usage reports and optimization permissions?
instructions:
- text: Get the AWS cost connector template URL with CUR enabled {cur}.
slots:
cur: query.curEnabled
- text: Fetch the AWS cost template URL with optimization {optimization} and events {events}.
slots:
optimization: query.optimizationEnabled
events: query.eventsEnabled
method: generated
generated: '2026-09-26'
- target: $.paths['/ng/api/connectors/catalogue'].get
update:
x-apievangelist-phrasing:
intent: Browse the catalogue of connector types
effect: read
questions:
- What kinds of connectors can I create in Harness?
- Which connector types are grouped under each category in the catalogue?
instructions:
- text: Show the connector catalogue for my account.
- text: List every connector type available to create, by category.
- text: Pull the catalogue of connector types available to account {account}.
slots:
account: query.accountIdentifier
method: generated
generated: '2026-09-26'
- target: $.paths['/ng/api/connectors/stats'].get
update:
x-apievangelist-phrasing:
intent: Get connector statistics
effect: read
questions:
- How many connectors do I have by type and by connection status?
- Can I see connector statistics scoped to one project?
instructions:
- text: Show connector statistics for project {project}.
slots:
project: query.projectIdentifier
- text: Give me connector counts by type and status for org {org}.
slots:
org: query.orgIdentifier
method: generated
generated: '2026-09-26'
- target: $.paths['/ng/api/connectors/{connectorRef}/gcp-projects'].get
update:
x-apievangelist-phrasing:
intent: List GCP projects a connector can access
effect: read
questions:
- Which GCP projects can my Google Cloud connector see?
- Can I check the GCP project IDs a connector has access to?
instructions:
- text: List the GCP projects reachable through connector {connector}.
slots:
connector: path.connectorRef
- text: Show GCP project IDs for connector {connector} in project {project}.
slots:
connector: path.connectorRef
project: query.projectIdentifier
method: generated
generated: '2026-09-26'
- target: $.paths['/ng/api/connectors/listV2'].post
update:
x-apievangelist-phrasing:
intent: Search connectors with advanced filter criteria
effect: read
questions:
- Can I find connectors by connectivity status, tags or category in one query?
- Is there a way to list only my favorite connectors?
- Which connectors are failing to connect right now?
instructions:
- text: Find connectors with connectivity status {statuses}.
slots:
statuses: requestBody.connectivityStatuses
- text: Filter connectors by types {types} and tags {tags}.
slots:
types: requestBody.types
tags: requestBody.tags
- text: 'List only my favorite connectors: favorites {favorites}.'
slots:
favorites: query.onlyFavorites
method: generated
generated: '2026-09-26'
- target: $.paths['/ng/api/connectors/listbyfqn'].post
update:
x-apievangelist-phrasing:
intent: Look up connectors by fully qualified name
effect: read
questions:
- Can I resolve a batch of connector fully qualified names to connectors?
- How many FQNs can I look up in one connector request?
instructions:
- text: Look up these connectors by their fully qualified names.
- text: Resolve my list of connector FQNs to connector records.
- text: Resolve connector FQNs within account {account}.
slots:
account: query.accountIdentifier
method: generated
generated: '2026-09-26'
- target: $.paths['/ng/api/connectors/testConnection/{identifier}'].post
update:
x-apievangelist-phrasing:
intent: Test a connector's connection
effect: read
questions:
- How do I check that a connector can actually reach the third-party tool?
- Why would a connector show as disconnected, and can I retest it?
instructions:
- text: Test the connection for connector {connector_id}.
slots:
connector_id: path.identifier
- text: Re-run the connectivity test on connector {connector_id} in project {project}.
slots:
connector_id: path.identifier
project: query.projectIdentifier
method: generated
generated: '2026-09-26'
- target: $.paths['/ng/api/connectors/testGitRepoConnection/{identifier}'].post
update:
x-apievangelist-phrasing:
intent: Test a Git connector against a repository
effect: read
questions:
- Can my Git connector reach a specific repository URL?
- How do I verify a Git connector syncs with one repo before using it?
instructions:
- text: Test Git connector {connector_id} against repo {repo_url}.
slots:
connector_id: path.identifier
repo_url: query.repoURL
- text: Check that Git connector {connector_id} can sync with its repository.
slots:
connector_id: path.identifier
method: generated
generated: '2026-09-26'
- target: $.paths['/ng/api/connectors/validateUniqueIdentifier'].get
update:
x-apievangelist-phrasing:
intent: Check whether a connector identifier is free
effect: read
questions:
- Is a connector identifier already taken in my project?
- Can I check an ID is unique before creating a connector?
instructions:
- text: Check if connector identifier {identifier} is unique.
slots:
identifier: query.identifier
- text: Verify no connector in project {project} already uses ID {identifier}.
slots:
project: query.projectIdentifier
identifier: query.identifier
method: generated
generated: '2026-09-26'