Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Org Favorites API

4 actions 4 updates phrasing extends openapi/harness-org-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}/favorites'].post

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

$.paths['/v1/orgs/{org}/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 Org Favorites API
  version: 1.0.0
extends: openapi/harness-org-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}/favorites'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a favorite for a user in an organization
      effect: write
      questions:
      - Can I star a pipeline or other resource as a favorite at the organization level?
      - How do I save a resource to a user's org favorites?
      instructions:
      - text: Add {resource_id} of type {resource_type} to user {user_id}'s favorites in org {org}.
        slots:
          resource_id: requestBody.resource_id
          resource_type: requestBody.resource_type
          user_id: requestBody.user_id
          org: path.org
      - text: Favorite resource {resource_id} for me in organization {org}.
        slots:
          resource_id: requestBody.resource_id
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/favorites/{user-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's favorites in an organization
      effect: read
      questions:
      - What resources has a user starred as favorites in an organization?
      - Can I list only one resource type from a user's org favorites?
      instructions:
      - text: List user {user_id}'s favorites in org {org}.
        slots:
          user_id: path.user-id
          org: path.org
      - text: Show {user_id}'s org-level favorites of type {resource_type} in {org}.
        slots:
          user_id: path.user-id
          resource_type: query.resource_type
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/favorites/{user-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a favorite for a user in an organization
      effect: destructive
      questions:
      - Can I unstar a resource from a user's organization favorites?
      - What's the way to clear a favorite at the org level?
      instructions:
      - text: Remove {resource_id} from user {user_id}'s favorites in org {org}.
        slots:
          resource_id: query.resource_id
          user_id: path.user-id
          org: path.org
      - text: Unfavorite the {resource_type} {resource_id} for {user_id} in organization {org}.
        slots:
          resource_type: query.resource_type
          resource_id: query.resource_id
          user_id: path.user-id
          org: path.org
      method: generated
      generated: '2026-09-26'