CloudBees · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for CloudBees Unify API (Current) Flag configurations API

7 actions 7 updates phrasing extends openapi/cloudbees-flag-configurations-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for CloudBees's API. It is a proposal applied on top of the contract, not a document CloudBees publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/v2/applications/{applicationId}/environments/{environmentId}/configuration'].get
$.paths['/v2/applications/{applicationId}/flags/{flagId}/configuration/environments/{environmentId}'].get
$.paths['/v2/applications/{applicationId}/flags/{flagId}/configuration/environments/{environmentId}'].put
$.paths['/v2/applications/{applicationId}/flags/{flagId}/configuration/environments/{environmentId}'].patch
$.paths['/v2/applications/{applicationId}/flags/{flagId}/configuration/environments/{environmentId}/configstate'].post
$.paths['/v2/applications/{applicationId}/flags/{flagId}/environment/{environmentId}/clone'].post

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 CloudBees Unify API (Current) Flag configurations API
  version: 1.0.0
extends: openapi/cloudbees-flag-configurations-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: 6
- target: $.paths['/v2/applications/{applicationId}/environments/{environmentId}/configuration'].get
  update:
    x-apievangelist-phrasing:
      intent: List all flag configurations in an environment
      effect: read
      questions:
      - How can I see how every feature flag is configured in one environment?
      - What are the targeting rules for all flags in my staging environment?
      instructions:
      - text: List the configurations of all flags in environment {environmentId} of app {applicationId}.
        slots:
          environmentId: path.environmentId
          applicationId: path.applicationId
      - text: Show every flag's settings for environment {environmentId} in application {applicationId}.
        slots:
          environmentId: path.environmentId
          applicationId: path.applicationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/applications/{applicationId}/flags/{flagId}/configuration/environments/{environmentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one flag's configuration in an environment
      effect: read
      questions:
      - How do I see the targeting conditions and default value of one flag in production?
      - Is a specific feature flag's configuration using variants in a given environment?
      instructions:
      - text: Show the configuration of flag {flagId} in environment {environmentId} of app {applicationId}.
        slots:
          flagId: path.flagId
          environmentId: path.environmentId
          applicationId: path.applicationId
      - text: Get the default value and conditions for flag {flagId} in environment {environmentId}, app {applicationId}.
        slots:
          flagId: path.flagId
          environmentId: path.environmentId
          applicationId: path.applicationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/applications/{applicationId}/flags/{flagId}/configuration/environments/{environmentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a flag's full configuration in an environment
      effect: write
      questions:
      - How do I overwrite the entire configuration of a flag in one environment?
      - Can I set a new seed for percentage splits when replacing a flag's configuration?
      instructions:
      - text: Replace the full configuration of flag {flagId} in environment {environmentId} of app {applicationId}.
        slots:
          flagId: path.flagId
          environmentId: path.environmentId
          applicationId: path.applicationId
      - text: Overwrite flag {flagId}'s config in env {environmentId}, app {applicationId}, with default value {defaultValue} and stickiness on {stickinessProperty}.
        slots:
          flagId: path.flagId
          environmentId: path.environmentId
          applicationId: path.applicationId
          defaultValue: requestBody.defaultValue
          stickinessProperty: requestBody.stickinessProperty
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/applications/{applicationId}/flags/{flagId}/configuration/environments/{environmentId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change selected fields of a flag's configuration
      effect: write
      questions:
      - Can I change just the default value of a flag in one environment without resending everything?
      - How do I tweak only the targeting conditions of a flag in an environment?
      instructions:
      - text: Change only the default value of flag {flagId} in environment {environmentId}, app {applicationId}, to {defaultValue}.
        slots:
          flagId: path.flagId
          environmentId: path.environmentId
          applicationId: path.applicationId
          defaultValue: requestBody.defaultValue
      - text: 'Patch flag {flagId} in env {environmentId} of app {applicationId} to turn variants on or off: {variantsEnabled}.'
        slots:
          flagId: path.flagId
          environmentId: path.environmentId
          applicationId: path.applicationId
          variantsEnabled: requestBody.variantsEnabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/applications/{applicationId}/flags/{flagId}/configuration/environments/{environmentId}/configstate'].post
  update:
    x-apievangelist-phrasing:
      intent: Turn a flag on or off in an environment
      effect: write
      questions:
      - How do I switch a feature flag on in production?
      - What's the quickest way to disable a flag in a single environment?
      instructions:
      - text: Enable flag {flagId} in environment {environmentId} of application {applicationId}.
        slots:
          flagId: path.flagId
          environmentId: path.environmentId
          applicationId: path.applicationId
      - text: Set flag {flagId}'s on/off state in env {environmentId}, app {applicationId}, to {enabled}.
        slots:
          flagId: path.flagId
          environmentId: path.environmentId
          applicationId: path.applicationId
          enabled: requestBody.enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/applications/{applicationId}/flags/{flagId}/environment/{environmentId}/clone'].post
  update:
    x-apievangelist-phrasing:
      intent: Copy a flag's configuration to other environments
      effect: write
      questions:
      - Can I copy a flag's setup from staging to other environments?
      - How do I reuse one environment's flag configuration elsewhere?
      instructions:
      - text: Clone flag {flagId}'s configuration from environment {environmentId} in app {applicationId} to other environments.
        slots:
          flagId: path.flagId
          environmentId: path.environmentId
          applicationId: path.applicationId
      - text: Copy the settings of flag {flagId} in source environment {environmentId} (app {applicationId}) to my target environments.
        slots:
          flagId: path.flagId
          environmentId: path.environmentId
          applicationId: path.applicationId
      method: generated
      generated: '2026-09-26'