Lightfield · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reference Meetings API

5 actions 5 updates phrasing extends openapi/lightfield-meetings-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Lightfield's API. It is a proposal applied on top of the contract, not a document Lightfield publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/v1/meetings'].get
$.paths['/v1/meetings'].post
$.paths['/v1/meetings/{id}'].get
$.paths['/v1/meetings/{id}'].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 Reference Meetings API
  version: 1.0.0
extends: openapi/lightfield-meetings-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: 4
- target: $.paths['/v1/meetings'].get
  update:
    x-apievangelist-phrasing:
      intent: List meetings
      effect: read
      questions:
      - How do I page through all the meetings recorded in my workspace?
      - Why are some meeting transcripts redacted when I browse meetings?
      instructions:
      - text: List my meetings.
      - text: List {limit} meetings starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/meetings'].post
  update:
    x-apievangelist-phrasing:
      intent: Log a past meeting
      effect: write
      questions:
      - Can I record a meeting that already happened, with its transcript?
      - Is it possible to create a meeting scheduled in the future?
      instructions:
      - text: Log a past meeting with title, start and end dates in {fields}.
        slots:
          fields: requestBody.fields
      - text: Create a past meeting from {fields} and attach transcript {relationships}.
        slots:
          fields: requestBody.fields
          relationships: requestBody.relationships
      - text: Record a past meeting with {fields} and auto-create records using {autoCreateRecords}.
        slots:
          fields: requestBody.fields
          autoCreateRecords: requestBody.autoCreateRecords
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/meetings/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve one meeting by ID
      effect: read
      questions:
      - How do I fetch a single meeting and its transcript?
      - What access level do I have on a specific meeting?
      instructions:
      - text: Get meeting {id}.
        slots:
          id: path.id
      - text: Show meeting {id} with whatever transcript I'm allowed to see.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/meetings/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Set a meeting's privacy or transcript
      effect: write
      questions:
      - How do I attach or replace the transcript on a meeting already logged?
      - Can I change the privacy setting of an existing meeting?
      instructions:
      - text: Set the privacy setting on meeting {id} to {fields}.
        slots:
          id: path.id
          fields: requestBody.fields
      - text: Replace the transcript on meeting {id} with {relationships}.
        slots:
          id: path.id
          relationships: requestBody.relationships
      method: generated
      generated: '2026-10-01'