# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Optimizely Data Platform REST Schema API
  version: 1.0.0
extends: openapi/optimizely-schema-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: 4
- target: $.paths['/schema/objects'].get
  update:
    x-apievangelist-phrasing:
      intent: List object types in the data platform schema
      effect: read
      questions:
      - What object types are defined in my Optimizely Data Platform schema?
      - How do I see all schema objects with their fields and configuration?
      instructions:
      - text: List all schema object types.
      - text: Show every object in the data platform schema with its fields.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schema/objects/{object_type}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one object type's schema definition
      effect: read
      questions:
      - How do I see the fields defined on one schema object type?
      - What does the schema for a particular object type look like?
      instructions:
      - text: Get the schema for object type {object_type}.
        slots:
          object_type: path.object_type
      - text: Show the fields of the {object_type} object.
        slots:
          object_type: path.object_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schema/objects/{object_type}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new object type in the schema
      effect: write
      questions:
      - How do I add a custom object type to the data platform schema?
      - Can I give a new schema object a display name and description?
      instructions:
      - text: Create schema object {object_type} with display name {display_name}.
        slots:
          object_type: path.object_type
          display_name: requestBody.display_name
      - text: Add object type {object_type} described as {description}.
        slots:
          object_type: path.object_type
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schema/objects/{object_type}/fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a field to a schema object
      effect: write
      questions:
      - How do I add a new field to an existing object type?
      - What data type do I have to specify when creating a schema field?
      instructions:
      - text: Add field {name} of type {type} to object {object_type}.
        slots:
          name: requestBody.name
          type: requestBody.type
          object_type: path.object_type
      - text: Create field {name} labeled {display_name} on {object_type}.
        slots:
          name: requestBody.name
          display_name: requestBody.display_name
          object_type: path.object_type
      method: generated
      generated: '2026-09-26'