# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Reference Objects API
  version: 1.0.0
extends: openapi/lightfield-objects-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/v1/objects/{entitySlug}/values'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom object record
      effect: write
      questions:
      - How do I add a record to one of my custom object types?
      - What do I need to create a new custom object entry?
      instructions:
      - text: Create a {entitySlug} record with {fields}.
        slots:
          entitySlug: path.entitySlug
          fields: requestBody.fields
      - text: Add a new {entitySlug} custom record with {fields} linked via {relationships}.
        slots:
          entitySlug: path.entitySlug
          fields: requestBody.fields
          relationships: requestBody.relationships
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/objects/{entitySlug}/values/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve one custom object record
      effect: read
      questions:
      - How do I fetch a single custom object record by its ID?
      - Can I read one entry of a custom object type?
      instructions:
      - text: Get {entitySlug} record {id}.
        slots:
          entitySlug: path.entitySlug
          id: path.id
      - text: Show custom record {id} of type {entitySlug}.
        slots:
          id: path.id
          entitySlug: path.entitySlug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/objects/{entitySlug}/values/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a custom object record
      effect: write
      questions:
      - How do I change fields on an existing custom object record?
      - Can I partially update one custom record without overwriting the rest?
      instructions:
      - text: Update {entitySlug} record {id} with {fields}.
        slots:
          entitySlug: path.entitySlug
          id: path.id
          fields: requestBody.fields
      - text: Change the relationships on {entitySlug} record {id} to {relationships}.
        slots:
          entitySlug: path.entitySlug
          id: path.id
          relationships: requestBody.relationships
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/objects/{entitySlug}'].get
  update:
    x-apievangelist-phrasing:
      intent: List records of a custom object type
      effect: read
      questions:
      - How do I list all records for one custom object type?
      - Can I filter the records of a custom object by a field?
      instructions:
      - text: List all {entitySlug} records.
        slots:
          entitySlug: path.entitySlug
      - text: List {limit} {entitySlug} records starting at offset {offset}.
        slots:
          limit: query.limit
          entitySlug: path.entitySlug
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/objects/{entitySlug}/definitions'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the field schema of a custom object
      effect: read
      questions:
      - What fields and relationships does a particular custom object type have?
      - How do I learn the shape of a custom object before writing records to it?
      instructions:
      - text: Show the field definitions for custom object {entitySlug}.
        slots:
          entitySlug: path.entitySlug
      - text: Fetch the schema of the {entitySlug} object type.
        slots:
          entitySlug: path.entitySlug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/objects'].get
  update:
    x-apievangelist-phrasing:
      intent: List the custom object types
      effect: read
      questions:
      - Which custom object types exist in my Lightfield workspace?
      - What custom objects am I allowed to access?
      instructions:
      - text: List all custom object types available to me.
      - text: Show which custom objects are defined in my workspace.
      - text: List custom object types using API version {version}.
        slots:
          version: header.Lightfield-Version
      method: generated
      generated: '2026-10-01'