Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Public Access API

5 actions 5 updates phrasing extends openapi/harness-public-access-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 5

$.info
$.paths['/v1/public-access/enable'].post
$.paths['/v1/public-access/is-resource-public'].post
$.paths['/v1/public-access/check-public'].post
$.paths['/v1/public-access/disable'].put

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 Public Access API
  version: 1.0.0
extends: openapi/harness-public-access-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: 4
- target: $.paths['/v1/public-access/enable'].post
  update:
    x-apievangelist-phrasing:
      intent: Make a resource publicly accessible
      effect: write
      questions:
      - Can I share a Harness resource, such as a pipeline, publicly without requiring login?
      - What do I need to specify to turn on public access for a resource?
      instructions:
      - text: Enable public access on {resource_type} {resource_identifier} in scope {resource_scope}.
        slots:
          resource_type: requestBody.resource_type
          resource_identifier: requestBody.resource_identifier
          resource_scope: requestBody.resource_scope
      - text: Make {resource_identifier} public, treating it as a {resource_type} under {resource_scope}.
        slots:
          resource_identifier: requestBody.resource_identifier
          resource_type: requestBody.resource_type
          resource_scope: requestBody.resource_scope
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/public-access/is-resource-public'].post
  update:
    x-apievangelist-phrasing:
      intent: Check whether one resource is public
      effect: read
      questions:
      - Is this particular resource currently exposed to the public?
      - Can I confirm one resource's public status before sharing a link?
      instructions:
      - text: Check if {resource_type} {resource_identifier} in {resource_scope} is public.
        slots:
          resource_type: requestBody.resource_type
          resource_identifier: requestBody.resource_identifier
          resource_scope: requestBody.resource_scope
      - text: Tell me whether resource {resource_identifier} of type {resource_type} under {resource_scope} has public access on.
        slots:
          resource_identifier: requestBody.resource_identifier
          resource_type: requestBody.resource_type
          resource_scope: requestBody.resource_scope
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/public-access/check-public'].post
  update:
    x-apievangelist-phrasing:
      intent: Check public status for many resources
      effect: read
      questions:
      - Which of these resources are publicly accessible?
      - Can I check public access for a whole list of resources in one call?
      instructions:
      - text: Check which of {resource_identifiers} ({resource_type}) in {resource_scope} are public.
        slots:
          resource_identifiers: requestBody.resource_identifiers
          resource_type: requestBody.resource_type
          resource_scope: requestBody.resource_scope
      - text: Report public status for each {resource_type} in list {resource_identifiers} under scope {resource_scope}.
        slots:
          resource_type: requestBody.resource_type
          resource_identifiers: requestBody.resource_identifiers
          resource_scope: requestBody.resource_scope
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/public-access/disable'].put
  update:
    x-apievangelist-phrasing:
      intent: Turn off public access on a resource
      effect: write
      questions:
      - What's the way to stop a resource from being publicly visible?
      - Can I revoke public access for a resource in a specific project?
      instructions:
      - text: Disable public access on {resource_type} {resource_identifier}.
        slots:
          resource_type: query.resource_type
          resource_identifier: query.resource_identifier
      - text: Make {resource_identifier} private again in project {project}.
        slots:
          resource_identifier: query.resource_identifier
          project: query.project
      method: generated
      generated: '2026-09-26'