Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Optimizely Graph πŸ“– Definition ( v3 ) API

7 actions 7 updates phrasing extends openapi/optimizely-definition-v3-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 7

$.info
$.paths['/api/content/v3/sources'].get
$.paths['/api/content/v3/sources'].post
$.paths['/api/content/v3/sources'].delete
$.paths['/api/content/v3/types'].get
$.paths['/api/content/v3/types'].put
$.paths['/api/content/v3/types'].post

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 Graph πŸ“– Definition ( v3 ) API
  version: 1.0.0
extends: openapi/optimizely-definition-v3-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: 6
- target: $.paths['/api/content/v3/sources'].get
  update:
    x-apievangelist-phrasing:
      intent: Get content source metadata
      effect: read
      questions:
      - What content sources are defined in my Optimizely Graph instance and which languages do they cover?
      - Can I read the metadata of just one source, or of the new slot?
      instructions:
      - text: Get metadata for all content sources.
      - text: Get metadata for content source {id}.
        slots:
          id: query.id
      - text: Show label and languages of source {id} in slot {slot}.
        slots:
          id: query.id
          slot: query.slot
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/content/v3/sources'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a content source's label and description
      effect: write
      questions:
      - How do I rename a content source or change its description?
      - Can I update source metadata in the new slot only?
      instructions:
      - text: Set label of content source {id} to {label} with description {description}.
        slots:
          id: query.id
          label: requestBody.label
          description: requestBody.description
      - text: 'Update source {id} in slot {slot}: label {label}, description {description}.'
        slots:
          id: query.id
          slot: query.slot
          label: requestBody.label
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/content/v3/sources'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a content source's types or data
      effect: destructive
      questions:
      - How do I wipe the indexed content and type definitions for a source?
      - Can I delete only a source's data but keep its content types?
      instructions:
      - text: Delete content types and data of source {id}.
        slots:
          id: query.id
      - text: Delete source {id} using mode {mode}.
        slots:
          id: query.id
          mode: query.mode
      - text: Delete source {id} in slot {slot}.
        slots:
          id: query.id
          slot: query.slot
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/content/v3/types'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a source's content types
      effect: read
      questions:
      - Which content types are defined for a content source?
      - What property types does a source's content schema use?
      instructions:
      - text: Get content types of source {id}.
        slots:
          id: query.id
      - text: Show the content type definitions for the default source.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/content/v3/types'].put
  update:
    x-apievangelist-phrasing:
      intent: Overwrite all content types of a source
      effect: write
      questions:
      - How do I replace every content type definition on a source at once?
      - Does a full content type update discard types I leave out?
      instructions:
      - text: Overwrite all content types of source {id} with {contentTypes}.
        slots:
          id: query.id
          contentTypes: requestBody.contentTypes
      - text: Fully replace source {id}'s schema with content types {contentTypes} and property types {propertyTypes}.
        slots:
          id: query.id
          contentTypes: requestBody.contentTypes
          propertyTypes: requestBody.propertyTypes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/content/v3/types'].post
  update:
    x-apievangelist-phrasing:
      intent: Partially update a source's content types
      effect: write
      questions:
      - How do I add or change a few content types without overwriting the rest?
      - Can I merge new languages into a source's content type definition?
      instructions:
      - text: Merge content types {contentTypes} into source {id}.
        slots:
          contentTypes: requestBody.contentTypes
          id: query.id
      - text: Partially update source {id} to add languages {languages}.
        slots:
          id: query.id
          languages: requestBody.languages
      method: generated
      generated: '2026-09-26'