Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Project Services API

8 actions 8 updates phrasing extends openapi/harness-project-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}/projects/{project}/services/{service}'].get
$.paths['/v1/orgs/{org}/projects/{project}/services/{service}'].put
$.paths['/v1/orgs/{org}/projects/{project}/services/{service}'].delete
$.paths['/v1/orgs/{org}/projects/{project}/services'].get
$.paths['/v1/orgs/{org}/projects/{project}/services'].post
$.paths['/v1/orgs/{org}/projects/{project}/services/{service}/primary-manifests'].get
$.paths['/v1/orgs/{org}/projects/{project}/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 Project Services API
  version: 1.0.0
extends: openapi/harness-project-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}/projects/{project}/services/{service}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a project-scoped service
      effect: read
      questions:
      - How do I get the definition of a deployment service in a project?
      - Can I read a service's YAML and tags?
      instructions:
      - text: Get service {service} in project {project} of org {org}.
        slots:
          service: path.service
          project: path.project
          org: path.org
      - text: Show me the configuration of service {service}.
        slots:
          service: path.service
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/services/{service}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a project-scoped service
      effect: write
      questions:
      - How do I change a service's name, description or YAML?
      - Can I update the tags on an existing service?
      instructions:
      - text: Update service {service} in project {project} of org {org} with name {name}.
        slots:
          service: path.service
          project: path.project
          org: path.org
          name: requestBody.name
      - text: Replace the YAML of service {service} with {yaml}.
        slots:
          service: path.service
          yaml: requestBody.yaml
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/services/{service}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a project-scoped service
      effect: destructive
      questions:
      - How do I delete a service from a project?
      - Can I force delete a service that is still referenced elsewhere?
      instructions:
      - text: Delete service {service} from project {project} of org {org}.
        slots:
          service: path.service
          project: path.project
          org: path.org
      - text: Force delete service {service} with forceDelete={forceDelete}.
        slots:
          service: path.service
          forceDelete: query.forceDelete
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/services'].get
  update:
    x-apievangelist-phrasing:
      intent: List services in a project
      effect: read
      questions:
      - Which services can I see in a project?
      - Can I filter services by deployment type or GitOps enabled?
      - Is there a way to search services by name?
      instructions:
      - text: List services in project {project} of org {org}.
        slots:
          project: path.project
          org: path.org
      - text: List {deployment_type} services in project {project}.
        slots:
          deployment_type: query.deployment_type
          project: path.project
      - text: Search services in {project} for {search_term}.
        slots:
          project: path.project
          search_term: query.search_term
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/services'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a service in a project
      effect: write
      questions:
      - How do I create a new deployment service in a project?
      - Can I define the service's YAML when I create it?
      instructions:
      - text: Create service {name} with identifier {identifier} in project {project} of org {org}.
        slots:
          name: requestBody.name
          identifier: requestBody.identifier
          project: path.project
          org: path.org
      - text: Create a new service {name} from YAML {yaml}.
        slots:
          name: requestBody.name
          yaml: requestBody.yaml
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/services/{service}/primary-manifests'].get
  update:
    x-apievangelist-phrasing:
      intent: List eligible primary manifests for a service
      effect: read
      questions:
      - Which manifests in a service can be chosen as the primary manifest?
      - How do I see the primary manifest options configured on a service?
      instructions:
      - text: List eligible primary manifests for service {service} in project {project} of org {org}.
        slots:
          service: path.service
          project: path.project
          org: path.org
      - text: Show the primary manifest choices for service {service}.
        slots:
          service: path.service
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/services/{service}/primary-manifests'].post
  update:
    x-apievangelist-phrasing:
      intent: List primary manifests for a Git-stored service
      effect: read
      questions:
      - How do I list primary manifests for a service whose YAML lives in a Git branch?
      - Can I resolve primary manifests from a specific repo and branch?
      instructions:
      - text: List primary manifests for service {service} in project {project} of org {org} from branch {branch}.
        slots:
          service: path.service
          project: path.project
          org: path.org
          branch: requestBody.branch
      - text: Resolve primary manifests of service {service} stored in repo {repoName}.
        slots:
          service: path.service
          repoName: requestBody.repoName
      method: generated
      generated: '2026-09-26'