Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Roles API

3 actions 3 updates phrasing extends openapi/optimizely-roles-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['/api/v1/admin/Roles'].get
$.paths['/api/v1/admin/Roles'].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 Admin API V1 Roles API
  version: 1.0.0
extends: openapi/optimizely-roles-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['/api/v1/admin/Roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List admin roles
      effect: read
      questions:
      - Which admin roles are defined in the commerce console?
      - Can I filter roles to only the read-only ones?
      instructions:
      - text: List all admin roles.
      - text: Find roles matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/Roles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an admin role
      effect: write
      questions:
      - How do I create a new admin role?
      - Can a new role be marked read-only when it is created?
      instructions:
      - text: Create a role named {roleName}.
        slots:
          roleName: requestBody.roleName
      - text: Add a read-only role called {roleName}.
        slots:
          roleName: requestBody.roleName
      method: generated
      generated: '2026-09-26'