Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Repositories API

25 actions 25 updates phrasing extends openapi/harness-repositories-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 25 · first 16 shown; the file carries all of them

$.info
$.paths['/gitops/api/v1/agents/{agentIdentifier}/repositories'].get
$.paths['/gitops/api/v1/agents/{agentIdentifier}/repositories'].post
$.paths['/gitops/api/v1/agents/{agentIdentifier}/repositories/eso/check'].get
$.paths['/gitops/api/v1/agents/{agentIdentifier}/repositories/eso/generators'].get
$.paths['/gitops/api/v1/agents/{agentIdentifier}/repositories/oci/type'].post
$.paths['/gitops/api/v1/agents/{agentIdentifier}/repositories/validate'].post
$.paths['/gitops/api/v1/agents/{agentIdentifier}/repositories/{identifier}'].get
$.paths['/gitops/api/v1/agents/{agentIdentifier}/repositories/{identifier}'].put
$.paths['/gitops/api/v1/agents/{agentIdentifier}/repositories/{identifier}'].delete
$.paths['/gitops/api/v1/agents/{agentIdentifier}/repositories/{identifier}/appdetails'].get
$.paths['/gitops/api/v1/agents/{agentIdentifier}/repositories/{identifier}/apps'].get
$.paths['/gitops/api/v1/agents/{agentIdentifier}/repositories/{identifier}/helmcharts'].get
$.paths['/gitops/api/v1/agents/{agentIdentifier}/repositories/{identifier}/refs'].get
$.paths['/gitops/api/v1/agents/{agentIdentifier}/repositories_byurl/appdetails'].get
$.paths['/gitops/api/v1/agents/{agentIdentifier}/repositories_byurl/apps'].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 Repositories API
  version: 1.0.0
extends: openapi/harness-repositories-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: 24
- target: $.paths['/gitops/api/v1/agents/{agentIdentifier}/repositories'].get
  update:
    x-apievangelist-phrasing:
      intent: List repositories configured on a GitOps agent
      effect: read
      questions:
      - Which Git repositories are connected to my Harness GitOps agent?
      - Can I force a refresh when listing the repos an agent knows about?
      instructions:
      - text: List every repository configured on GitOps agent {agentIdentifier}.
        slots:
          agentIdentifier: path.agentIdentifier
      - text: Show the repos registered on agent {agentIdentifier} in project {projectIdentifier}.
        slots:
          agentIdentifier: path.agentIdentifier
          projectIdentifier: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/agents/{agentIdentifier}/repositories'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a repository to a GitOps agent
      effect: write
      questions:
      - How do I register a new Git or Helm repository with a GitOps agent?
      - Can I upsert a repository config so an existing one gets overwritten?
      instructions:
      - text: Add repository {repo} to GitOps agent {agentIdentifier}.
        slots:
          repo: requestBody.repo
          agentIdentifier: path.agentIdentifier
      - text: Create repo config {identifier} on agent {agentIdentifier} using credential template {repoCredsId}.
        slots:
          identifier: query.identifier
          agentIdentifier: path.agentIdentifier
          repoCredsId: query.repoCredsId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/agents/{agentIdentifier}/repositories/eso/check'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if External Secrets Operator is installed
      effect: read
      questions:
      - Is External Secrets Operator installed where my GitOps agent runs?
      - What does the ESO install check report for a GitOps agent?
      instructions:
      - text: Check whether External Secrets Operator is installed for agent {agentIdentifier}.
        slots:
          agentIdentifier: path.agentIdentifier
      - text: Verify ESO is present in the cluster of GitOps agent {agentIdentifier}.
        slots:
          agentIdentifier: path.agentIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/agents/{agentIdentifier}/repositories/eso/generators'].get
  update:
    x-apievangelist-phrasing:
      intent: List ESO generators in an agent namespace
      effect: read
      questions:
      - Which External Secrets generators are installed in my GitOps agent's namespace?
      - Can I filter ESO generators by type or name?
      instructions:
      - text: List the ESO generators installed in the namespace of agent {agentIdentifier}.
        slots:
          agentIdentifier: path.agentIdentifier
      - text: Show ESO generators of type {type} for GitOps agent {agentIdentifier}.
        slots:
          type: query.type
          agentIdentifier: path.agentIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/agents/{agentIdentifier}/repositories/oci/type'].post
  update:
    x-apievangelist-phrasing:
      intent: Detect the repository type of an OCI repo
      effect: read
      questions:
      - What kind of repository is behind this OCI URL?
      - Can a GitOps agent tell me the repo type of an OCI registry address?
      instructions:
      - text: Determine the repository type of OCI repo {repoURL} via agent {agentIdentifier}.
        slots:
          repoURL: requestBody.repoURL
          agentIdentifier: path.agentIdentifier
      - text: Ask agent {agentIdentifier} to classify the OCI repository at {repoURL}.
        slots:
          agentIdentifier: path.agentIdentifier
          repoURL: requestBody.repoURL
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/agents/{agentIdentifier}/repositories/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate connection access to a repository
      effect: read
      questions:
      - Can my GitOps agent actually connect to this repo with these credentials?
      - How do I test SSH key or GitHub App access to a repository before saving it?
      instructions:
      - text: Validate that agent {agentIdentifier} can reach repository {repo} with username {username}.
        slots:
          agentIdentifier: path.agentIdentifier
          repo: requestBody.repo
          username: requestBody.username
      - text: Test the connection state of repo {repo} from GitOps agent {agentIdentifier}.
        slots:
          repo: requestBody.repo
          agentIdentifier: path.agentIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/agents/{agentIdentifier}/repositories/{identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a GitOps repository or its credentials
      effect: read
      questions:
      - What is configured for a specific repository on my GitOps agent?
      - Can I fetch one agent repository's details by its identifier?
      instructions:
      - text: Get repository {identifier} from GitOps agent {agentIdentifier}.
        slots:
          identifier: path.identifier
          agentIdentifier: path.agentIdentifier
      - text: Show the configuration of repo {identifier} on agent {agentIdentifier}.
        slots:
          identifier: path.identifier
          agentIdentifier: path.agentIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/agents/{agentIdentifier}/repositories/{identifier}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a repository configuration on an agent
      effect: write
      questions:
      - How do I change the settings of a repo already registered on a GitOps agent?
      - Can I change the refresh interval of an existing agent repository?
      instructions:
      - text: Update repository {identifier} on agent {agentIdentifier} with new config {repo}.
        slots:
          identifier: path.identifier
          agentIdentifier: path.agentIdentifier
          repo: requestBody.repo
      - text: Set the refresh interval of repo {identifier} on agent {agentIdentifier} to {refreshInterval}.
        slots:
          identifier: path.identifier
          agentIdentifier: path.agentIdentifier
          refreshInterval: requestBody.refreshInterval
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/agents/{agentIdentifier}/repositories/{identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a repository from a GitOps agent
      effect: destructive
      questions:
      - How do I remove a repository from my GitOps agent's configuration?
      - Is there a force option when deleting an agent repository?
      instructions:
      - text: Delete repository {identifier} from GitOps agent {agentIdentifier}.
        slots:
          identifier: path.identifier
          agentIdentifier: path.agentIdentifier
      - text: Force-remove repo {identifier} from agent {agentIdentifier}.
        slots:
          identifier: path.identifier
          agentIdentifier: path.agentIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/agents/{agentIdentifier}/repositories/{identifier}/appdetails'].get
  update:
    x-apievangelist-phrasing:
      intent: Get app details at a path in an agent repository
      effect: read
      questions:
      - What application does a given path in my registered GitOps repo define?
      - Can I see the Helm or Kustomize details of an app inside a repo by its identifier?
      instructions:
      - text: Get the application details at path {path} in repository {identifier} on agent {agentIdentifier}.
        slots:
          path: query.query.source.path
          identifier: path.identifier
          agentIdentifier: path.agentIdentifier
      - text: Show app details for revision {revision} of registered repo {identifier} via agent {agentIdentifier}.
        slots:
          revision: query.query.source.targetRevision
          identifier: path.identifier
          agentIdentifier: path.agentIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/agents/{agentIdentifier}/repositories/{identifier}/apps'].get
  update:
    x-apievangelist-phrasing:
      intent: List apps inside a registered repository
      effect: read
      questions:
      - Which apps live in a repository my GitOps agent already has registered?
      - Can I list the apps in a registered repo at a specific revision?
      instructions:
      - text: List the apps in repository {identifier} on agent {agentIdentifier}.
        slots:
          identifier: path.identifier
          agentIdentifier: path.agentIdentifier
      - text: Show apps in registered repo {identifier} at revision {revision} for agent {agentIdentifier}.
        slots:
          identifier: path.identifier
          revision: query.query.revision
          agentIdentifier: path.agentIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/agents/{agentIdentifier}/repositories/{identifier}/helmcharts'].get
  update:
    x-apievangelist-phrasing:
      intent: List Helm charts in a registered repository
      effect: read
      questions:
      - What Helm charts are in a repository registered on my GitOps agent?
      - Can I list charts from a registered Helm repo by its identifier?
      instructions:
      - text: List the Helm charts in repository {identifier} on agent {agentIdentifier}.
        slots:
          identifier: path.identifier
          agentIdentifier: path.agentIdentifier
      - text: Refresh and show the charts in registered Helm repo {identifier} via agent {agentIdentifier}.
        slots:
          identifier: path.identifier
          agentIdentifier: path.agentIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/agents/{agentIdentifier}/repositories/{identifier}/refs'].get
  update:
    x-apievangelist-phrasing:
      intent: List branches and tags of a registered repository
      effect: read
      questions:
      - What branches and tags exist in a repo registered on my GitOps agent?
      - Can I see a registered repository's refs by its identifier?
      instructions:
      - text: List branches and tags in repository {identifier} on agent {agentIdentifier}.
        slots:
          identifier: path.identifier
          agentIdentifier: path.agentIdentifier
      - text: Show the Git refs for registered repo {identifier} through agent {agentIdentifier}.
        slots:
          identifier: path.identifier
          agentIdentifier: path.agentIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/agents/{agentIdentifier}/repositories_byurl/appdetails'].get
  update:
    x-apievangelist-phrasing:
      intent: Get app details for a repository by its URL
      effect: read
      questions:
      - What app is defined at a path in a repo when I only know the repo URL?
      - Can I get Helm or Kustomize app details by repository URL instead of identifier?
      instructions:
      - text: Get app details at path {path} in the repo at URL {repoURL} via agent {agentIdentifier}.
        slots:
          path: query.query.source.path
          repoURL: query.query.source.repoURL
          agentIdentifier: path.agentIdentifier
      - text: Using repo URL {repoURL}, show the application details from GitOps agent {agentIdentifier}.
        slots:
          repoURL: query.query.source.repoURL
          agentIdentifier: path.agentIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/agents/{agentIdentifier}/repositories_byurl/apps'].get
  update:
    x-apievangelist-phrasing:
      intent: List apps in a repository looked up by URL
      effect: read
      questions:
      - Which apps are in a repository when I look it up by URL?
      - Can I list apps from a repo URL at a given revision?
      instructions:
      - text: List the apps in the repo at URL {repo} through agent {agentIdentifier}.
        slots:
          repo: query.query.repo
          agentIdentifier: path.agentIdentifier
      - text: By URL, show apps in repo {repo} at revision {revision} for agent {agentIdentifier}.
        slots:
          repo: query.query.repo
          revision: query.query.revision
          agentIdentifier: path.agentIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/agents/{agentIdentifier}/repositories_byurl/helmcharts'].get
  update:
    x-apievangelist-phrasing:
      intent: List Helm charts in a repository by URL
      effect: read
      questions:
      - What Helm charts are available at a repo URL my GitOps agent can reach?
      - Can I browse Helm charts by repository URL rather than identifier?
      instructions:
      - text: List Helm charts in the repository at URL {repo} via agent {agentIdentifier}.
        slots:
          repo: query.query.repo
          agentIdentifier: path.agentIdentifier
      - text: Show charts from Helm repo URL {repo} using GitOps agent {agentIdentifier}.
        slots:
          repo: query.query.repo
          agentIdentifier: path.agentIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/agents/{agentIdentifier}/repositories_byurl/refs'].get
  update:
    x-apievangelist-phrasing:
      intent: List branches and tags of a repository by URL
      effect: read
      questions:
      - What branches and tags does a repo URL have, as seen by my GitOps agent?
      - Can I list Git refs by repo URL without registering an identifier first?
      instructions:
      - text: List branches and tags for repo URL {repo} through agent {agentIdentifier}.
        slots:
          repo: query.query.repo
          agentIdentifier: path.agentIdentifier
      - text: Show Git refs at repository URL {repo} via GitOps agent {agentIdentifier}.
        slots:
          repo: query.query.repo
          agentIdentifier: path.agentIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/agents/{agentIdentifier}/repository_byurl'].get
  update:
    x-apievangelist-phrasing:
      intent: Find a GitOps repository by its URL
      effect: read
      questions:
      - Which GitOps repository record matches this Git URL?
      - Can I look up a repository's configuration on an agent by URL?
      instructions:
      - text: Get the GitOps repository with URL {url} on agent {agentIdentifier}.
        slots:
          url: query.url
          agentIdentifier: path.agentIdentifier
      - text: Look up repo {url} on agent {agentIdentifier} and return its scope-prefixed identifier.
        slots:
          url: query.url
          agentIdentifier: path.agentIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/repositories'].get
  update:
    x-apievangelist-phrasing:
      intent: List repositories using a credential template
      effect: read
      questions:
      - Which repositories inherit a given repository credential template?
      - What repos would be affected if I change a credential template URL?
      instructions:
      - text: List repositories that use credential template {repositoryCredentialURL}.
        slots:
          repositoryCredentialURL: query.repositoryCredentialURL
      - text: Show repos under credential template {repositoryCredentialURL} on agent {agentIdentifier}.
        slots:
          repositoryCredentialURL: query.repositoryCredentialURL
          agentIdentifier: query.agentIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/repositories'].post
  update:
    x-apievangelist-phrasing:
      intent: Search GitOps repositories across agents
      effect: read
      questions:
      - How do I search all GitOps repositories in a project by name?
      - Can I include child scopes when searching GitOps repositories?
      instructions:
      - text: Search GitOps repositories matching {searchTerm} across all agents.
        slots:
          searchTerm: requestBody.searchTerm
      - text: Page through GitOps repositories in project {projectIdentifier}, including child scopes.
        slots:
          projectIdentifier: requestBody.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/repositories/exists'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether a repository URL is already registered
      effect: read
      questions:
      - Is this repository URL already registered in GitOps?
      - How can I avoid adding a duplicate repository to GitOps?
      instructions:
      - text: Check whether a GitOps repository with URL {url} exists.
        slots:
          url: query.url
      - text: Tell me if repo {url} is already registered on agent {agentIdentifier}.
        slots:
          url: query.url
          agentIdentifier: query.agentIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sto/api/v2/repositories'].get
  update:
    x-apievangelist-phrasing:
      intent: List security-scanned code repositories
      effect: read
      questions:
      - Which code repositories in my project have been security scanned?
      - Can I filter scanned code repos by vulnerability severity or scan type?
      instructions:
      - text: List scanned code repositories in project {projectId} of org {orgId}.
        slots:
          projectId: query.projectId
          orgId: query.orgId
      - text: Show code repos in project {projectId} with {severity} severity findings.
        slots:
          projectId: query.projectId
          severity: query.severity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sto/api/v2/repositories/{targetId}/variants'].get
  update:
    x-apievangelist-phrasing:
      intent: List scanned variants of a code repository
      effect: read
      questions:
      - Which branches or variants of a repository have security scans?
      - What order are scanned repository variants returned in?
      instructions:
      - text: List the scanned variants of code repository {targetId} in project {projectId}.
        slots:
          targetId: path.targetId
          projectId: query.projectId
      - text: Find variants of repo target {targetId} whose name contains {search}.
        slots:
          targetId: path.targetId
          search: query.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sto/api/v2/repositories/overview'].get
  update:
    x-apievangelist-phrasing:
      intent: Summarize scanned code repositories and vulnerabilities
      effect: read
      questions:
      - How many code repositories do we have and what are their vulnerability totals?
      - What share of our scanned repos have a baseline set?
      instructions:
      - text: Give me the code repositories overview for project {projectId}.
        slots:
          projectId: query.projectId
      - text: Show total repos, source breakdown and vulnerability counts for org {orgId} project {projectId}.
        slots:
          orgId: query.orgId
          projectId: query.projectId
      method: generated
      generated: '2026-09-26'