Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Permission Service Team Management API

6 actions 6 updates phrasing extends openapi/optimizely-team-management-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['/accounts/{account_id}/teams'].get
$.paths['/accounts/{account_id}/teams'].post
$.paths['/accounts/{account_id}/teams/{team_id}'].get
$.paths['/accounts/{account_id}/teams/{team_id}'].delete
$.paths['/accounts/{account_id}/teams/{team_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 Permission Service Team Management API
  version: 1.0.0
extends: openapi/optimizely-team-management-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['/accounts/{account_id}/teams'].get
  update:
    x-apievangelist-phrasing:
      intent: List teams in an account
      effect: read
      questions:
      - What teams have been set up in my Optimizely account?
      - Can I see every team defined for an account in one call?
      instructions:
      - text: List all teams in account {account_id}.
        slots:
          account_id: path.account_id
      - text: Show me the teams for account {account_id}.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/teams'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a team
      effect: write
      questions:
      - How do I set up a new team and add people to it?
      - Can I store an external reference id on a team when creating it?
      instructions:
      - text: Create team {name} in account {account_id}.
        slots:
          name: requestBody.name
          account_id: path.account_id
      - text: Create team {name} in account {account_id} with members {members}.
        slots:
          name: requestBody.name
          account_id: path.account_id
          members: requestBody.members
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/teams/{team_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a team's details
      effect: read
      questions:
      - Who belongs to a particular team?
      - Can I look up one team's name and description by id?
      instructions:
      - text: Get team {team_id} in account {account_id}.
        slots:
          team_id: path.team_id
          account_id: path.account_id
      - text: Show the members of team {team_id} in account {account_id}.
        slots:
          team_id: path.team_id
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/teams/{team_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a team
      effect: destructive
      questions:
      - How do I remove a team that is no longer needed?
      - Can I delete a team from my account by its id?
      instructions:
      - text: Delete team {team_id} from account {account_id}.
        slots:
          team_id: path.team_id
          account_id: path.account_id
      - text: Remove team {team_id} in account {account_id}.
        slots:
          team_id: path.team_id
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/teams/{team_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a team or its membership
      effect: write
      questions:
      - How do I add or remove people from an existing team?
      - Can I rename a team without recreating it?
      instructions:
      - text: Rename team {team_id} in account {account_id} to {name}.
        slots:
          team_id: path.team_id
          account_id: path.account_id
          name: requestBody.name
      - text: Add {members_added} to team {team_id} ({name}) in account {account_id}.
        slots:
          members_added: requestBody.members_added
          team_id: path.team_id
          name: requestBody.name
          account_id: path.account_id
      - text: Remove {members_removed} from team {team_id} named {name} in account {account_id}.
        slots:
          members_removed: requestBody.members_removed
          team_id: path.team_id
          name: requestBody.name
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'