Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Forms API

3 actions 3 updates phrasing extends openapi/optimizely-forms-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/Forms'].get
$.paths['/api/v1/admin/Forms(\'{name}\')'].get

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 Forms API
  version: 1.0.0
extends: openapi/optimizely-forms-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/Forms'].get
  update:
    x-apievangelist-phrasing:
      intent: List admin forms
      effect: read
      questions:
      - Which forms are defined in my Optimizely Configured Commerce admin?
      - Can I sort or page through the list of forms?
      instructions:
      - text: List all forms.
      - text: List the first {top} forms matching {filter}.
        slots:
          top: query.$top
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/Forms(\'{name}\')'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a form by name
      effect: read
      questions:
      - How do I fetch the definition of one form using its name?
      - What does a specific named form contain?
      instructions:
      - text: Get the form named {name}.
        slots:
          name: path.name
      - text: Show form {name} with only the fields {select}.
        slots:
          name: path.name
          select: query.$select
      method: generated
      generated: '2026-09-26'