API Evangelist conversational phrasing for Reference Opportunities API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Reference Opportunities API
  version: 1.0.0
extends: openapi/lightfield-opportunities-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: 5
- target: $.paths['/v1/opportunities/definitions'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the field schema for opportunities
      effect: read
      questions:
      - What fields and custom fields exist on opportunities in Lightfield?
      - Which deal stages and fields can I set before creating an opportunity?
      instructions:
      - text: Show me the field and relationship definitions for opportunities.
      - text: Fetch the opportunity schema including custom fields.
      - text: Get opportunity field definitions using API version {version}.
        slots:
          version: header.Lightfield-Version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/opportunities'].get
  update:
    x-apievangelist-phrasing:
      intent: List opportunities
      effect: read
      questions:
      - How do I page through every deal in my pipeline?
      - Can I filter opportunities by a field such as stage?
      instructions:
      - text: List my opportunities.
      - text: List {limit} opportunities starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/opportunities'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a sales opportunity
      effect: write
      questions:
      - How do I open a new deal for a company account?
      - What is required to create an opportunity, and is a summary generated for it?
      instructions:
      - text: Create an opportunity with {fields} on account {relationships}.
        slots:
          fields: requestBody.fields
          relationships: requestBody.relationships
      - text: Open a new deal with name and stage {fields} linked to {relationships}.
        slots:
          fields: requestBody.fields
          relationships: requestBody.relationships
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/opportunities/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve one opportunity by ID
      effect: read
      questions:
      - How do I look up one deal when I have its ID?
      - Can I see the full record for a specific opportunity?
      instructions:
      - text: Get opportunity {id}.
        slots:
          id: path.id
      - text: Show me the details of deal {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/opportunities/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an existing opportunity
      effect: write
      questions:
      - How do I move an existing deal to a new stage?
      - Can I change only some fields on an opportunity I already created?
      instructions:
      - text: Update opportunity {id} with {fields}.
        slots:
          id: path.id
          fields: requestBody.fields
      - text: Change the relationships on existing deal {id} to {relationships}.
        slots:
          id: path.id
          relationships: requestBody.relationships
      method: generated
      generated: '2026-10-01'