Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Optimizely Graph 📖 Definition ( v2 ) API

4 actions 4 updates phrasing extends openapi/optimizely-definition-v2-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['/api/content/v2/data'].post

$.paths['/api/content/v2/data'].delete

$.paths['/api/content/v2/types'].post

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 Graph 📖 Definition ( v2 ) API
  version: 1.0.0
extends: openapi/optimizely-definition-v2-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['/api/content/v2/data'].post
  update:
    x-apievangelist-phrasing:
      intent: Sync content data for a Graph source
      effect: write
      questions:
      - How do I push content data from a source into Optimizely Graph?
      - Which source id does a content data sync need?
      instructions:
      - text: Sync content data for source {id}.
        slots:
          id: query.id
      - text: Push the latest content items from source {id} into Graph.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/content/v2/data'].delete
  update:
    x-apievangelist-phrasing:
      intent: Purge content data for a Graph source
      effect: destructive
      questions:
      - Can I wipe all indexed content data for one source?
      - Is it possible to purge a source's content in only certain languages?
      instructions:
      - text: Purge all content data for source {id}.
        slots:
          id: query.id
      - text: Purge content data in {languages} for source {id}.
        slots:
          languages: query.languages
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/content/v2/types'].post
  update:
    x-apievangelist-phrasing:
      intent: Sync content type definitions to Graph
      effect: write
      questions:
      - How do I register my content types and property types with the Graph index?
      - Can I sync content types with typed field names turned on?
      - What goes into a content type sync besides the types themselves, like languages and links?
      instructions:
      - text: Sync content types {contentTypes} to Graph.
        slots:
          contentTypes: requestBody.contentTypes
      - text: Sync content types {contentTypes} with property types {propertyTypes} for languages {languages}.
        slots:
          contentTypes: requestBody.contentTypes
          propertyTypes: requestBody.propertyTypes
          languages: requestBody.languages
      method: generated
      generated: '2026-09-26'