Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Application Set API

11 actions 11 updates phrasing extends openapi/harness-applicationset-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 11

$.info
$.paths['/gitops/api/v1/applicationset'].put
$.paths['/gitops/api/v1/applicationset'].post
$.paths['/gitops/api/v1/applicationset/generate'].post
$.paths['/gitops/api/v1/applicationset/generators'].get
$.paths['/gitops/api/v1/applicationset/generators/{type}'].get
$.paths['/gitops/api/v1/applicationset/templates/{type}'].get
$.paths['/gitops/api/v1/applicationset/{identifier}'].get
$.paths['/gitops/api/v1/applicationset/{identifier}'].delete
$.paths['/gitops/api/v1/applicationset/{identifier}/resource-tree'].get
$.paths['/gitops/api/v1/applicationsets'].post

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 Application Set API
  version: 1.0.0
extends: openapi/harness-applicationset-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: 10
- target: $.paths['/gitops/api/v1/applicationset'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an existing GitOps ApplicationSet
      effect: write
      questions:
      - How do I change an ApplicationSet that's already deployed through my GitOps agent?
      - Can I dry-run changes to an existing ApplicationSet before applying them?
      instructions:
      - text: 'Update the existing ApplicationSet on agent {agentIdentifier} with this YAML: {yaml}.'
        slots:
          agentIdentifier: query.agentIdentifier
          yaml: requestBody.yaml
      - text: Dry-run an update to the existing ApplicationSet {applicationset} with dryRun {dryRun}.
        slots:
          applicationset: requestBody.applicationset
          dryRun: requestBody.dryRun
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/applicationset'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a GitOps ApplicationSet
      effect: write
      questions:
      - How do I add a new ApplicationSet to a GitOps agent?
      - Can I create an ApplicationSet from raw YAML, upserting if it already exists?
      instructions:
      - text: Create a new ApplicationSet on agent {agentIdentifier} from YAML {yaml}.
        slots:
          agentIdentifier: query.agentIdentifier
          yaml: requestBody.yaml
      - text: Add ApplicationSet {applicationset} to project {projectIdentifier}, upserting with {upsert}.
        slots:
          applicationset: requestBody.applicationset
          projectIdentifier: query.projectIdentifier
          upsert: requestBody.upsert
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/applicationset/generate'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview child applications an ApplicationSet generates
      effect: read
      questions:
      - Which child applications would my ApplicationSet produce?
      - Can I see the generated apps from an ApplicationSet spec before creating it?
      instructions:
      - text: Generate the child applications for ApplicationSet YAML {yaml} on agent {agentIdentifier}.
        slots:
          yaml: requestBody.yaml
          agentIdentifier: query.agentIdentifier
      - text: Show which applications ApplicationSet {applicationset} expands into.
        slots:
          applicationset: requestBody.applicationset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/applicationset/generators'].get
  update:
    x-apievangelist-phrasing:
      intent: List available ApplicationSet generator types
      effect: read
      questions:
      - What generator types can I use in an ApplicationSet?
      - Which kinds of ApplicationSet generators does the GitOps service support?
      instructions:
      - text: List the supported ApplicationSet generators.
      - text: Show me every generator type available for ApplicationSets.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/applicationset/generators/{type}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one ApplicationSet generator
      effect: read
      questions:
      - What does a specific ApplicationSet generator look like and how is it configured?
      - Where can I read the definition of one generator type?
      instructions:
      - text: Get the ApplicationSet generator of type {type}.
        slots:
          type: path.type
      - text: Show the {type} generator definition for agent {agentIdentifier}.
        slots:
          type: path.type
          agentIdentifier: query.agentIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/applicationset/templates/{type}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an ApplicationSet starter template
      effect: read
      questions:
      - Is there a starter template for an ApplicationSet using a given generator?
      - Can I get sample ApplicationSet YAML to begin from?
      instructions:
      - text: Get the ApplicationSet template for generator type {type}.
        slots:
          type: path.type
      - text: Give me a starter {type} ApplicationSet template for project {projectIdentifier}.
        slots:
          type: path.type
          projectIdentifier: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/applicationset/{identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an ApplicationSet
      effect: read
      questions:
      - How do I look up a single ApplicationSet by its identifier?
      - What is the current spec and status of one of my ApplicationSets?
      instructions:
      - text: Get ApplicationSet {identifier}.
        slots:
          identifier: path.identifier
      - text: Show ApplicationSet {identifier} on agent {agentIdentifier} in project {projectIdentifier}.
        slots:
          identifier: path.identifier
          agentIdentifier: query.agentIdentifier
          projectIdentifier: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/applicationset/{identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an ApplicationSet
      effect: destructive
      questions:
      - How can I remove an ApplicationSet from my GitOps setup?
      - Can I delete an ApplicationSet on a specific agent by its id?
      instructions:
      - text: Delete ApplicationSet {identifier}.
        slots:
          identifier: path.identifier
      - text: Remove ApplicationSet {identifier} from agent {agentIdentifier}.
        slots:
          identifier: path.identifier
          agentIdentifier: query.agentIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/applicationset/{identifier}/resource-tree'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the resource tree of an ApplicationSet
      effect: read
      questions:
      - What Kubernetes resources does an ApplicationSet own?
      - Can I view the resource tree for an ApplicationSet in a given namespace?
      instructions:
      - text: Show the resource tree for ApplicationSet {identifier}.
        slots:
          identifier: path.identifier
      - text: Get the resource hierarchy of ApplicationSet {identifier} in namespace {appsetNamespace}.
        slots:
          identifier: path.identifier
          appsetNamespace: query.query.appsetNamespace
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/applicationsets'].post
  update:
    x-apievangelist-phrasing:
      intent: List ApplicationSets
      effect: read
      questions:
      - Which ApplicationSets exist across my GitOps agents?
      - Can I search ApplicationSets by name and page through them?
      instructions:
      - text: List ApplicationSets in project {projectIdentifier}.
        slots:
          projectIdentifier: requestBody.projectIdentifier
      - text: Search ApplicationSets matching {searchTerm} on agent {agentIdentifier}.
        slots:
          searchTerm: requestBody.searchTerm
          agentIdentifier: requestBody.agentIdentifier
      method: generated
      generated: '2026-09-26'