Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Proposal Locations API

8 actions 8 updates phrasing extends openapi/conga-proposal-locations-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['/quotes/{ParentId}/locations'].get
$.paths['/quotes/{ParentId}/locations'].post
$.paths['/quotes/{ParentId}/locations'].delete
$.paths['/quotes/{ParentId}/locations'].patch
$.paths['/quotes/{ParentId}/locations/{Id}'].get
$.paths['/quotes/{ParentId}/locations/{Id}'].delete
$.paths['/quotes/{ParentId}/locations/{Id}'].patch

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 Administration Proposal Locations API
  version: 1.0.0
extends: openapi/conga-proposal-locations-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['/quotes/{ParentId}/locations'].get
  update:
    x-apievangelist-phrasing:
      intent: List a proposal's locations
      effect: read
      questions:
      - How do I see every location attached to a proposal?
      - Can I filter or sort the locations on a quote?
      - Which locations are on a Conga proposal?
      instructions:
      - text: List the locations on proposal {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: List locations on proposal {ParentId} matching {filter}.
        slots:
          ParentId: path.ParentId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/quotes/{ParentId}/locations'].post
  update:
    x-apievangelist-phrasing:
      intent: Add locations to a proposal
      effect: write
      questions:
      - How do I add new locations to a proposal?
      - Can I create several proposal locations in one request?
      instructions:
      - text: Add these locations to proposal {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Create new location records on quote {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/quotes/{ParentId}/locations'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove locations from a proposal in bulk
      effect: destructive
      questions:
      - Is there a way to remove several locations from a proposal at once?
      - Can I bulk delete proposal locations?
      instructions:
      - text: Remove these locations from proposal {ParentId} in bulk.
        slots:
          ParentId: path.ParentId
      - text: Delete several location records from quote {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/quotes/{ParentId}/locations'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a proposal's locations in bulk
      effect: write
      questions:
      - How do I edit many proposal locations in one request?
      - Can I move proposal locations to a different proposal when bulk updating?
      instructions:
      - text: Update several locations on proposal {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Bulk edit the location records of quote {ParentId} with these changes.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/quotes/{ParentId}/locations/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a proposal location
      effect: read
      questions:
      - How do I look up one location on a proposal by its ID?
      - What details are stored on a single proposal location?
      instructions:
      - text: Get location {Id} on proposal {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Show the details of proposal location {Id} under quote {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/quotes/{ParentId}/locations/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a proposal location
      effect: destructive
      questions:
      - How do I delete just one location from a proposal?
      - Can I remove a single proposal location by ID?
      instructions:
      - text: Delete location {Id} from proposal {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Remove the single proposal location {Id} on quote {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/quotes/{ParentId}/locations/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a proposal location
      effect: write
      questions:
      - What's the call to change one location on a proposal?
      - Can I edit a single proposal location without touching the others?
      instructions:
      - text: Update location {Id} on proposal {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Edit the single proposal location {Id} under quote {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'