Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Optimizely Features API

6 actions 6 updates phrasing extends openapi/optimizely-features-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 6

$.info
$.paths['/features'].get
$.paths['/features'].post
$.paths['/features/{feature_id}'].get
$.paths['/features/{feature_id}'].delete
$.paths['/features/{feature_id}'].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 Optimizely Features API
  version: 1.0.0
extends: openapi/optimizely-features-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['/features'].get
  update:
    x-apievangelist-phrasing:
      intent: List features in a project
      effect: read
      questions:
      - Which feature flags exist in my project?
      - Can I page through a project's features with a page size?
      instructions:
      - text: List features in project {project_id}.
        slots:
          project_id: query.project_id
      - text: Show page {page} of features for project {project_id}, {per_page} per page.
        slots:
          page: query.page
          project_id: query.project_id
          per_page: query.per_page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/features'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a feature
      effect: write
      questions:
      - How do I create a new feature flag with a key in a project?
      - Can I define feature variables when creating a feature?
      instructions:
      - text: Create feature {key} in project {project_id}.
        slots:
          key: requestBody.key
          project_id: requestBody.project_id
      - text: Add a feature named {name} with key {key} to project {project_id}.
        slots:
          name: requestBody.name
          key: requestBody.key
          project_id: requestBody.project_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/features/{feature_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a feature
      effect: read
      questions:
      - What variables and environment rollouts does a given feature have?
      - Can I retrieve one feature flag's details by ID?
      instructions:
      - text: Show feature {feature_id}.
        slots:
          feature_id: path.feature_id
      - text: Get the configuration of feature {feature_id}.
        slots:
          feature_id: path.feature_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/features/{feature_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Archive a feature
      effect: destructive
      questions:
      - How do I archive a feature flag I no longer use?
      - Does deleting a feature actually archive it?
      instructions:
      - text: Archive feature {feature_id}.
        slots:
          feature_id: path.feature_id
      - text: Retire feature flag {feature_id}.
        slots:
          feature_id: path.feature_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/features/{feature_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a feature
      effect: write
      questions:
      - Can I change a feature's rollout configuration per environment?
      - How do I rename or re-describe an existing feature?
      instructions:
      - text: Rename feature {feature_id} to {name}.
        slots:
          feature_id: path.feature_id
          name: requestBody.name
      - text: Update the environment rollouts of feature {feature_id} to {environments}.
        slots:
          feature_id: path.feature_id
          environments: requestBody.environments
      method: generated
      generated: '2026-09-26'