Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Ingress Jobs API

2 actions 2 updates phrasing extends openapi/conga-jobs-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 2

$.info
$.paths['/v2/jobs/{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 Ingress Jobs API
  version: 1.0.0
extends: openapi/conga-jobs-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: 1
- target: $.paths['/v2/jobs/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workflow job and its results
      effect: read
      questions:
      - What is the status of a document generation job?
      - Can I get the output documents a completed job produced?
      instructions:
      - text: Get job {id}.
        slots:
          id: path.id
      - text: Show the status and output documents of job {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'