Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Optimizely Flags API

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

What the actions change

x-apievangelist-phrasing

Targets 9

$.info
$.paths['/projects/{project_id}/flags'].get
$.paths['/projects/{project_id}/flags'].post
$.paths['/projects/{project_id}/flags'].patch
$.paths['/projects/{project_id}/flags/{flag_key}'].get
$.paths['/projects/{project_id}/flags/{flag_key}'].delete
$.paths['/projects/{project_id}/flags/{flag_key}'].patch
$.paths['/projects/{project_id}/flags/archived'].post
$.paths['/projects/{project_id}/flags/unarchived'].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 Optimizely Flags API
  version: 1.0.0
extends: openapi/optimizely-flags-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: 8
- target: $.paths['/projects/{project_id}/flags'].get
  update:
    x-apievangelist-phrasing:
      intent: List feature flags in a project
      effect: read
      questions:
      - Which feature flags exist in my Optimizely project?
      - Can I see every flag defined for one project?
      instructions:
      - text: List all feature flags in project {project_id}.
        slots:
          project_id: path.project_id
      - text: Show me the flags configured for project {project_id}.
        slots:
          project_id: path.project_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/flags'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a feature flag
      effect: write
      questions:
      - How do I create a new feature flag in a project?
      - Can I define variables and variations when I first create a flag?
      instructions:
      - text: Create a flag with key {key} named {name} in project {project_id}.
        slots:
          key: requestBody.key
          name: requestBody.name
          project_id: path.project_id
      - text: Add a new feature flag {key} described as {description}.
        slots:
          key: requestBody.key
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/flags'].patch
  update:
    x-apievangelist-phrasing:
      intent: Bulk update flags with a JSON patch
      effect: write
      questions:
      - Can I update several feature flags at once with one JSON patch?
      - What happens to read-only properties included in a bulk flag patch?
      instructions:
      - text: Apply a JSON patch to multiple flags in project {project_id}.
        slots:
          project_id: path.project_id
      - text: Bulk edit many flags at once in project {project_id} using a patch document.
        slots:
          project_id: path.project_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/flags/{flag_key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one feature flag
      effect: read
      questions:
      - What variables and variations does a particular flag have?
      - Can I look up a feature flag by its key?
      instructions:
      - text: Get flag {flag_key} in project {project_id}.
        slots:
          flag_key: path.flag_key
          project_id: path.project_id
      - text: Show the details of feature flag {flag_key}.
        slots:
          flag_key: path.flag_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/flags/{flag_key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a feature flag permanently
      effect: destructive
      questions:
      - How do I permanently delete a feature flag instead of archiving it?
      - Is deleting a flag reversible?
      instructions:
      - text: Permanently delete flag {flag_key} from project {project_id}.
        slots:
          flag_key: path.flag_key
          project_id: path.project_id
      - text: Remove the feature flag {flag_key} for good.
        slots:
          flag_key: path.flag_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/flags/{flag_key}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a single feature flag
      effect: write
      questions:
      - How do I rename one feature flag or change its description?
      - Can I change the variations on just one existing flag?
      instructions:
      - text: Rename flag {flag_key} in project {project_id} to {name}.
        slots:
          flag_key: path.flag_key
          project_id: path.project_id
          name: requestBody.name
      - text: Update the description of the single flag {flag_key} to {description}.
        slots:
          flag_key: path.flag_key
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/flags/archived'].post
  update:
    x-apievangelist-phrasing:
      intent: Archive feature flags
      effect: write
      questions:
      - How do I archive flags I no longer use without deleting them?
      - Can I archive several flags in one request?
      instructions:
      - text: Archive flags {keys} in project {project_id}.
        slots:
          keys: requestBody.keys
          project_id: path.project_id
      - text: Move the flags {keys} into the archive.
        slots:
          keys: requestBody.keys
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/flags/unarchived'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore archived feature flags
      effect: write
      questions:
      - Can I bring archived flags back into use?
      - What call unarchives a group of flags at once?
      instructions:
      - text: Unarchive flags {keys} in project {project_id}.
        slots:
          keys: requestBody.keys
          project_id: path.project_id
      - text: Restore the archived flags {keys}.
        slots:
          keys: requestBody.keys
      method: generated
      generated: '2026-09-26'