Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Contracts Contract Type Document Requirement Settings API

5 actions 5 updates phrasing extends openapi/conga-contract-type-document-requirement-settings-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['/api/clm/v1/settings/documents/contract-type-requirements'].get
$.paths['/api/clm/v1/settings/documents/contract-type-requirements'].put
$.paths['/api/clm/v1/settings/documents/contract-type-requirements/query'].post
$.paths['/api/clm/v1/settings/documents/contract-type-requirements/{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 Contracts Contract Type Document Requirement Settings API
  version: 1.0.0
extends: openapi/conga-contract-type-document-requirement-settings-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['/api/clm/v1/settings/documents/contract-type-requirements'].get
  update:
    x-apievangelist-phrasing:
      intent: Get document requirements for a contract type
      effect: read
      questions:
      - Which documents are required for a contract type when a given action happens?
      - Can I look up document requirement settings by contract type and action?
      instructions:
      - text: Show document requirements for contract type {contract_type} on action {action}.
        slots:
          contract_type: query.contractType
          action: query.action
      - text: Get required documents for contract type {contract_type}.
        slots:
          contract_type: query.contractType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/settings/documents/contract-type-requirements'].put
  update:
    x-apievangelist-phrasing:
      intent: Update document requirement settings
      effect: write
      questions:
      - Can I change existing document requirement settings in bulk?
      - What does each record need when updating document requirements?
      instructions:
      - text: Update these document requirement settings records by their IDs.
      - text: Save changes to the contract-type document requirement settings.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/settings/documents/contract-type-requirements/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Query document requirement settings
      effect: read
      questions:
      - How do I search document requirement settings with sorting and paging?
      - Can I filter requirement settings by a criteria expression?
      instructions:
      - text: Query document requirement settings matching {criteria}.
        slots:
          criteria: requestBody.CriteriaExpression
      - text: List requirement settings, skip {skip}, limit {limit}.
        slots:
          skip: requestBody.Skip
          limit: requestBody.Limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/settings/documents/contract-type-requirements/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one document requirement setting
      effect: read
      questions:
      - What does a single document requirement setting contain?
      - Can I fetch a requirement setting by its ID?
      instructions:
      - text: Show document requirement setting {setting_id}.
        slots:
          setting_id: path.id
      - text: Get requirement setting record {setting_id}.
        slots:
          setting_id: path.id
      method: generated
      generated: '2026-10-01'