Lightfield · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reference Lists API

8 actions 8 updates phrasing extends openapi/lightfield-lists-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 8

$.info

$.paths['/v1/lists'].get

$.paths['/v1/lists'].post

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

$.paths['/v1/lists/{id}'].post

$.paths['/v1/lists/{listId}/accounts'].get

$.paths['/v1/lists/{listId}/contacts'].get

$.paths['/v1/lists/{listId}/opportunities'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Reference Lists API
  version: 1.0.0
extends: openapi/lightfield-lists-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: 7
- target: $.paths['/v1/lists'].get
  update:
    x-apievangelist-phrasing:
      intent: List saved lists
      effect: read
      questions:
      - Which saved lists exist in my workspace?
      - How can I page through all of my lists?
      instructions:
      - text: Show all my lists.
      - text: Show {limit} lists starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/lists'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a list of records
      effect: write
      questions:
      - How do I create a new list for grouping accounts, contacts or opportunities?
      - What do I need to specify when making a new list?
      instructions:
      - text: Create a list with {fields}.
        slots:
          fields: requestBody.fields
      - text: Make a new list named and typed by {fields}.
        slots:
          fields: requestBody.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/lists/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve one list by ID
      effect: read
      questions:
      - How do I look up a single list's name and type?
      - Can I fetch the details of one list when I have its ID?
      instructions:
      - text: Get list {id}.
        slots:
          id: path.id
      - text: Show the details of list {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/lists/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename or edit a list
      effect: write
      questions:
      - How do I rename a list I already made?
      - Can I change only some fields on an existing list?
      instructions:
      - text: Update list {id} with {fields}.
        slots:
          id: path.id
          fields: requestBody.fields
      - text: Rename list {id} using {fields}.
        slots:
          id: path.id
          fields: requestBody.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/lists/{listId}/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List the accounts in a list
      effect: read
      questions:
      - Which companies are in a particular list?
      - How do I page through the accounts that belong to one list?
      instructions:
      - text: Show the accounts in list {listId}.
        slots:
          listId: path.listId
      - text: List {limit} accounts from list {listId}.
        slots:
          limit: query.limit
          listId: path.listId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/lists/{listId}/contacts'].get
  update:
    x-apievangelist-phrasing:
      intent: List the contacts in a list
      effect: read
      questions:
      - Which people are members of a particular list?
      - How can I page through the contacts in one list?
      instructions:
      - text: Show the contacts in list {listId}.
        slots:
          listId: path.listId
      - text: List {limit} contacts from list {listId} starting at {offset}.
        slots:
          limit: query.limit
          listId: path.listId
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/lists/{listId}/opportunities'].get
  update:
    x-apievangelist-phrasing:
      intent: List the opportunities in a list
      effect: read
      questions:
      - Which deals are included in a particular list?
      - How do I page through the opportunities that belong to one list?
      instructions:
      - text: Show the opportunities in list {listId}.
        slots:
          listId: path.listId
      - text: List {limit} deals from list {listId}.
        slots:
          limit: query.limit
          listId: path.listId
      method: generated
      generated: '2026-10-01'