Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Optimizely Commerce Service Catalog Nodes API

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

$.info

$.paths['/commerce/nodes/{nodeCode}'].get

$.paths['/commerce/nodes/{nodeCode}'].put

$.paths['/commerce/nodes/{nodeCode}'].delete

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 Nodes API
  version: 1.0.0
extends: openapi/optimizely-catalog-nodes-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: 3
- target: $.paths['/commerce/nodes/{nodeCode}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a catalog category
      effect: read
      questions:
      - How do I look up a category node in my Optimizely Commerce catalog by its code?
      - Which parent category does a catalog node sit under?
      instructions:
      - text: Get catalog node {nodeCode}.
        slots:
          nodeCode: path.nodeCode
      - text: Show the parent and sort order of category {nodeCode}.
        slots:
          nodeCode: path.nodeCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/commerce/nodes/{nodeCode}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a catalog category
      effect: write
      questions:
      - How do I move a category under a different parent node?
      - Can I rename or reorder a catalog category?
      instructions:
      - text: Move category {nodeCode} under parent {parent_node_code}.
        slots:
          nodeCode: path.nodeCode
          parent_node_code: requestBody.parent_node_code
      - text: Rename category {nodeCode} to {name}.
        slots:
          nodeCode: path.nodeCode
          name: requestBody.name
      - text: Set category {nodeCode} sort order to {sort_order}.
        slots:
          nodeCode: path.nodeCode
          sort_order: requestBody.sort_order
      method: generated
      generated: '2026-09-26'
- target: $.paths['/commerce/nodes/{nodeCode}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a catalog category
      effect: destructive
      questions:
      - How do I permanently delete a category from the catalog?
      - Is removing a catalog node permanent?
      instructions:
      - text: Delete catalog node {nodeCode}.
        slots:
          nodeCode: path.nodeCode
      - text: Permanently remove category {nodeCode}.
        slots:
          nodeCode: path.nodeCode
      method: generated
      generated: '2026-09-26'