# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for CloudBees Unify API (Current) Target groups API
  version: 1.0.0
extends: openapi/cloudbees-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: 8
- target: $.paths['/v2/applications/{applicationId}/target-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List target groups in an application
      effect: read
      questions:
      - Which target groups are defined in my application?
      - What audiences have I set up for flag targeting?
      instructions:
      - text: List the target groups in application {applicationId}.
        slots:
          applicationId: path.applicationId
      - text: Show all audience groups defined in app {applicationId}.
        slots:
          applicationId: path.applicationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/applications/{applicationId}/target-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a target group
      effect: write
      questions:
      - How do I create a target group of beta users to target flags at?
      - Can a target group be defined by conditions on user properties?
      instructions:
      - text: Create a target group named {name} in application {applicationId}.
        slots:
          name: requestBody.name
          applicationId: path.applicationId
      - text: Add target group {name} to app {applicationId} with conditions {conditions}.
        slots:
          name: requestBody.name
          applicationId: path.applicationId
          conditions: requestBody.conditions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/applications/{applicationId}/target-groups/by-name/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a target group by name
      effect: read
      questions:
      - Can I fetch a target group if I only know its name?
      - What conditions does the target group called 'beta-testers' use?
      instructions:
      - text: Find the target group named {name} in application {applicationId}.
        slots:
          name: path.name
          applicationId: path.applicationId
      - text: Look up target group {name} by name in app {applicationId}.
        slots:
          name: path.name
          applicationId: path.applicationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/applications/{applicationId}/target-groups/with-flags-usage'].get
  update:
    x-apievangelist-phrasing:
      intent: List target groups with the flags using them
      effect: read
      questions:
      - Which flags use each of my target groups?
      - Can I list target groups together with the feature flags that reference them?
      instructions:
      - text: List target groups in app {applicationId} along with the flags that use each.
        slots:
          applicationId: path.applicationId
      - text: Show every target group and its referencing flags for application {applicationId}.
        slots:
          applicationId: path.applicationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/applications/{applicationId}/target-groups/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a target group by ID
      effect: read
      questions:
      - How do I retrieve a target group when I have its ID?
      - What description and conditions does a given target group ID have?
      instructions:
      - text: Get target group {id} in application {applicationId}.
        slots:
          id: path.id
          applicationId: path.applicationId
      - text: Show the details of target group ID {id} in app {applicationId}.
        slots:
          id: path.id
          applicationId: path.applicationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/applications/{applicationId}/target-groups/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a target group
      effect: write
      questions:
      - How do I change the conditions of an existing target group?
      - Can I rename a target group?
      instructions:
      - text: Update the conditions of target group {id} in app {applicationId} to {conditions}.
        slots:
          id: path.id
          applicationId: path.applicationId
          conditions: requestBody.conditions
      - text: Rename existing target group {id} in application {applicationId} to {name}.
        slots:
          id: path.id
          applicationId: path.applicationId
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/applications/{applicationId}/target-groups/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a target group
      effect: destructive
      questions:
      - How do I permanently delete a target group?
      - Can a deleted target group be restored?
      instructions:
      - text: Delete target group {id} from application {applicationId}.
        slots:
          id: path.id
          applicationId: path.applicationId
      - text: Permanently remove target group {id} in app {applicationId}.
        slots:
          id: path.id
          applicationId: path.applicationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/applications/{applicationId}/target-groups/{id}/flag-usage-per-environment'].get
  update:
    x-apievangelist-phrasing:
      intent: See which flags use a target group, by environment
      effect: read
      questions:
      - Which feature flags reference one target group in each environment?
      - Is a specific target group still used by flags in production?
      instructions:
      - text: Show which flags use target group {id} in each environment of app {applicationId}.
        slots:
          id: path.id
          applicationId: path.applicationId
      - text: List per-environment flag usage of target group {id} in application {applicationId}.
        slots:
          id: path.id
          applicationId: path.applicationId
      method: generated
      generated: '2026-09-26'