Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Labels API

22 actions 22 updates phrasing extends openapi/harness-labels-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['/code/api/v1/labels'].get
$.paths['/code/api/v1/labels'].put
$.paths['/code/api/v1/labels'].post
$.paths['/code/api/v1/labels/{key}'].delete
$.paths['/code/api/v1/labels/{key}'].patch
$.paths['/code/api/v1/labels/{key}/values'].get
$.paths['/code/api/v1/labels/{key}/values'].post
$.paths['/code/api/v1/labels/{key}/values/{value}'].delete
$.paths['/code/api/v1/labels/{key}/values/{value}'].patch
$.paths['/code/api/v1/repos/{repo_identifier}/labels'].get
$.paths['/code/api/v1/repos/{repo_identifier}/labels'].put
$.paths['/code/api/v1/repos/{repo_identifier}/labels'].post
$.paths['/code/api/v1/repos/{repo_identifier}/labels/{key}'].delete
$.paths['/code/api/v1/repos/{repo_identifier}/labels/{key}'].patch
$.paths['/code/api/v1/repos/{repo_identifier}/labels/{key}/values'].get

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 Labels API
  version: 1.0.0
extends: openapi/harness-labels-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['/code/api/v1/labels'].get
  update:
    x-apievangelist-phrasing:
      intent: List labels defined for an account, org or project
      effect: read
      questions:
      - What labels are defined for my Harness Code project?
      - Can I include labels inherited from the org and account when listing project labels?
      - Is there a way to search the labels defined at the account level by name?
      instructions:
      - text: List the labels defined in project {project} of org {org}.
        slots:
          project: query.projectIdentifier
          org: query.orgIdentifier
      - text: Show account {account}'s labels matching {search}, including inherited ones.
        slots:
          account: query.accountIdentifier
          search: query.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/labels'].put
  update:
    x-apievangelist-phrasing:
      intent: Save a label and its values in one call at a scope
      effect: write
      questions:
      - Can I create or overwrite a project label together with all its values in a single request?
      - What's the quickest way to upsert an org-level label along with its allowed values?
      instructions:
      - text: Save label {label} with values {values} at the project {project} level in one go.
        slots:
          label: requestBody.label
          values: requestBody.values
          project: query.projectIdentifier
      - text: Upsert the account-wide label definition {label} and its full value list.
        slots:
          label: requestBody.label
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/labels'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new label at account, org or project level
      effect: write
      questions:
      - How do I create a new pull request label that every repo in my project can use?
      - Can a label defined at the org level have its own color and description?
      instructions:
      - text: Create a project-level label {key} colored {color} in project {project}.
        slots:
          key: requestBody.key
          color: requestBody.color
          project: query.projectIdentifier
      - text: Define a new account-wide label {key} described as {description}.
        slots:
          key: requestBody.key
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/labels/{key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a label defined at account, org or project
      effect: destructive
      questions:
      - Can I remove a label that was defined for the whole project rather than one repo?
      - What happens when I delete an org-level label from Harness Code?
      instructions:
      - text: Delete the project-level label {key} from project {project}.
        slots:
          key: path.key
          project: query.projectIdentifier
      - text: Remove account label {key} entirely.
        slots:
          key: path.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/labels/{key}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an account, org or project label
      effect: write
      questions:
      - Can I rename or recolor a label that's shared across my whole project?
      - Is it possible to change the description of an existing org-level label?
      instructions:
      - text: Change the color of project label {key} to {color}.
        slots:
          key: path.key
          color: requestBody.color
      - text: Update the description of account-wide label {key} to {description}.
        slots:
          key: path.key
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/labels/{key}/values'].get
  update:
    x-apievangelist-phrasing:
      intent: List the values of a project, org or account label
      effect: read
      questions:
      - What values are allowed for a label defined at the project level?
      - Which options can people pick for an org-wide label?
      instructions:
      - text: List the allowed values of project label {key}.
        slots:
          key: path.key
      - text: Show the values for account-level label {key} in account {account}.
        slots:
          key: path.key
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/labels/{key}/values'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a value to an account, org or project label
      effect: write
      questions:
      - Can I add a new option to an existing project-wide label?
      - Does each value on an org-level label get its own color?
      instructions:
      - text: Add value {value} to project label {key}.
        slots:
          value: requestBody.value
          key: path.key
      - text: Create value {value} with color {color} on account label {key}.
        slots:
          value: requestBody.value
          color: requestBody.color
          key: path.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/labels/{key}/values/{value}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a value from an account, org or project label
      effect: destructive
      questions:
      - Can I remove one option from a project-wide label without deleting the label itself?
      - Is there a way to drop an outdated value from an org-level label?
      instructions:
      - text: Delete value {value} from project label {key}.
        slots:
          value: path.value
          key: path.key
      - text: Remove the {value} option from account-wide label {key}.
        slots:
          value: path.value
          key: path.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/labels/{key}/values/{value}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a value on an account, org or project label
      effect: write
      questions:
      - Can I rename a single value of a project-level label?
      - How can I change the color of one option on an org-wide label?
      instructions:
      - text: Rename value {value} of project label {key} to {new_value}.
        slots:
          value: path.value
          key: path.key
          new_value: requestBody.value
      - text: Set the color of value {value} on account label {key} to {color}.
        slots:
          value: path.value
          key: path.key
          color: requestBody.color
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/labels'].get
  update:
    x-apievangelist-phrasing:
      intent: List the labels available in a repository
      effect: read
      questions:
      - Which labels are defined on a specific Harness Code repository?
      - Can I see repo labels alongside the ones inherited from its project?
      - Is there a way to search a repository's labels by name?
      instructions:
      - text: List the labels in repository {repo}.
        slots:
          repo: path.repo_identifier
      - text: Find labels in repo {repo} matching {search}, including inherited ones.
        slots:
          repo: path.repo_identifier
          search: query.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/labels'].put
  update:
    x-apievangelist-phrasing:
      intent: Save a repo label and its values in one call
      effect: write
      questions:
      - Can I upsert a repository label along with all of its values at once?
      - What's the single-request way to define a repo label and its option list?
      instructions:
      - text: Save label {label} with values {values} on repository {repo}.
        slots:
          label: requestBody.label
          values: requestBody.values
          repo: path.repo_identifier
      - text: Upsert repo {repo}'s label definition {label} including its values.
        slots:
          repo: path.repo_identifier
          label: requestBody.label
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/labels'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a label scoped to one repository
      effect: write
      questions:
      - How do I add a label that only exists in one repository?
      - Can a repository-only label have its own color and description?
      instructions:
      - text: Create label {key} in repository {repo}.
        slots:
          key: requestBody.key
          repo: path.repo_identifier
      - text: Define repo-only label {key} with color {color} in {repo}.
        slots:
          key: requestBody.key
          color: requestBody.color
          repo: path.repo_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/labels/{key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a label from a repository
      effect: destructive
      questions:
      - Can I delete a label that was defined only on one repository?
      - How do I get rid of an unused repo-level label?
      instructions:
      - text: Delete label {key} from repository {repo}.
        slots:
          key: path.key
          repo: path.repo_identifier
      - text: Remove the repo-level label {key} in {repo}.
        slots:
          key: path.key
          repo: path.repo_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/labels/{key}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a repository-level label
      effect: write
      questions:
      - Can I change the color or description of a label that belongs to one repo?
      - Is it possible to rename a repository label's key?
      instructions:
      - text: Recolor label {key} in repository {repo} to {color}.
        slots:
          key: path.key
          repo: path.repo_identifier
          color: requestBody.color
      - text: Update repo {repo} label {key} description to {description}.
        slots:
          repo: path.repo_identifier
          key: path.key
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/labels/{key}/values'].get
  update:
    x-apievangelist-phrasing:
      intent: List the values of a repository label
      effect: read
      questions:
      - What values can be chosen for a label defined in one repository?
      - Which options exist for a repo-only label?
      instructions:
      - text: List the values of label {key} in repository {repo}.
        slots:
          key: path.key
          repo: path.repo_identifier
      - text: Show the options for repo {repo}'s label {key}.
        slots:
          repo: path.repo_identifier
          key: path.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/labels/{key}/values'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a value to a repository label
      effect: write
      questions:
      - Can I add a new option to a label that lives in a single repository?
      - Does a value on a repo label accept its own color?
      instructions:
      - text: Add value {value} to label {key} in repository {repo}.
        slots:
          value: requestBody.value
          key: path.key
          repo: path.repo_identifier
      - text: Create value {value} colored {color} on repo {repo} label {key}.
        slots:
          value: requestBody.value
          color: requestBody.color
          repo: path.repo_identifier
          key: path.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/labels/{key}/values/{value}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a value from a repository label
      effect: destructive
      questions:
      - Can I drop one value from a repo label and keep the rest?
      - How would I remove an obsolete option from a repository's label?
      instructions:
      - text: Delete value {value} from label {key} in repository {repo}.
        slots:
          value: path.value
          key: path.key
          repo: path.repo_identifier
      - text: Remove option {value} of repo {repo} label {key}.
        slots:
          value: path.value
          repo: path.repo_identifier
          key: path.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/labels/{key}/values/{value}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a value on a repository label
      effect: write
      questions:
      - Can I rename one value of a label defined in a repository?
      - Is changing the color of a single repo label value supported?
      instructions:
      - text: Rename value {value} of label {key} in repository {repo} to {new_value}.
        slots:
          value: path.value
          key: path.key
          repo: path.repo_identifier
          new_value: requestBody.value
      - text: Set color {color} on value {value} of repo {repo} label {key}.
        slots:
          color: requestBody.color
          value: path.value
          repo: path.repo_identifier
          key: path.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/labels'].get
  update:
    x-apievangelist-phrasing:
      intent: List the labels on a pull request
      effect: read
      questions:
      - Which labels are currently attached to a pull request?
      - Can I see which labels are still assignable to a pull request?
      instructions:
      - text: Show the labels on pull request {number} in repository {repo}.
        slots:
          number: path.pullreq_number
          repo: path.repo_identifier
      - text: List assignable labels for PR {number} in {repo}.
        slots:
          number: path.pullreq_number
          repo: path.repo_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/labels'].put
  update:
    x-apievangelist-phrasing:
      intent: Assign a label to a pull request
      effect: write
      questions:
      - How do I tag a pull request with a label?
      - Can I set a specific label value when labeling a pull request?
      instructions:
      - text: Add label {label_id} to pull request {number} in repository {repo}.
        slots:
          label_id: requestBody.label_id
          number: path.pullreq_number
          repo: path.repo_identifier
      - text: Label PR {number} in {repo} with {label_id} set to {value}.
        slots:
          number: path.pullreq_number
          repo: path.repo_identifier
          label_id: requestBody.label_id
          value: requestBody.value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/labels/{label_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a label from a pull request
      effect: destructive
      questions:
      - Can I take a label off a pull request without deleting the label?
      - What's the way to unlabel a PR that was tagged by mistake?
      instructions:
      - text: Remove label {label_id} from pull request {number} in repository {repo}.
        slots:
          label_id: path.label_id
          number: path.pullreq_number
          repo: path.repo_identifier
      - text: Unassign {label_id} from PR {number} in {repo}.
        slots:
          label_id: path.label_id
          number: path.pullreq_number
          repo: path.repo_identifier
      method: generated
      generated: '2026-09-26'