LaunchDarkly · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for LaunchDarkly REST Environments API

6 actions 6 updates phrasing extends openapi/launchdarkly-environments-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['/projects/{projectKey}/environments'].get
$.paths['/projects/{projectKey}/environments'].post
$.paths['/projects/{projectKey}/environments/{environmentKey}'].get
$.paths['/projects/{projectKey}/environments/{environmentKey}'].delete
$.paths['/projects/{projectKey}/environments/{environmentKey}'].patch

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 LaunchDarkly REST Environments API
  version: 1.0.0
extends: openapi/launchdarkly-environments-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['/projects/{projectKey}/environments'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's environments
      effect: read
      questions:
      - What environments exist in this project?
      - Can I page through environments when a project has many?
      instructions:
      - text: List environments in project {projectKey}.
        slots:
          projectKey: path.projectKey
      - text: Show {limit} environments of {projectKey} from offset {offset}.
        slots:
          limit: query.limit
          projectKey: path.projectKey
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{projectKey}/environments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an environment in a project
      effect: write
      questions:
      - How do I add a new staging environment to a project?
      - Can I turn on secure mode when creating an environment?
      - What's required to set up a new environment besides a name?
      instructions:
      - text: Create environment {name} with key {key} and color {color} in project {projectKey}.
        slots:
          name: requestBody.name
          key: requestBody.key
          color: requestBody.color
          projectKey: path.projectKey
      - text: Add a {key} environment to {projectKey} named {name}, colored {color}, with secure mode {secureMode}.
        slots:
          key: requestBody.key
          projectKey: path.projectKey
          name: requestBody.name
          color: requestBody.color
          secureMode: requestBody.secureMode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{projectKey}/environments/{environmentKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one environment's details
      effect: read
      questions:
      - How do I look up the settings of a specific environment?
      - What are the current settings of a single environment in a project?
      instructions:
      - text: Get environment {environmentKey} in project {projectKey}.
        slots:
          environmentKey: path.environmentKey
          projectKey: path.projectKey
      - text: Show details for the {environmentKey} environment of {projectKey}.
        slots:
          environmentKey: path.environmentKey
          projectKey: path.projectKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{projectKey}/environments/{environmentKey}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an environment
      effect: destructive
      questions:
      - How do I permanently remove an environment from a project?
      - Is deleting an environment reversible?
      instructions:
      - text: Delete environment {environmentKey} from project {projectKey}.
        slots:
          environmentKey: path.environmentKey
          projectKey: path.projectKey
      - text: Permanently remove the {environmentKey} environment in {projectKey}.
        slots:
          environmentKey: path.environmentKey
          projectKey: path.projectKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{projectKey}/environments/{environmentKey}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an environment's settings
      effect: write
      questions:
      - How do I rename an environment or change its color?
      - Can I leave a comment explaining an environment change?
      instructions:
      - text: Update environment {environmentKey} in {projectKey} with patch {patch}.
        slots:
          environmentKey: path.environmentKey
          projectKey: path.projectKey
          patch: requestBody.patch
      - text: Apply {patch} to the {environmentKey} environment of {projectKey} with comment {comment}.
        slots:
          patch: requestBody.patch
          environmentKey: path.environmentKey
          projectKey: path.projectKey
          comment: requestBody.comment
      method: generated
      generated: '2026-09-26'