Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Conga Layout API

4 actions 4 updates phrasing extends openapi/conga-layout-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 4

$.info
$.paths['/v1/cs-layouts'].get
$.paths['/v1/cs-layouts'].post
$.paths['/api/xauthor/v1/layouts/{layoutName}'].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 Layout API
  version: 1.0.0
extends: openapi/conga-layout-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: 3
- target: $.paths['/v1/cs-layouts'].get
  update:
    x-apievangelist-phrasing:
      intent: List document layouts
      effect: read
      questions:
      - Which signing layouts do I have available?
      - Can I list another user's layouts by their email?
      instructions:
      - text: List my layouts.
      - text: List layouts owned by {ownerEmail}.
        slots:
          ownerEmail: query.ownerEmail
      - text: Search layouts for {search}.
        slots:
          search: query.search
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-layouts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a document layout
      effect: write
      questions:
      - How do I save a reusable layout of signature fields?
      - Can I control who can see a new layout?
      instructions:
      - text: Create a layout named {name} with visibility {visibility}.
        slots:
          name: requestBody.name
          visibility: requestBody.visibility
      - text: Create layout {name} of type {type} from documents {documents} with ID {id}.
        slots:
          name: requestBody.name
          type: requestBody.type
          documents: requestBody.documents
          id: requestBody.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/layouts/{layoutName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an X-Author page layout's fields
      effect: read
      questions:
      - Which page fields does an X-Author layout define?
      - Can I fetch the configuration metadata of an X-Author page layout by name?
      instructions:
      - text: Get the page field definitions of X-Author layout {layout}.
        slots:
          layout: path.layoutName
      - text: Show configuration metadata for X-Author layout {layout} in org type {org}.
        slots:
          layout: path.layoutName
          org: header.OrgType
      method: generated
      generated: '2026-10-01'