Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Policysets API

7 actions 7 updates phrasing extends openapi/harness-policy-sets-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 7

$.info
$.paths['/pm/api/v1/policysets'].get
$.paths['/pm/api/v1/policysets'].post
$.paths['/pm/api/v1/policysets/all'].get
$.paths['/pm/api/v1/policysets/{identifier}'].get
$.paths['/pm/api/v1/policysets/{identifier}'].delete
$.paths['/pm/api/v1/policysets/{identifier}'].patch

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 Policysets API
  version: 1.0.0
extends: openapi/harness-policy-sets-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/pm/api/v1/policysets'].get
  update:
    x-apievangelist-phrasing:
      intent: List policy sets at one scope
      effect: read
      questions:
      - Which policy sets are defined in this project or org?
      - Can I filter policy sets by entity type or the action they run on?
      instructions:
      - text: List policy sets in project {projectIdentifier}.
        slots:
          projectIdentifier: query.projectIdentifier
      - text: Search policy sets for {searchTerm} of type {type}.
        slots:
          searchTerm: query.searchTerm
          type: query.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pm/api/v1/policysets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a policy set
      effect: write
      questions:
      - How do I group policies into a set that runs on a pipeline event?
      - Can I create a policy set that starts out disabled?
      instructions:
      - text: Create policy set {identifier} named {name} for type {type} on action {action}.
        slots:
          identifier: requestBody.identifier
          name: requestBody.name
          type: requestBody.type
          action: requestBody.action
      - text: Add policy set {name} with enabled set to {enabled}.
        slots:
          name: requestBody.name
          enabled: requestBody.enabled
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pm/api/v1/policysets/all'].get
  update:
    x-apievangelist-phrasing:
      intent: List policy sets across all scope levels
      effect: read
      questions:
      - What policy sets apply to a project once account and org sets are included?
      - Can I see every inherited policy set in one hierarchical list?
      instructions:
      - text: List policy sets from account, org and project levels for project {projectIdentifier}.
        slots:
          projectIdentifier: query.projectIdentifier
      - text: Show all inherited policy sets for action {action}.
        slots:
          action: query.action
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pm/api/v1/policysets/{identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a policy set
      effect: read
      questions:
      - What policies are in a specific policy set?
      - Can I look up one policy set by its identifier?
      instructions:
      - text: Get policy set {identifier}.
        slots:
          identifier: path.identifier
      - text: Show the policies and settings of set {identifier} in org {orgIdentifier}.
        slots:
          identifier: path.identifier
          orgIdentifier: query.orgIdentifier
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pm/api/v1/policysets/{identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a policy set
      effect: destructive
      questions:
      - How do I delete a policy set I no longer enforce?
      - Does removing a policy set delete the policies inside it?
      instructions:
      - text: Delete policy set {identifier}.
        slots:
          identifier: path.identifier
      - text: Remove policy set {identifier} from project {projectIdentifier}.
        slots:
          identifier: path.identifier
          projectIdentifier: query.projectIdentifier
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pm/api/v1/policysets/{identifier}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a policy set
      effect: write
      questions:
      - Can I add policies or resource groups to an existing policy set?
      - How do I disable a policy set without deleting it?
      instructions:
      - text: Update policy set {identifier} to include policies {policies}.
        slots:
          identifier: path.identifier
          policies: requestBody.policies
      - text: Set policy set {identifier} enabled to {enabled}.
        slots:
          identifier: path.identifier
          enabled: requestBody.enabled
      method: generated
      generated: '2026-10-01'