# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Optimizely Environments API
  version: 1.0.0
extends: openapi/optimizely-environments-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: 7
- target: $.paths['/environments'].get
  update:
    x-apievangelist-phrasing:
      intent: List environments for a project
      effect: read
      questions:
      - Which environments, like staging and production, exist for my experimentation project?
      - Can I list environments by passing the project id as a query filter?
      instructions:
      - text: List environments for project {project_id} using the project_id filter.
        slots:
          project_id: query.project_id
      - text: Show the environments filtered to project {project_id}.
        slots:
          project_id: query.project_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an environment
      effect: write
      questions:
      - How do I add a new staging environment to my project?
      - Can I mark a newly created environment as the primary one?
      instructions:
      - text: Create environment {name} with key {key}.
        slots:
          name: requestBody.name
          key: requestBody.key
      - text: Create a primary environment named {name}, primary set to {is_primary}.
        slots:
          name: requestBody.name
          is_primary: requestBody.is_primary
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environment_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an environment's details
      effect: read
      questions:
      - Where can I see the key, name and primary flag of one environment?
      - What details does Optimizely return for a single environment?
      instructions:
      - text: Get environment {environment_id}.
        slots:
          environment_id: path.environment_id
      - text: Show the details of environment {environment_id}.
        slots:
          environment_id: path.environment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environment_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Archive an environment
      effect: destructive
      questions:
      - How do I archive an environment I no longer use?
      - Does removing an environment archive it rather than erase it?
      instructions:
      - text: Archive environment {environment_id}.
        slots:
          environment_id: path.environment_id
      - text: Retire the environment {environment_id} by archiving it.
        slots:
          environment_id: path.environment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environment_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an environment
      effect: write
      questions:
      - Can I rename an existing environment?
      - How do I make a different environment the primary one?
      instructions:
      - text: Rename environment {environment_id} to {name}.
        slots:
          environment_id: path.environment_id
          name: requestBody.name
      - text: Set primary on environment {environment_id} to {is_primary}.
        slots:
          environment_id: path.environment_id
          is_primary: requestBody.is_primary
      - text: Change the key of environment {environment_id} to {key}.
        slots:
          environment_id: path.environment_id
          key: requestBody.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/environments'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's environments with paging and filters
      effect: read
      questions:
      - Can I list only the archived environments under a project path?
      - Is there a paginated, sortable list of environments nested under a project?
      instructions:
      - text: List environments under project {project_id} with archived set to {archived}.
        slots:
          project_id: path.project_id
          archived: query.archived
      - text: Show {per_page} environments per page for project {project_id}, sorted by {sort}.
        slots:
          project_id: path.project_id
          per_page: query.per_page
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environment_id}/datafile'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the datafile for an environment
      effect: read
      questions:
      - How do I download the JSON datafile the SDK uses for an environment?
      - Where can I see every experiment, feature and audience running in one environment as a datafile?
      instructions:
      - text: Get the datafile for environment {environment_id}.
        slots:
          environment_id: path.environment_id
      - text: Download the SDK datafile JSON of environment {environment_id}.
        slots:
          environment_id: path.environment_id
      method: generated
      generated: '2026-09-26'