CloudBees · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/cloudbees-flag-lifecycle-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 3

$.info

$.paths['/v1/applications/{organizationId}/environments/{environmentId}/flags-status'].get

$.paths['/v1/applications/{organizationId}/environments/{environmentId}/impressions'].post

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 CloudBees Unify API (Current) Flag lifecycle API
  version: 1.0.0
extends: openapi/cloudbees-flag-lifecycle-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: 2
- target: $.paths['/v1/applications/{organizationId}/environments/{environmentId}/flags-status'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the status of all flags in an environment
      effect: read
      questions:
      - What is the current status of every feature flag in an environment?
      - Can I see which flags in production look stale or inactive?
      instructions:
      - text: Show the status of all flags in environment {environmentId} of application {organizationId}.
        slots:
          environmentId: path.environmentId
          organizationId: path.organizationId
      - text: Get flag lifecycle statuses for env {environmentId} in app {organizationId}.
        slots:
          environmentId: path.environmentId
          organizationId: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/applications/{organizationId}/environments/{environmentId}/impressions'].post
  update:
    x-apievangelist-phrasing:
      intent: Get impression counts for feature flags
      effect: read
      questions:
      - How many times has a feature flag been evaluated over the last day?
      - Can I get daily impression data for a flag covering the last 30 days?
      - Is impression data available hourly as well as daily?
      instructions:
      - text: Get impressions for flag {flagname} in environment {environmentId} of app {organizationId}.
        slots:
          flagname: requestBody.flagname
          environmentId: path.environmentId
          organizationId: path.organizationId
      - text: Show {mode} impressions for flag {flagname} in env {environmentId}, app {organizationId}, from {from} to {to}.
        slots:
          mode: requestBody.mode
          flagname: requestBody.flagname
          environmentId: path.environmentId
          organizationId: path.organizationId
          from: requestBody.from
          to: requestBody.to
      method: generated
      generated: '2026-09-26'