Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Optimizely Commerce Service Catalog Entries API

5 actions 5 updates phrasing extends openapi/optimizely-catalog-entries-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 5

$.info

$.paths['/commerce/entries/{entryCode}'].get

$.paths['/commerce/entries/{entryCode}'].put

$.paths['/commerce/entries/{entryCode}'].delete

$.paths['/commerce/entries/{entryCode}/commondraft/{language}'].put

OpenAPI Overlay

# 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 Catalog Entries API
  version: 1.0.0
extends: openapi/optimizely-catalog-entries-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: 4
- target: $.paths['/commerce/entries/{entryCode}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a catalog entry
      effect: read
      questions:
      - How do I look up a product, variant, package or bundle in my Optimizely Commerce catalog by its code?
      - What properties does a catalog entry have?
      instructions:
      - text: Get catalog entry {entryCode}.
        slots:
          entryCode: path.entryCode
      - text: Show the type and properties of catalog entry {entryCode}.
        slots:
          entryCode: path.entryCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/commerce/entries/{entryCode}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a published catalog entry
      effect: write
      questions:
      - How do I rename a product in the catalog directly, not just its draft?
      - Can I deactivate a catalog entry?
      instructions:
      - text: Rename catalog entry {entryCode} to {name}.
        slots:
          entryCode: path.entryCode
          name: requestBody.name
      - text: Set catalog entry {entryCode} active flag to {is_active}.
        slots:
          entryCode: path.entryCode
          is_active: requestBody.is_active
      method: generated
      generated: '2026-09-26'
- target: $.paths['/commerce/entries/{entryCode}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a catalog entry
      effect: destructive
      questions:
      - How do I permanently remove a product or variant from the catalog?
      - Can a deleted catalog entry be recovered?
      instructions:
      - text: Delete catalog entry {entryCode}.
        slots:
          entryCode: path.entryCode
      - text: Permanently remove product {entryCode} from the catalog.
        slots:
          entryCode: path.entryCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/commerce/entries/{entryCode}/commondraft/{language}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a catalog entry's language draft
      effect: write
      questions:
      - How do I update the draft of a catalog entry for a specific language without publishing?
      - Can I edit a product's localized common draft?
      instructions:
      - text: Update the {language} common draft of catalog entry {entryCode}.
        slots:
          language: path.language
          entryCode: path.entryCode
      - text: Set the {language} draft name of entry {entryCode} to {name}.
        slots:
          language: path.language
          entryCode: path.entryCode
          name: requestBody.name
      method: generated
      generated: '2026-09-26'