Lightfield · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reference Members API

3 actions 3 updates phrasing extends openapi/lightfield-members-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 3

$.info
$.paths['/v1/members/{id}'].get
$.paths['/v1/members'].get

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 Members API
  version: 1.0.0
extends: openapi/lightfield-members-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: 2
- target: $.paths['/v1/members/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve one workspace member
      effect: read
      questions:
      - How do I look up a teammate by their member ID?
      - Can I get the details of a single workspace member?
      instructions:
      - text: Get member {id}.
        slots:
          id: path.id
      - text: Show who workspace member {id} is.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List workspace members
      effect: read
      questions:
      - Who are all the members of my Lightfield workspace?
      - How can I page through my workspace's users?
      instructions:
      - text: List everyone in my workspace.
      - text: List {limit} workspace members starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-10-01'