Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Variable Sets API

22 actions 22 updates phrasing extends openapi/harness-variable-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 22 · first 16 shown; the file carries all of them

$.info
$.paths['/iacm/api/orgs/{org}/projects/{project}/variable-set'].post
$.paths['/iacm/api/orgs/{org}/projects/{project}/variable-set'].delete
$.paths['/iacm/api/orgs/{org}/projects/{project}/variable-set/{identifier}'].get
$.paths['/iacm/api/orgs/{org}/projects/{project}/variable-set/{identifier}'].put
$.paths['/iacm/api/orgs/{org}/projects/{project}/variable-set/{identifier}'].delete
$.paths['/iacm/api/orgs/{org}/projects/{project}/variable-set/{identifier}/references'].get
$.paths['/iacm/api/orgs/{org}/projects/{project}/variable-sets'].get
$.paths['/iacm/api/orgs/{org}/variable-set'].post
$.paths['/iacm/api/orgs/{org}/variable-set'].delete
$.paths['/iacm/api/orgs/{org}/variable-set/{identifier}'].get
$.paths['/iacm/api/orgs/{org}/variable-set/{identifier}'].put
$.paths['/iacm/api/orgs/{org}/variable-set/{identifier}'].delete
$.paths['/iacm/api/orgs/{org}/variable-set/{identifier}/references'].get
$.paths['/iacm/api/orgs/{org}/variable-sets'].get
$.paths['/iacm/api/variable-set'].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 Variable Sets API
  version: 1.0.0
extends: openapi/harness-variable-sets-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: 21
- target: $.paths['/iacm/api/orgs/{org}/projects/{project}/variable-set'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a project-level variable set
      effect: write
      questions:
      - How do I create an IaCM variable set scoped to a single project?
      - Can a project variable set bundle Terraform variables, environment variables and connectors together?
      instructions:
      - text: Create variable set {identifier} named {name} in project {project} of org {org}.
        slots:
          identifier: requestBody.identifier
          name: requestBody.name
          project: path.project
          org: path.org
      - text: Add a new project-scoped variable set called {name} with id {identifier} to {project}.
        slots:
          name: requestBody.name
          identifier: requestBody.identifier
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/orgs/{org}/projects/{project}/variable-set'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a project variable set by query identifier
      effect: destructive
      questions:
      - Can I delete a project variable set whose identifier contains a slash?
      - Is there a way to remove a project-level variable set when its id isn't URL-safe?
      instructions:
      - text: Delete the project variable set with identifier {identifier} in {project} of {org}, passing the id as a query parameter.
        slots:
          identifier: query.identifier
          project: path.project
          org: path.org
      - text: Remove project-scoped variable set {identifier} from {project} using the query-string delete.
        slots:
          identifier: query.identifier
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/orgs/{org}/projects/{project}/variable-set/{identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a project variable set
      effect: read
      questions:
      - Where can I see the Terraform variables and connectors inside one project variable set?
      - What does a single variable set defined in my project contain?
      instructions:
      - text: Show project variable set {identifier} in {project} of {org}.
        slots:
          identifier: path.identifier
          project: path.project
          org: path.org
      - text: Fetch the details of variable set {identifier} at project scope in {project}.
        slots:
          identifier: path.identifier
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/orgs/{org}/projects/{project}/variable-set/{identifier}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a project variable set
      effect: write
      questions:
      - How do I change the Terraform variables in an existing project variable set?
      - Can I rename a variable set that lives at project level?
      instructions:
      - text: Update project variable set {identifier} in {project} under {org} and rename it to {name}.
        slots:
          identifier: path.identifier
          project: path.project
          org: path.org
          name: requestBody.name
      - text: Change the description of project variable set {identifier} in {project} to {description}, keeping the name {name}.
        slots:
          identifier: path.identifier
          project: path.project
          description: requestBody.description
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/orgs/{org}/projects/{project}/variable-set/{identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a project variable set by identifier
      effect: destructive
      questions:
      - How do I delete a variable set from one of my projects?
      - Can I permanently remove a project-level variable set by its identifier in the URL?
      instructions:
      - text: Delete project variable set {identifier} from project {project} in org {org}.
        slots:
          identifier: path.identifier
          project: path.project
          org: path.org
      - text: Remove the variable set {identifier} defined at project scope in {project}.
        slots:
          identifier: path.identifier
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/orgs/{org}/projects/{project}/variable-set/{identifier}/references'].get
  update:
    x-apievangelist-phrasing:
      intent: List where a project variable set is referenced
      effect: read
      questions:
      - Which workspaces reference a given project variable set?
      - Can I check where a project-level variable set is used before deleting it?
      instructions:
      - text: List references to project variable set {identifier} in {project} of {org}.
        slots:
          identifier: path.identifier
          project: path.project
          org: path.org
      - text: Show what uses variable set {identifier} in project {project}.
        slots:
          identifier: path.identifier
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/orgs/{org}/projects/{project}/variable-sets'].get
  update:
    x-apievangelist-phrasing:
      intent: List variable sets in a project
      effect: read
      questions:
      - What variable sets exist in my IaCM project?
      - Is there a list of every variable set defined at project level?
      instructions:
      - text: List the variable sets in project {project} of org {org}.
        slots:
          project: path.project
          org: path.org
      - text: Show all project-scoped variable sets for {project}.
        slots:
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/orgs/{org}/variable-set'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an organization-level variable set
      effect: write
      questions:
      - How do I create a variable set shared across a whole organization?
      - Can I define org-wide Terraform variable files in one reusable set?
      instructions:
      - text: Create an org-level variable set {identifier} named {name} in organization {org}.
        slots:
          identifier: requestBody.identifier
          name: requestBody.name
          org: path.org
      - text: Add variable set {name} (id {identifier}) at organization scope for {org} with description {description}.
        slots:
          name: requestBody.name
          identifier: requestBody.identifier
          org: path.org
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/orgs/{org}/variable-set'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an org variable set by query identifier
      effect: destructive
      questions:
      - Can I delete an organization variable set whose id has characters unsafe in a URL path?
      - Is there a query-parameter way to remove an org-level variable set?
      instructions:
      - text: Delete org variable set {identifier} in organization {org}, sending the id as a query parameter.
        slots:
          identifier: query.identifier
          org: path.org
      - text: Remove the organization-scoped variable set {identifier} from {org} via the query-string delete.
        slots:
          identifier: query.identifier
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/orgs/{org}/variable-set/{identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization variable set
      effect: read
      questions:
      - What's inside a particular organization-level variable set?
      - Where do I view the connectors and environment variables of an org variable set?
      instructions:
      - text: Show organization variable set {identifier} in {org}.
        slots:
          identifier: path.identifier
          org: path.org
      - text: Fetch the org-scoped variable set {identifier} from organization {org}.
        slots:
          identifier: path.identifier
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/orgs/{org}/variable-set/{identifier}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an organization variable set
      effect: write
      questions:
      - How do I edit the environment variables in an org-wide variable set?
      - Can I rename a variable set shared at organization level?
      instructions:
      - text: Update org variable set {identifier} in organization {org} and set its name to {name}.
        slots:
          identifier: path.identifier
          org: path.org
          name: requestBody.name
      - text: Change the organization variable set {identifier} in {org} to have description {description} and name {name}.
        slots:
          identifier: path.identifier
          org: path.org
          description: requestBody.description
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/orgs/{org}/variable-set/{identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an organization variable set by identifier
      effect: destructive
      questions:
      - How can I delete a variable set that belongs to my organization?
      - Can I remove an org-level variable set by putting its identifier in the path?
      instructions:
      - text: Delete organization variable set {identifier} from {org}.
        slots:
          identifier: path.identifier
          org: path.org
      - text: Remove the org-scoped variable set {identifier} in organization {org} by its path identifier.
        slots:
          identifier: path.identifier
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/orgs/{org}/variable-set/{identifier}/references'].get
  update:
    x-apievangelist-phrasing:
      intent: List where an org variable set is referenced
      effect: read
      questions:
      - Which projects or workspaces use a given organization variable set?
      - Can I find all references to an org-level variable set?
      instructions:
      - text: List references to organization variable set {identifier} in {org}.
        slots:
          identifier: path.identifier
          org: path.org
      - text: Show everything that depends on org variable set {identifier} in organization {org}.
        slots:
          identifier: path.identifier
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/orgs/{org}/variable-sets'].get
  update:
    x-apievangelist-phrasing:
      intent: List variable sets in an organization
      effect: read
      questions:
      - What variable sets are defined for my whole organization?
      - Is there a way to see every org-level variable set at once?
      instructions:
      - text: List the organization-scoped variable sets in {org}.
        slots:
          org: path.org
      - text: Show all variable sets defined at org level for organization {org}.
        slots:
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/variable-set'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an account-level variable set
      effect: write
      questions:
      - How do I create a variable set available to my entire Harness account?
      - Can an account-wide variable set carry Terraform variables for every org?
      instructions:
      - text: Create an account-level variable set {identifier} named {name}.
        slots:
          identifier: requestBody.identifier
          name: requestBody.name
      - text: Add account-scoped variable set {name} with id {identifier} and description {description}.
        slots:
          name: requestBody.name
          identifier: requestBody.identifier
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/variable-set'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account variable set by query identifier
      effect: destructive
      questions:
      - Can I delete an account-level variable set whose identifier includes a slash?
      - Is there a query-string delete for account-wide variable sets?
      instructions:
      - text: Delete account variable set {identifier}, passing the id as a query parameter.
        slots:
          identifier: query.identifier
      - text: Remove the account-scoped variable set {identifier} using the query-parameter delete.
        slots:
          identifier: query.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/variable-set/{identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account variable set
      effect: read
      questions:
      - What does a specific account-wide variable set contain?
      - Where can I read the Terraform variable files attached to an account-level variable set?
      instructions:
      - text: Show account variable set {identifier}.
        slots:
          identifier: path.identifier
      - text: Fetch the details of account-scoped variable set {identifier}.
        slots:
          identifier: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/variable-set/{identifier}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an account variable set
      effect: write
      questions:
      - How do I change the connectors on an account-wide variable set?
      - Can I rename a variable set defined at account level?
      instructions:
      - text: Update account variable set {identifier} and rename it to {name}.
        slots:
          identifier: path.identifier
          name: requestBody.name
      - text: Set the description of account-scoped variable set {identifier} to {description}, keeping name {name}.
        slots:
          identifier: path.identifier
          description: requestBody.description
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/variable-set/{identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account variable set by identifier
      effect: destructive
      questions:
      - How do I delete an account-wide variable set?
      - Can I remove an account-level variable set by its identifier in the path?
      instructions:
      - text: Delete account variable set {identifier}.
        slots:
          identifier: path.identifier
      - text: Remove the variable set {identifier} defined at account scope by its path id.
        slots:
          identifier: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/variable-set/{identifier}/references'].get
  update:
    x-apievangelist-phrasing:
      intent: List where an account variable set is referenced
      effect: read
      questions:
      - Which workspaces across my account use a given account variable set?
      - Can I see the references to an account-level variable set before changing it?
      instructions:
      - text: List references to account variable set {identifier}.
        slots:
          identifier: path.identifier
      - text: Show everything that depends on account-scoped variable set {identifier}.
        slots:
          identifier: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/variable-sets'].get
  update:
    x-apievangelist-phrasing:
      intent: List variable sets in the account
      effect: read
      questions:
      - What variable sets are defined at the account level?
      - Is there a list of all account-wide variable sets?
      instructions:
      - text: List the account-level variable sets for account {account}.
        slots:
          account: header.Harness-Account
      - text: Show every variable set scoped to the whole account {account}.
        slots:
          account: header.Harness-Account
      method: generated
      generated: '2026-09-26'