Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Optimizely Flags Scheduling Scheduled Changes API

3 actions 3 updates phrasing extends openapi/optimizely-scheduled-changes-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 3

$.info
$.paths['/projects/{project_id}/flags/{flag_key}/schedules'].get
$.paths['/projects/{project_id}/flags/{flag_key}/schedules'].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 Scheduling Scheduled Changes API
  version: 1.0.0
extends: openapi/optimizely-scheduled-changes-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['/projects/{project_id}/flags/{flag_key}/schedules'].get
  update:
    x-apievangelist-phrasing:
      intent: List a feature flag's scheduled changes
      effect: read
      questions:
      - What changes are scheduled for my feature flag, and when do they run?
      - Can I see only the flag changes scheduled for production next week?
      - Which scheduled changes apply to one specific targeting rule?
      instructions:
      - text: List scheduled changes for flag {flag_key} in project {project_id}.
        slots:
          flag_key: path.flag_key
          project_id: path.project_id
      - text: Show changes to flag {flag_key} in project {project_id} scheduled in environment {environment} between {scheduled_from} and {scheduled_till}.
        slots:
          flag_key: path.flag_key
          project_id: path.project_id
          environment: query.environment
          scheduled_from: query.scheduled_from
          scheduled_till: query.scheduled_till
      - text: List flag {flag_key}'s scheduled changes that apply to rule {applies_to}.
        slots:
          flag_key: path.flag_key
          applies_to: query.applies_to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/flags/{flag_key}/schedules'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a change to a feature flag
      effect: write
      questions:
      - How do I schedule a feature flag to turn on at a specific time?
      - Can I schedule flag rule updates for just one environment?
      instructions:
      - text: Schedule actions {actions} on flag {flag_key} in project {project_id} for environment {environment} at {schedule} under account {account_id}.
        slots:
          actions: requestBody.actions
          flag_key: path.flag_key
          project_id: path.project_id
          environment: requestBody.environment
          schedule: requestBody.schedule
          account_id: requestBody.account_id
      - text: Schedule flag {flag_key} to change in {environment} at {schedule}.
        slots:
          flag_key: path.flag_key
          environment: requestBody.environment
          schedule: requestBody.schedule
      method: generated
      generated: '2026-09-26'