Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Optimizely Commerce Service Catalog Entry Relations API

3 actions 3 updates phrasing extends openapi/optimizely-catalog-entry-relations-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['/commerce/entries/{entryCode}/noderelations'].get

$.paths['/commerce/entries/{entryCode}/noderelations'].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 Entry Relations API
  version: 1.0.0
extends: openapi/optimizely-catalog-entry-relations-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['/commerce/entries/{entryCode}/noderelations'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the catalog nodes an entry belongs to
      effect: read
      questions:
      - Which catalog categories is a product entry placed in?
      - How can I see the node relations for a catalog entry by its code?
      instructions:
      - text: Get the node relations for entry {entryCode}.
        slots:
          entryCode: path.entryCode
      - text: Show which catalog nodes contain entry {entryCode}.
        slots:
          entryCode: path.entryCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/commerce/entries/{entryCode}/noderelations'].put
  update:
    x-apievangelist-phrasing:
      intent: Update the catalog nodes an entry belongs to
      effect: write
      questions:
      - How do I move a product entry into different catalog categories?
      - Can I replace the node relations of a catalog entry in one call?
      instructions:
      - text: Update the node relations of entry {entryCode}.
        slots:
          entryCode: path.entryCode
      - text: Recategorize catalog entry {entryCode} by setting its node relations.
        slots:
          entryCode: path.entryCode
      method: generated
      generated: '2026-09-26'