Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Optimizely Commerce Service Catalogs API

6 actions 6 updates phrasing extends openapi/optimizely-catalogs-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['/commerce/catalogs'].get
$.paths['/commerce/catalogs'].post
$.paths['/commerce/catalogs/{catalogName}'].get
$.paths['/commerce/catalogs/{catalogName}'].put
$.paths['/commerce/catalogs/{catalogName}'].delete

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 Optimizely Commerce Service Catalogs API
  version: 1.0.0
extends: openapi/optimizely-catalogs-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['/commerce/catalogs'].get
  update:
    x-apievangelist-phrasing:
      intent: List product catalogs
      effect: read
      questions:
      - What product catalogs exist in my Optimizely commerce system?
      - How do I list every catalog along with its default currency?
      instructions:
      - text: List all product catalogs.
      - text: Show me every catalog in the commerce system.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/commerce/catalogs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a product catalog
      effect: write
      questions:
      - How do I create a new product catalog?
      - Can I set a default currency and language when making a catalog?
      instructions:
      - text: Create a catalog named {name}.
        slots:
          name: requestBody.name
      - text: Create catalog {name} with default currency {default_currency} and language {default_language}.
        slots:
          name: requestBody.name
          default_currency: requestBody.default_currency
          default_language: requestBody.default_language
      method: generated
      generated: '2026-09-26'
- target: $.paths['/commerce/catalogs/{catalogName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a catalog by name
      effect: read
      questions:
      - How do I look up one catalog's details by its name?
      - Is a particular catalog active, and what language does it default to?
      instructions:
      - text: Get catalog {catalogName}.
        slots:
          catalogName: path.catalogName
      - text: Show the settings of the {catalogName} catalog.
        slots:
          catalogName: path.catalogName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/commerce/catalogs/{catalogName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a catalog's settings
      effect: write
      questions:
      - How do I deactivate a catalog?
      - Can I change an existing catalog's default currency?
      instructions:
      - text: Set catalog {catalogName} active status to {is_active}.
        slots:
          catalogName: path.catalogName
          is_active: requestBody.is_active
      - text: Change the default currency of catalog {catalogName} to {default_currency}.
        slots:
          catalogName: path.catalogName
          default_currency: requestBody.default_currency
      method: generated
      generated: '2026-09-26'
- target: $.paths['/commerce/catalogs/{catalogName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a catalog and its contents
      effect: destructive
      questions:
      - How do I permanently delete a catalog?
      - Does deleting a catalog also remove everything inside it?
      instructions:
      - text: Delete catalog {catalogName}.
        slots:
          catalogName: path.catalogName
      - text: Permanently remove the {catalogName} catalog and its contents.
        slots:
          catalogName: path.catalogName
      method: generated
      generated: '2026-09-26'