LaunchDarkly · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for LaunchDarkly REST Segments API

6 actions 6 updates phrasing extends openapi/launchdarkly-segments-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for LaunchDarkly's API. It is a proposal applied on top of the contract, not a document LaunchDarkly publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/segments/{projectKey}/{environmentKey}'].get

$.paths['/segments/{projectKey}/{environmentKey}'].post

$.paths['/segments/{projectKey}/{environmentKey}/{segmentKey}'].get

$.paths['/segments/{projectKey}/{environmentKey}/{segmentKey}'].delete

$.paths['/segments/{projectKey}/{environmentKey}/{segmentKey}'].patch

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 LaunchDarkly REST Segments API
  version: 1.0.0
extends: openapi/launchdarkly-segments-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: 5
- target: $.paths['/segments/{projectKey}/{environmentKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: List segments in an environment
      effect: read
      questions:
      - What user segments exist in this environment?
      - Can I page through segments in a project environment?
      instructions:
      - text: List segments in {projectKey}/{environmentKey}.
        slots:
          projectKey: path.projectKey
          environmentKey: path.environmentKey
      - text: Show {limit} segments in {projectKey}/{environmentKey} from offset {offset}.
        slots:
          limit: query.limit
          projectKey: path.projectKey
          environmentKey: path.environmentKey
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/segments/{projectKey}/{environmentKey}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a user segment
      effect: write
      questions:
      - How do I create a segment of beta users?
      - Can I tag a segment when creating it?
      instructions:
      - text: Create segment {name} with key {key} in {projectKey}/{environmentKey}.
        slots:
          name: requestBody.name
          key: requestBody.key
          projectKey: path.projectKey
          environmentKey: path.environmentKey
      - text: Add a segment {key} named {name} in {projectKey}/{environmentKey} tagged {tags}.
        slots:
          key: requestBody.key
          name: requestBody.name
          projectKey: path.projectKey
          environmentKey: path.environmentKey
          tags: requestBody.tags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/segments/{projectKey}/{environmentKey}/{segmentKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one segment
      effect: read
      questions:
      - How do I see who is included in a specific segment?
      - What are the rules on a particular segment?
      instructions:
      - text: Get segment {segmentKey} in {projectKey}/{environmentKey}.
        slots:
          segmentKey: path.segmentKey
          projectKey: path.projectKey
          environmentKey: path.environmentKey
      - text: Show the details of segment {segmentKey} in {projectKey}/{environmentKey}.
        slots:
          segmentKey: path.segmentKey
          projectKey: path.projectKey
          environmentKey: path.environmentKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/segments/{projectKey}/{environmentKey}/{segmentKey}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a segment
      effect: destructive
      questions:
      - How do I permanently delete a segment?
      - Can a deleted segment be recovered?
      instructions:
      - text: Delete segment {segmentKey} from {projectKey}/{environmentKey}.
        slots:
          segmentKey: path.segmentKey
          projectKey: path.projectKey
          environmentKey: path.environmentKey
      - text: Permanently remove segment {segmentKey} in {projectKey}/{environmentKey}.
        slots:
          segmentKey: path.segmentKey
          projectKey: path.projectKey
          environmentKey: path.environmentKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/segments/{projectKey}/{environmentKey}/{segmentKey}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a segment
      effect: write
      questions:
      - How do I add users to an existing segment?
      - Can I change a segment's rules with a semantic patch?
      instructions:
      - text: Update segment {segmentKey} in {projectKey}/{environmentKey} with patch {patch}.
        slots:
          segmentKey: path.segmentKey
          projectKey: path.projectKey
          environmentKey: path.environmentKey
          patch: requestBody.patch
      - text: Apply {patch} to segment {segmentKey} in {projectKey}/{environmentKey}, commenting {comment}.
        slots:
          patch: requestBody.patch
          segmentKey: path.segmentKey
          projectKey: path.projectKey
          environmentKey: path.environmentKey
          comment: requestBody.comment
      method: generated
      generated: '2026-09-26'