Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Conga Job Status API

5 actions 5 updates phrasing extends openapi/conga-job-status-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 5

$.info
$.paths['/job-status'].post
$.paths['/job-status'].delete
$.paths['/job-status/{jobId}'].get
$.paths['/job-status/{id}'].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 Conga Job Status API
  version: 1.0.0
extends: openapi/conga-job-status-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: 4
- target: $.paths['/job-status'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the status of several jobs
      effect: read
      questions:
      - Can I check the status of many background jobs at once?
      - How do I poll a batch of job IDs?
      instructions:
      - text: Get the status of several jobs at once.
      - text: Check a batch of background jobs.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/job-status'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a job and its child jobs
      effect: destructive
      questions:
      - Can I delete a job along with its child jobs?
      - How do I clean up a finished job record?
      instructions:
      - text: Delete the job and its associated child jobs.
      - text: Remove the job record and its child jobs.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/job-status/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a job's status with child jobs
      effect: read
      questions:
      - Can I include child jobs when checking a job's status?
      - How do I check a job's status for a specific operation type?
      instructions:
      - text: Get status of job {job} including child jobs.
        slots:
          job: path.jobId
      - text: Check job {job} for operation type {op}.
        slots:
          job: path.jobId
          op: query.operationType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/job-status/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a job's status by record ID
      effect: read
      questions:
      - Is there a simple status lookup for one job record without child jobs?
      - What does the plain job status record by ID show?
      instructions:
      - text: Look up the plain job status record {id}.
        slots:
          id: path.id
      - text: Show only job record {id}'s status, without children.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'