Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Optimizely Flags Scheduling Scheduled Change API

3 actions 3 updates phrasing extends openapi/optimizely-scheduled-change-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/{schedule_id}'].delete
$.paths['/projects/{project_id}/flags/{flag_key}/schedules/{schedule_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 Flags Scheduling Scheduled Change API
  version: 1.0.0
extends: openapi/optimizely-scheduled-change-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/{schedule_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a flag's scheduled change
      effect: destructive
      questions:
      - How do I cancel a scheduled change on a feature flag?
      - Can I remove a scheduled rollout for a flag before it runs?
      instructions:
      - text: Delete scheduled change {schedule_id} on flag {flag_key} in project {project_id}.
        slots:
          schedule_id: path.schedule_id
          flag_key: path.flag_key
          project_id: path.project_id
      - text: Cancel schedule {schedule_id} for flag {flag_key} (project {project_id}).
        slots:
          schedule_id: path.schedule_id
          flag_key: path.flag_key
          project_id: path.project_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/flags/{flag_key}/schedules/{schedule_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a flag's scheduled change
      effect: write
      questions:
      - How can I reschedule a planned change to a feature flag?
      - Can I change which actions a scheduled flag change will perform?
      instructions:
      - text: Reschedule change {schedule_id} on flag {flag_key} in project {project_id} to {schedule}.
        slots:
          schedule_id: path.schedule_id
          flag_key: path.flag_key
          project_id: path.project_id
          schedule: requestBody.schedule
      - text: Set actions {actions} on scheduled change {schedule_id} for flag {flag_key}, project {project_id}, environment {environment}.
        slots:
          actions: requestBody.actions
          schedule_id: path.schedule_id
          flag_key: path.flag_key
          project_id: path.project_id
          environment: requestBody.environment
      method: generated
      generated: '2026-09-26'