Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Account Services API

8 actions 8 updates phrasing extends openapi/harness-account-services-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 8

$.info
$.paths['/v1/services/{service}'].get
$.paths['/v1/services/{service}'].put
$.paths['/v1/services/{service}'].delete
$.paths['/v1/services'].get
$.paths['/v1/services'].post
$.paths['/v1/services/{service}/primary-manifests'].get
$.paths['/v1/services/{service}/primary-manifests'].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 Account Services API
  version: 1.0.0
extends: openapi/harness-account-services-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: 7
- target: $.paths['/v1/services/{service}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account-level service
      effect: read
      questions:
      - Can I look up one account-scoped service by its identifier?
      - What YAML is stored for a service defined at the account level?
      instructions:
      - text: Get account-level service {service}.
        slots:
          service: path.service
      - text: Show the definition of account service {service}.
        slots:
          service: path.service
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/services/{service}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an account-level service
      effect: write
      questions:
      - How do I change the name or tags on an account-scoped service?
      - Can I replace the YAML of a service shared at the account level?
      instructions:
      - text: Update account service {service} with name {name}.
        slots:
          service: path.service
          name: requestBody.name
      - text: Replace the YAML of account service {service} with {yaml}.
        slots:
          service: path.service
          yaml: requestBody.yaml
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/services/{service}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account-level service
      effect: destructive
      questions:
      - Can I force-delete an account-level service?
      - Is there a way to remove a service defined at account scope?
      instructions:
      - text: Delete account service {service}.
        slots:
          service: path.service
      - text: Delete account service {service} with force delete set to {force}.
        slots:
          service: path.service
          force: query.forceDelete
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/services'].get
  update:
    x-apievangelist-phrasing:
      intent: List account-level services
      effect: read
      questions:
      - Which services are defined at my account level?
      - Can I filter account services by deployment type or GitOps enablement?
      instructions:
      - text: List account-level services with deployment type {deployment_type}.
        slots:
          deployment_type: query.deployment_type
      - text: Search account services for {term}.
        slots:
          term: query.search_term
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/services'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an account-level service
      effect: write
      questions:
      - How do I create a service that lives at the account level?
      - What's required to define a new service at account scope?
      instructions:
      - text: Create account service {name} with identifier {identifier}.
        slots:
          name: requestBody.name
          identifier: requestBody.identifier
      - text: Create an account-level service {name} using YAML {yaml}.
        slots:
          name: requestBody.name
          yaml: requestBody.yaml
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/services/{service}/primary-manifests'].get
  update:
    x-apievangelist-phrasing:
      intent: List primary manifest options for a service
      effect: read
      questions:
      - Which manifests can be selected as primary for an account-level service?
      - Can I see the eligible primary manifests of a service without Git details?
      instructions:
      - text: List eligible primary manifests for account service {service}.
        slots:
          service: path.service
      - text: Show which manifests of {service} can be primary.
        slots:
          service: path.service
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/services/{service}/primary-manifests'].post
  update:
    x-apievangelist-phrasing:
      intent: List primary manifests of a Git-stored service
      effect: read
      questions:
      - Can I list eligible primary manifests for a service whose YAML lives on a Git branch?
      - How do I get primary manifests for an account service stored in a different repo?
      instructions:
      - text: List primary manifests for account service {service} from branch {branch}.
        slots:
          service: path.service
          branch: requestBody.branch
      - text: Get eligible primary manifests of {service} in repo {repo}.
        slots:
          service: path.service
          repo: requestBody.repoName
      method: generated
      generated: '2026-09-26'