LaunchDarkly · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Launchdarkly Projects API

12 actions 12 updates phrasing extends openapi/launchdarkly-projects-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 12

$.info
$.paths['/projects'].get
$.paths['/projects'].post
$.paths['/projects/{projectKey}'].get
$.paths['/projects/{projectKey}'].post
$.paths['/projects/{projectKey}'].delete
$.paths['/projects/{projectKey}'].patch
$.paths['/projects/{projectKey}/import'].post
$.paths['/projects/{projectKey}/overrides'].delete
$.paths['/projects/{projectKey}/overrides/{flagKey}'].put
$.paths['/projects/{projectKey}/overrides/{flagKey}'].delete
$.paths['/projects/{projectKey}/environments'].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 Launchdarkly Projects API
  version: 1.0.0
extends: openapi/launchdarkly-projects-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: 11
- target: $.paths['/projects'].get
  update:
    x-apievangelist-phrasing:
      intent: List projects on the dev server
      effect: read
      questions:
      - Which projects are configured on my local dev server?
      - What projects has the dev server been set up to sync?
      instructions:
      - text: List projects on the dev server.
      - text: Show every project configured in my local dev server.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new project
      effect: write
      questions:
      - How do I create a new project with its own environments?
      - Can I tag a project when I create it?
      instructions:
      - text: Create project {name} with key {key}.
        slots:
          name: requestBody.name
          key: requestBody.key
      - text: Create a new project {key} called {name} with environments {environments}.
        slots:
          key: requestBody.key
          name: requestBody.name
          environments: requestBody.environments
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{projectKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a dev server project's sync configuration
      effect: read
      questions:
      - How do I see how a project is configured to sync on the dev server?
      - Can I expand the dev server project to include flag state?
      instructions:
      - text: Get dev server project {projectKey}.
        slots:
          projectKey: path.projectKey
      - text: Show dev server project {projectKey} expanded with {expand}.
        slots:
          projectKey: path.projectKey
          expand: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{projectKey}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a project to the dev server
      effect: write
      questions:
      - How do I add a project to my local dev server?
      - Which source environment does the dev server copy flags from?
      instructions:
      - text: Add project {projectKey} to the dev server, syncing from {sourceEnvironmentKey}.
        slots:
          projectKey: path.projectKey
          sourceEnvironmentKey: requestBody.sourceEnvironmentKey
      - text: Add {projectKey} to the dev server from {sourceEnvironmentKey} using context {context}.
        slots:
          projectKey: path.projectKey
          sourceEnvironmentKey: requestBody.sourceEnvironmentKey
          context: requestBody.context
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{projectKey}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a project from the dev server
      effect: destructive
      questions:
      - How do I remove a project from the local dev server?
      - Can I stop the dev server from tracking a project?
      instructions:
      - text: Remove project {projectKey} from the dev server.
        slots:
          projectKey: path.projectKey
      - text: Stop syncing {projectKey} on my dev server.
        slots:
          projectKey: path.projectKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{projectKey}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update or resync a dev server project
      effect: write
      questions:
      - How do I force the dev server to resync a project?
      - Can I change the evaluation context the dev server uses for a project?
      instructions:
      - text: Force a sync of dev server project {projectKey}.
        slots:
          projectKey: path.projectKey
      - text: Switch dev server project {projectKey} to source environment {sourceEnvironmentKey}.
        slots:
          projectKey: path.projectKey
          sourceEnvironmentKey: requestBody.sourceEnvironmentKey
      - text: Set the context for dev server project {projectKey} to {context}.
        slots:
          projectKey: path.projectKey
          context: requestBody.context
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{projectKey}/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import a project from exported JSON
      effect: write
      questions:
      - How do I load a previously exported project into the dev server?
      - Can I import flag state and overrides from a JSON export?
      instructions:
      - text: Import project {projectKey} from source environment {sourceEnvironmentKey} with context {context}, last synced {_lastSyncedFromSource}.
        slots:
          projectKey: path.projectKey
          sourceEnvironmentKey: requestBody.sourceEnvironmentKey
          context: requestBody.context
          _lastSyncedFromSource: requestBody._lastSyncedFromSource
      - text: Import {projectKey} from JSON including flag state {flagsState} and overrides {overrides}.
        slots:
          projectKey: path.projectKey
          flagsState: requestBody.flagsState
          overrides: requestBody.overrides
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{projectKey}/overrides'].delete
  update:
    x-apievangelist-phrasing:
      intent: Clear all flag overrides for a project
      effect: destructive
      questions:
      - How do I reset every local flag override in a project?
      - Can I wipe all overrides at once on the dev server?
      instructions:
      - text: Remove all overrides for project {projectKey}.
        slots:
          projectKey: path.projectKey
      - text: Clear every flag override in {projectKey}.
        slots:
          projectKey: path.projectKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{projectKey}/overrides/{flagKey}'].put
  update:
    x-apievangelist-phrasing:
      intent: Override a flag's value locally
      effect: write
      questions:
      - How do I force a flag to a specific value on my dev server?
      - Can I override one flag locally without changing it in LaunchDarkly?
      instructions:
      - text: Override flag {flagKey} in project {projectKey}.
        slots:
          flagKey: path.flagKey
          projectKey: path.projectKey
      - text: Set a local override value for {flagKey} in {projectKey}.
        slots:
          flagKey: path.flagKey
          projectKey: path.projectKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{projectKey}/overrides/{flagKey}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove one flag's local override
      effect: destructive
      questions:
      - How do I undo the override on a single flag?
      - Can I return one flag to its synced value on the dev server?
      instructions:
      - text: Remove the override on flag {flagKey} in {projectKey}.
        slots:
          flagKey: path.flagKey
          projectKey: path.projectKey
      - text: Clear the dev server override for {flagKey} in project {projectKey}.
        slots:
          flagKey: path.flagKey
          projectKey: path.projectKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{projectKey}/environments'].get
  update:
    x-apievangelist-phrasing:
      intent: List a dev server project's environments
      effect: read
      questions:
      - Which environments can the dev server sync for a project?
      - Can I search a project's environments by name on the dev server?
      instructions:
      - text: List environments for dev server project {projectKey}.
        slots:
          projectKey: path.projectKey
      - text: Find environments named {name} in {projectKey}, up to {limit}.
        slots:
          name: query.name
          projectKey: path.projectKey
          limit: query.limit
      method: generated
      generated: '2026-09-26'