Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Lookup Field Settings API

8 actions 8 updates phrasing extends openapi/conga-lookup-field-settings-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Conga's API. It is a proposal applied on top of the contract, not a document Conga publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info

$.paths['/lookupfield-settings'].get

$.paths['/lookupfield-settings'].post

$.paths['/lookupfield-settings'].delete

$.paths['/lookupfield-settings'].patch

$.paths['/lookupfield-settings/{Id}'].get

$.paths['/lookupfield-settings/{Id}'].delete

$.paths['/lookupfield-settings/{Id}'].patch

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 Administration Lookup Field Settings API
  version: 1.0.0
extends: openapi/conga-lookup-field-settings-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['/lookupfield-settings'].get
  update:
    x-apievangelist-phrasing:
      intent: List lookup field settings
      effect: read
      questions:
      - Which lookup field settings are configured?
      - Can I filter or page through lookup field settings?
      instructions:
      - text: List all lookup field settings.
      - text: List lookup field settings matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/lookupfield-settings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create lookup field settings
      effect: write
      questions:
      - How do I configure a new lookup field setting?
      - Can I create several lookup settings at once?
      instructions:
      - text: Create new lookup field settings.
      - text: Add a batch of lookup field settings.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/lookupfield-settings'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete lookup field settings in bulk
      effect: destructive
      questions:
      - Can I delete several lookup field settings at once?
      - How do I bulk-remove lookup settings?
      instructions:
      - text: Bulk delete the selected lookup field settings.
      - text: Remove many lookup settings in one call.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/lookupfield-settings'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update lookup field settings in bulk
      effect: write
      questions:
      - Can I edit multiple lookup field settings in one request?
      - How do I bulk-update lookup settings?
      instructions:
      - text: Bulk update the selected lookup field settings.
      - text: Edit several lookup settings at once.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/lookupfield-settings/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a lookup field setting
      effect: read
      questions:
      - Where can I see one lookup field setting?
      - Can I include related data when fetching a lookup setting?
      instructions:
      - text: Get lookup field setting {id}.
        slots:
          id: path.Id
      - text: Show lookup setting {id} including {includes}.
        slots:
          id: path.Id
          includes: query.includes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/lookupfield-settings/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a lookup field setting
      effect: destructive
      questions:
      - Can I delete a single lookup field setting?
      - What happens when one lookup setting is removed?
      instructions:
      - text: Delete lookup field setting {id}.
        slots:
          id: path.Id
      - text: Remove only the lookup setting {id}.
        slots:
          id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/lookupfield-settings/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a lookup field setting
      effect: write
      questions:
      - How do I edit one lookup field setting?
      - Can I change a single lookup setting's filter?
      instructions:
      - text: Update lookup field setting {id}.
        slots:
          id: path.Id
      - text: Edit only the lookup setting {id}.
        slots:
          id: path.Id
      method: generated
      generated: '2026-10-01'