Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Optimizely Rulesets API

5 actions 5 updates phrasing extends openapi/optimizely-rulesets-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 5

$.info

$.paths['/projects/{project_id}/flags/{flag_key}/environments/{environment_key}/ruleset'].get

$.paths['/projects/{project_id}/flags/{flag_key}/environments/{environment_key}/ruleset'].patch

$.paths['/projects/{project_id}/flags/{flag_key}/environments/{environment_key}/ruleset/enabled'].post

$.paths['/projects/{project_id}/flags/{flag_key}/environments/{environment_key}/ruleset/disabled'].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 Optimizely Rulesets API
  version: 1.0.0
extends: openapi/optimizely-rulesets-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: 4
- target: $.paths['/projects/{project_id}/flags/{flag_key}/environments/{environment_key}/ruleset'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a flag's ruleset in an environment
      effect: read
      questions:
      - What rules decide which variation my flag serves in production?
      - Can I see the targeting rules for a flag in one environment?
      instructions:
      - text: Get the ruleset for flag {flag_key} in environment {environment_key} of project {project_id}.
        slots:
          flag_key: path.flag_key
          environment_key: path.environment_key
          project_id: path.project_id
      - text: Show the rules for flag {flag_key} in {environment_key}.
        slots:
          flag_key: path.flag_key
          environment_key: path.environment_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/flags/{flag_key}/environments/{environment_key}/ruleset'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a flag's ruleset in an environment
      effect: write
      questions:
      - How do I change or reorder the rules of a flag in one environment?
      - Can I replace the ordered list of rules for a flag?
      instructions:
      - text: Set the rules for flag {flag_key} in environment {environment_key} of project {project_id} to {rules}.
        slots:
          flag_key: path.flag_key
          environment_key: path.environment_key
          project_id: path.project_id
          rules: requestBody.rules
      - text: Reorder the ruleset of flag {flag_key} in {environment_key}.
        slots:
          flag_key: path.flag_key
          environment_key: path.environment_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/flags/{flag_key}/environments/{environment_key}/ruleset/enabled'].post
  update:
    x-apievangelist-phrasing:
      intent: Turn a flag on in an environment
      effect: write
      questions:
      - How do I switch a feature flag on in production?
      - What makes a flag start delivering variations to visitors?
      instructions:
      - text: Enable flag {flag_key} in environment {environment_key} of project {project_id}.
        slots:
          flag_key: path.flag_key
          environment_key: path.environment_key
          project_id: path.project_id
      - text: Turn on the ruleset for {flag_key} in {environment_key}.
        slots:
          flag_key: path.flag_key
          environment_key: path.environment_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/flags/{flag_key}/environments/{environment_key}/ruleset/disabled'].post
  update:
    x-apievangelist-phrasing:
      intent: Turn a flag off in an environment
      effect: write
      questions:
      - How do I switch a feature flag off in one environment?
      - Can I stop a flag delivering variations without deleting its rules?
      instructions:
      - text: Disable flag {flag_key} in environment {environment_key} of project {project_id}.
        slots:
          flag_key: path.flag_key
          environment_key: path.environment_key
          project_id: path.project_id
      - text: Turn off the ruleset for {flag_key} in {environment_key}.
        slots:
          flag_key: path.flag_key
          environment_key: path.environment_key
      method: generated
      generated: '2026-09-26'