Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Integration API

10 actions 10 updates phrasing extends openapi/harness-integration-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 10

$.info
$.paths['/gateway/ssca-manager/v1/orgs/{org}/projects/{project}/integration/integration-summary'].get
$.paths['/gateway/ssca-manager/v1/orgs/{org}/projects/{project}/integration'].get
$.paths['/gateway/ssca-manager/v1/orgs/{org}/projects/{project}/integration'].post
$.paths['/v1/orgs/{org}/projects/{project}/integration/{integration}/fetch-repos'].get
$.paths['/gateway/ssca-manager/v1/orgs/{org}/projects/{project}/integration/{integration}/repos'].get
$.paths['/gateway/ssca-manager/v1/orgs/{org}/projects/{project}/integration/{integration}/repos'].post
$.paths['/gateway/ssca-manager/v1/orgs/{org}/projects/{project}/integration/{integration}/repos'].patch
$.paths['/gateway/ssca-manager/v1/orgs/{org}/projects/{project}/integration/{integration}'].delete
$.paths['/v1/orgs/{org}/projects/{project}/integration/harness-pipeline'].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 Integration API
  version: 1.0.0
extends: openapi/harness-integration-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: 9
- target: $.paths['/gateway/ssca-manager/v1/orgs/{org}/projects/{project}/integration/integration-summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Find an integration ID by GitHub org URL
      effect: read
      questions:
      - What's the integration ID for my GitHub organization?
      - Can I look up a supply chain integration from a GitHub org URL?
      instructions:
      - text: Get the integration for GitHub org {github_org_url} in org {org} project {project}.
        slots:
          github_org_url: query.github_org_url
          org: path.org
          project: path.project
      - text: Find the integration summary in project {project}.
        slots:
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/ssca-manager/v1/orgs/{org}/projects/{project}/integration'].get
  update:
    x-apievangelist-phrasing:
      intent: List supply chain integrations
      effect: read
      questions:
      - What source code integrations are set up in my project?
      - Can I filter integrations by status?
      instructions:
      - text: List integrations in org {org} project {project}.
        slots:
          org: path.org
          project: path.project
      - text: List integrations with status {status} in project {project}.
        slots:
          status: query.status
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/ssca-manager/v1/orgs/{org}/projects/{project}/integration'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a supply chain integration
      effect: write
      questions:
      - How do I connect a GitHub app installation as an integration?
      - Can I create an integration from an existing connector?
      instructions:
      - text: Create a {type} integration for installation {installation_id} in org {org} project {project}.
        slots:
          type: requestBody.type
          installation_id: requestBody.installation_id
          org: path.org
          project: path.project
      - text: Create an integration using connector {connector_id} in project {project}.
        slots:
          connector_id: requestBody.connector_id
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/integration/{integration}/fetch-repos'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch all repos visible to a GitHub app integration
      effect: read
      questions:
      - Which repositories can the GitHub app see through this integration?
      - Can I search the repos available to an integration before configuring them?
      instructions:
      - text: Fetch the repos available to integration {integration} in org {org} project {project}.
        slots:
          integration: path.integration
          org: path.org
          project: path.project
      - text: Search repos visible to integration {integration} for {search_term}.
        slots:
          integration: path.integration
          search_term: query.search_term
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/ssca-manager/v1/orgs/{org}/projects/{project}/integration/{integration}/repos'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the repos configured in an integration
      effect: read
      questions:
      - Which repos have already been configured in an integration?
      - What repositories is this integration scanning?
      instructions:
      - text: Show the configured repos for integration {integration} in org {org} project {project}.
        slots:
          integration: path.integration
          org: path.org
          project: path.project
      - text: List repos already set up in integration {integration}.
        slots:
          integration: path.integration
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/ssca-manager/v1/orgs/{org}/projects/{project}/integration/{integration}/repos'].post
  update:
    x-apievangelist-phrasing:
      intent: Set the repos an integration covers
      effect: write
      questions:
      - How do I choose exactly which repositories an integration covers?
      - Can I configure an integration to include all repos?
      instructions:
      - text: Configure integration {integration} in org {org} project {project} to cover repos {repositories}.
        slots:
          integration: path.integration
          org: path.org
          project: path.project
          repositories: requestBody.repositories
      - text: 'Set integration {integration} to include all repos: {include_all_repos}.'
        slots:
          integration: path.integration
          include_all_repos: requestBody.include_all_repos
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/ssca-manager/v1/orgs/{org}/projects/{project}/integration/{integration}/repos'].patch
  update:
    x-apievangelist-phrasing:
      intent: Add more repos to an integration
      effect: write
      questions:
      - Can I add repositories to an integration without replacing the existing ones?
      - How do I append a repo to an already configured integration?
      instructions:
      - text: Add repos {repositories} to integration {integration} in org {org} project {project}.
        slots:
          repositories: requestBody.repositories
          integration: path.integration
          org: path.org
          project: path.project
      - text: Append repos {repositories} to integration {integration}.
        slots:
          repositories: requestBody.repositories
          integration: path.integration
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/ssca-manager/v1/orgs/{org}/projects/{project}/integration/{integration}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a supply chain integration
      effect: destructive
      questions:
      - How do I remove an integration from a project?
      - Can I disconnect a GitHub integration permanently?
      instructions:
      - text: Delete integration {integration} in org {org} project {project}.
        slots:
          integration: path.integration
          org: path.org
          project: path.project
      - text: Remove integration {integration}.
        slots:
          integration: path.integration
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/integration/harness-pipeline'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Harness pipeline integration
      effect: read
      questions:
      - Is the Harness pipeline integration set up for my project?
      - Where can I see the pipeline integration details for a project?
      instructions:
      - text: Get the Harness pipeline integration in org {org} project {project}.
        slots:
          org: path.org
          project: path.project
      - text: Show the pipeline integration for project {project}.
        slots:
          project: path.project
      method: generated
      generated: '2026-09-26'