Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Project Favorites API

4 actions 4 updates phrasing extends openapi/harness-project-favorites-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 4

$.info

$.paths['/v1/orgs/{org}/projects/{project}/favorites'].post

$.paths['/v1/orgs/{org}/projects/{project}/favorites/{user-id}'].get

$.paths['/v1/orgs/{org}/projects/{project}/favorites/{user-id}'].delete

OpenAPI Overlay

# 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 Favorites API
  version: 1.0.0
extends: openapi/harness-project-favorites-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: 3
- target: $.paths['/v1/orgs/{org}/projects/{project}/favorites'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark a resource as a favorite in a project
      effect: write
      questions:
      - How do I star a pipeline or resource as a favorite in a project?
      - Can I favorite a resource for a specific user?
      instructions:
      - text: Favorite resource {resource} of type {type} in {org}/{project}.
        slots:
          resource: requestBody.resource_id
          type: requestBody.resource_type
          org: path.org
          project: path.project
      - text: Add {resource} to user {user}'s favorites in project {project}, org {org}.
        slots:
          resource: requestBody.resource_id
          user: requestBody.user_id
          project: path.project
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/favorites/{user-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's favorites in a project
      effect: read
      questions:
      - What has a user marked as a favorite in a project?
      - Can I list only a user's favorite pipelines in a project?
      instructions:
      - text: List favorites of user {user} in {org}/{project}.
        slots:
          user: path.user-id
          org: path.org
          project: path.project
      - text: Show user {user}'s favorite {type} resources in project {project}, org {org}.
        slots:
          user: path.user-id
          type: query.resource_type
          project: path.project
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/favorites/{user-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a favorite in a project
      effect: destructive
      questions:
      - How do I unstar a resource I favorited in a project?
      - Can I remove one specific favorite for a user?
      instructions:
      - text: Remove favorite {resource} for user {user} in {org}/{project}.
        slots:
          resource: query.resource_id
          user: path.user-id
          org: path.org
          project: path.project
      - text: Unfavorite all {type} items for user {user} in project {project}, org {org}.
        slots:
          type: query.resource_type
          user: path.user-id
          project: path.project
          org: path.org
      method: generated
      generated: '2026-09-26'