Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Target Groups API

8 actions 8 updates phrasing extends openapi/harness-target-groups-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 8

$.info
$.paths['/cf/admin/segments'].get
$.paths['/cf/admin/segments'].post
$.paths['/cf/admin/segments/{identifier}'].get
$.paths['/cf/admin/segments/{identifier}'].delete
$.paths['/cf/admin/segments/{identifier}'].patch
$.paths['/cf/admin/segments/{identifier}/available_flags'].get
$.paths['/cf/admin/segments/{identifier}/flags'].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 Target Groups API
  version: 1.0.0
extends: openapi/harness-target-groups-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: 7
- target: $.paths['/cf/admin/segments'].get
  update:
    x-apievangelist-phrasing:
      intent: List feature flag target groups
      effect: read
      questions:
      - Which target groups exist in my feature flag environment?
      - Can I search target groups by name?
      instructions:
      - text: List target groups in environment {env}.
        slots:
          env: query.environmentIdentifier
      - text: Find target groups named {name} in environment {env}.
        slots:
          name: query.name
          env: query.environmentIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cf/admin/segments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a target group
      effect: write
      questions:
      - Can I create a group of targets to roll a feature flag out to?
      - Is it possible to include and exclude specific targets when creating a group?
      instructions:
      - text: Create target group {name} in project {project} and environment {env}.
        slots:
          name: requestBody.name
          project: requestBody.project
          env: requestBody.environment
      - text: Create target group {name} with rules {rules}.
        slots:
          name: requestBody.name
          rules: requestBody.rules
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cf/admin/segments/{identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a target group
      effect: read
      questions:
      - What rules and members does a specific target group have?
      - Can I view one target group's details by its identifier?
      instructions:
      - text: Get target group {group} in environment {env}.
        slots:
          group: path.identifier
          env: query.environmentIdentifier
      - text: Show target group {group} with its rules.
        slots:
          group: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cf/admin/segments/{identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a target group
      effect: destructive
      questions:
      - Can I delete a target group I no longer use?
      - What is removed when I delete a feature flag target group?
      instructions:
      - text: Delete target group {group} from environment {env}.
        slots:
          group: path.identifier
          env: query.environmentIdentifier
      - text: Remove target group {group}.
        slots:
          group: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cf/admin/segments/{identifier}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a target group
      effect: write
      questions:
      - Can I add or remove targets in an existing target group?
      - Is it possible to schedule a change to a target group for later?
      instructions:
      - text: Update target group {group} with instructions {instructions}.
        slots:
          group: path.identifier
          instructions: requestBody.instructions
      - text: Patch target group {group} with {instructions} and comment {comment}.
        slots:
          group: path.identifier
          instructions: requestBody.instructions
          comment: requestBody.comment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cf/admin/segments/{identifier}/available_flags'].get
  update:
    x-apievangelist-phrasing:
      intent: List flags a target group can be added to
      effect: read
      questions:
      - Which feature flags could I still add this target group to?
      - Can I search the flags a target group isn't part of yet?
      instructions:
      - text: List flags available to target group {group}.
        slots:
          group: path.identifier
      - text: Search flags not yet used by target group {group} for {name}.
        slots:
          group: path.identifier
          name: query.flagNameIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cf/admin/segments/{identifier}/flags'].get
  update:
    x-apievangelist-phrasing:
      intent: List feature flags that use a target group
      effect: read
      questions:
      - Which feature flags currently include a given target group?
      - What flags is this target group already part of?
      instructions:
      - text: List feature flags in target group {group}.
        slots:
          group: path.identifier
      - text: Show flags that target group {group} belongs to in environment {env}.
        slots:
          group: path.identifier
          env: query.environmentIdentifier
      method: generated
      generated: '2026-09-26'