Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Feature Flags API

9 actions 9 updates phrasing extends openapi/harness-feature-flags-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 9

$.info
$.paths['/cf/admin/features'].get
$.paths['/cf/admin/features'].post
$.paths['/cf/admin/features/{identifier}'].get
$.paths['/cf/admin/features/{identifier}'].put
$.paths['/cf/admin/features/{identifier}'].delete
$.paths['/cf/admin/features/{identifier}'].patch
$.paths['/cf/admin/features/{identifier}/dependants'].get
$.paths['/cf/admin/features/{identifier}/restore'].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 Feature Flags API
  version: 1.0.0
extends: openapi/harness-feature-flags-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: 8
- target: $.paths['/cf/admin/features'].get
  update:
    x-apievangelist-phrasing:
      intent: List feature flags in a project
      effect: read
      questions:
      - What feature flags exist in my Harness project?
      - Can I list only the flags that are enabled in one environment?
      - Which flags are archived or stale and could be cleaned up?
      instructions:
      - text: List all feature flags in project {project} of org {org}.
        slots:
          project: query.projectIdentifier
          org: query.orgIdentifier
      - text: Show flags in project {project} whose status is {status} in environment {environment}.
        slots:
          project: query.projectIdentifier
          status: query.status
          environment: query.environmentIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cf/admin/features'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a feature flag
      effect: write
      questions:
      - How do I create a new boolean feature flag with on and off variations?
      - Can I make a permanent flag rather than a temporary one?
      instructions:
      - text: Create a {kind} feature flag {name} with identifier {identifier} in project {project}.
        slots:
          kind: requestBody.kind
          name: requestBody.name
          identifier: requestBody.identifier
          project: requestBody.project
      - text: Add flag {identifier} serving {defaultOnVariation} when on and {defaultOffVariation} when off.
        slots:
          identifier: requestBody.identifier
          defaultOnVariation: requestBody.defaultOnVariation
          defaultOffVariation: requestBody.defaultOffVariation
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cf/admin/features/{identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a feature flag
      effect: read
      questions:
      - What variations and default values does a specific feature flag have?
      - Is one flag turned on in a given environment?
      instructions:
      - text: Show feature flag {identifier} in project {project}.
        slots:
          identifier: path.identifier
          project: query.projectIdentifier
      - text: Get the state of flag {identifier} in environment {environment}.
        slots:
          identifier: path.identifier
          environment: query.environmentIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cf/admin/features/{identifier}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a feature flag's definition
      effect: write
      questions:
      - Can I rewrite a flag's name, description and variations in one full update?
      - How do I change the default on and off variations of an existing flag?
      instructions:
      - text: Replace the definition of flag {identifier} with name {name} and variations {variations}.
        slots:
          identifier: path.identifier
          name: requestBody.name
          variations: requestBody.variations
      - text: Set the default on variation of flag {identifier} to {defaultOnVariation}.
        slots:
          identifier: path.identifier
          defaultOnVariation: requestBody.defaultOnVariation
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cf/admin/features/{identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a feature flag
      effect: destructive
      questions:
      - Can I permanently delete a feature flag that's no longer used?
      - Is there a force option to delete a flag other flags depend on?
      instructions:
      - text: Delete feature flag {identifier} from project {project}.
        slots:
          identifier: path.identifier
          project: query.projectIdentifier
      - text: Force delete flag {identifier} with commit message {commitMsg}.
        slots:
          identifier: path.identifier
          commitMsg: query.commitMsg
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cf/admin/features/{identifier}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Turn a feature flag on or off or change its rules
      effect: write
      questions:
      - How do I turn a feature flag on in production?
      - Can I schedule a flag change to happen at a later time?
      - Can I change the serving rules of a flag in one environment?
      instructions:
      - text: Turn flag {identifier} on in environment {environment}.
        slots:
          identifier: path.identifier
          environment: query.environmentIdentifier
      - text: Apply the instructions {instructions} to flag {identifier} with comment {comment}.
        slots:
          instructions: requestBody.instructions
          identifier: path.identifier
          comment: requestBody.comment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cf/admin/features/{identifier}/dependants'].get
  update:
    x-apievangelist-phrasing:
      intent: List flags that depend on a feature flag
      effect: read
      questions:
      - Which other flags use this flag as a prerequisite?
      - Will anything break if I remove a flag that others depend on?
      instructions:
      - text: List the flags that depend on flag {identifier}.
        slots:
          identifier: path.identifier
      - text: Show dependants of feature flag {identifier} in project {project}.
        slots:
          identifier: path.identifier
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cf/admin/features/{identifier}/restore'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore an archived feature flag
      effect: write
      questions:
      - Can I bring back a feature flag that was archived?
      - Is it possible to undo archiving a flag?
      instructions:
      - text: Restore archived feature flag {identifier}.
        slots:
          identifier: path.identifier
      - text: Unarchive flag {identifier} in project {project} with commit message {commitMsg}.
        slots:
          identifier: path.identifier
          project: query.projectIdentifier
          commitMsg: query.commitMsg
      method: generated
      generated: '2026-09-26'