Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Optimizely Objects API

4 actions 4 updates phrasing extends openapi/optimizely-objects-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['/objects/{object_name}'].post
$.paths['/objects/{object_type}'].post
$.paths['/objects/{object_type}/{object_id}'].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 Optimizely Objects API
  version: 1.0.0
extends: openapi/optimizely-objects-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['/objects/{object_name}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a named custom object
      effect: write
      questions:
      - How do I update order summary fields without generating events?
      - Can I update records in a custom object like Reviews or Concert Tickets by its name?
      instructions:
      - text: Update records in the {object_name} object without generating events.
        slots:
          object_name: path.object_name
      - text: Update the top-level order summary fields held in object {object_name}.
        slots:
          object_name: path.object_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/objects/{object_type}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update objects of a type
      effect: write
      questions:
      - How do I bulk load products or orders into the customer data platform?
      - Will sending an object that already exists update it rather than duplicate it?
      instructions:
      - text: Upsert a batch of {object_type} objects into the data platform.
        slots:
          object_type: path.object_type
      - text: Create or update one or more records of object type {object_type}.
        slots:
          object_type: path.object_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/objects/{object_type}/{object_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an object by type and ID
      effect: read
      questions:
      - What is stored in the data platform for a particular order or product?
      - Can I look up a single object when I know its type and identifier?
      instructions:
      - text: Get the {object_type} object with ID {object_id}.
        slots:
          object_type: path.object_type
          object_id: path.object_id
      - text: Look up {object_type} record {object_id} in the data platform.
        slots:
          object_type: path.object_type
          object_id: path.object_id
      method: generated
      generated: '2026-09-26'