Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Org Services API

8 actions 8 updates phrasing extends openapi/harness-org-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/orgs/{org}/services/{service}'].get
$.paths['/v1/orgs/{org}/services/{service}'].put
$.paths['/v1/orgs/{org}/services/{service}'].delete
$.paths['/v1/orgs/{org}/services'].get
$.paths['/v1/orgs/{org}/services'].post
$.paths['/v1/orgs/{org}/services/{service}/primary-manifests'].get
$.paths['/v1/orgs/{org}/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 Org Services API
  version: 1.0.0
extends: openapi/harness-org-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/orgs/{org}/services/{service}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an org-level service
      effect: read
      questions:
      - What is configured on a service defined at organization scope?
      - Can I fetch one org-scoped service by identifier?
      instructions:
      - text: Get service {service} in org {org}.
        slots:
          service: path.service
          org: path.org
      - text: Show the org-scoped service {service} from organization {org}.
        slots:
          service: path.service
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/services/{service}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an org-level service
      effect: write
      questions:
      - How do I change the YAML of a service shared across an organization?
      - Can I rename an org-scoped service?
      instructions:
      - text: Update service {service} in org {org} with YAML {yaml}.
        slots:
          service: path.service
          org: path.org
          yaml: requestBody.yaml
      - text: Rename org {org} service {service} to {name}.
        slots:
          org: path.org
          service: path.service
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/services/{service}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an org-level service
      effect: destructive
      questions:
      - How do I delete a service defined at the organization level?
      - Can I force-delete an org service that is still referenced?
      instructions:
      - text: Delete service {service} from org {org}.
        slots:
          service: path.service
          org: path.org
      - text: Force delete org {org} service {service}.
        slots:
          org: path.org
          service: path.service
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/services'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's services
      effect: read
      questions:
      - Which services are defined at my organization's scope?
      - Can I filter org services by deployment type or GitOps?
      instructions:
      - text: List services in org {org}.
        slots:
          org: path.org
      - text: Find {deployment_type} services in org {org} matching {term}.
        slots:
          deployment_type: query.deployment_type
          org: path.org
          term: query.search_term
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/services'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an org-level service
      effect: write
      questions:
      - How do I create a service every project in an organization can use?
      - What's required to define a service at org scope?
      instructions:
      - text: Create service {name} with identifier {identifier} in org {org}.
        slots:
          name: requestBody.name
          identifier: requestBody.identifier
          org: path.org
      - text: Create an org {org} service {identifier} from YAML {yaml}.
        slots:
          org: path.org
          identifier: requestBody.identifier
          yaml: requestBody.yaml
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/services/{service}/primary-manifests'].get
  update:
    x-apievangelist-phrasing:
      intent: List eligible primary manifests of an org service
      effect: read
      questions:
      - Which manifests on an org-scoped service can be picked as the primary one?
      - Can I see primary manifest candidates for a service in my organization?
      instructions:
      - text: List primary manifests for service {service} in org {org}.
        slots:
          service: path.service
          org: path.org
      - text: Show which manifests of org {org} service {service} can be primary.
        slots:
          org: path.org
          service: path.service
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/services/{service}/primary-manifests'].post
  update:
    x-apievangelist-phrasing:
      intent: List primary manifests from a Git branch
      effect: read
      questions:
      - Can I list primary manifest candidates of a Git-stored org service on a specific branch?
      - Which primary manifests does an org service have in another repo?
      instructions:
      - text: List primary manifests of org {org} service {service} on branch {branch}.
        slots:
          org: path.org
          service: path.service
          branch: requestBody.branch
      - text: Show primary manifests for org {org} service {service} from repo {repo}.
        slots:
          org: path.org
          service: path.service
          repo: requestBody.repoName
      method: generated
      generated: '2026-09-26'