# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Advanced Fields schema API
  version: 1.0.0
extends: openapi/optimizely-fields-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: 3
- target: $.paths['/schema/objects/{object_name}/fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List the fields on a data platform object
      effect: read
      questions:
      - What fields are defined on the customers object in Optimizely Data Platform?
      - Can I see every field's details for one object in my schema?
      instructions:
      - text: List all fields on object {object_name}.
        slots:
          object_name: path.object_name
      - text: Show the schema fields defined for {object_name}.
        slots:
          object_name: path.object_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schema/objects/{object_name}/fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a field on a data platform object
      effect: write
      questions:
      - How do I add a new custom field, like ticket_id, to an object?
      - Which data types can a new field use, and can I mark it as PII?
      instructions:
      - text: Create field {name} labeled {display_name} of type {type} on object {object_name}.
        slots:
          name: requestBody.name
          display_name: requestBody.display_name
          type: requestBody.type
          object_name: path.object_name
      - text: Add a {type} field {name} called {display_name} to {object_name} with access policies {access_policies}.
        slots:
          type: requestBody.type
          name: requestBody.name
          display_name: requestBody.display_name
          object_name: path.object_name
          access_policies: requestBody.access_policies
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schema/objects/{object_name}/fields/{field_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one field on a data platform object
      effect: read
      questions:
      - Where can I see the type and description of a single field on an object?
      - Can I check whether one specific field exists on an object?
      instructions:
      - text: Get field {field_name} on object {object_name}.
        slots:
          field_name: path.field_name
          object_name: path.object_name
      - text: Show the definition of {field_name} in the {object_name} schema.
        slots:
          field_name: path.field_name
          object_name: path.object_name
      method: generated
      generated: '2026-09-26'