Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Ingress Draft API

3 actions 3 updates phrasing extends openapi/conga-draft-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 3

$.info
$.paths['/v1/Draft'].post
$.paths['/v1/Draft/{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 Draft API
  version: 1.0.0
extends: openapi/conga-draft-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: 2
- target: $.paths['/v1/Draft'].post
  update:
    x-apievangelist-phrasing:
      intent: Save a document solution as a draft
      effect: write
      questions:
      - Can I save a document generation solution as a draft before deploying it?
      - What can a solution draft hold, like templates, data models and delivery options?
      instructions:
      - text: Save a draft solution named {name} for the {environment} environment.
        slots:
          name: requestBody.name
          environment: requestBody.environment
      - text: Save draft {name} with templates {templates} and region {region}.
        slots:
          name: requestBody.name
          templates: requestBody.templates
          region: requestBody.region
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/Draft/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a saved solution draft
      effect: read
      questions:
      - Can I reopen a solution draft I saved earlier?
      - What's stored in a particular draft solution?
      instructions:
      - text: Get draft solution {id}.
        slots:
          id: path.id
      - text: Load the saved solution draft {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'