Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Contracts Contract Request API

12 actions 12 updates phrasing extends openapi/conga-contract-request-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 12

$.info
$.paths['/api/clm/v1/requests'].post
$.paths['/api/clm/v1/requests/incoming-requests'].post
$.paths['/api/clm/v1/requests/query'].post
$.paths['/api/clm/v1/requests/{contractRequestId}/convert'].post
$.paths['/api/clm/v1/requests/{id}'].get
$.paths['/api/clm/v1/requests/{id}'].put
$.paths['/api/clm/v1/requests/{id}'].delete
$.paths['/api/clm/v1/requests/{id}/action-eligibility'].get
$.paths['/api/clm/v1/requests/{id}/documents'].get
$.paths['/api/clm/v1/requests/{id}/documents'].post
$.paths['/api/clm/v1/requests/{id}/documents'].delete

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 Request API
  version: 1.0.0
extends: openapi/conga-contract-request-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: 11
- target: $.paths['/api/clm/v1/requests'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a contract request
      effect: write
      questions:
      - How do I submit a new contract request in Conga CLM?
      - Which fields are mandatory on a new contract request?
      instructions:
      - text: Create a contract request with the name and record type I provide.
      - text: File a new contract request record.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/requests/incoming-requests'].post
  update:
    x-apievangelist-phrasing:
      intent: List incoming requests awaiting my approval
      effect: read
      questions:
      - Which contract requests are waiting for me or my groups to approve?
      - Can I filter the pending approval queue?
      instructions:
      - text: Show contract requests pending my approval.
      - text: List incoming requests in my approval queue matching {criteria}.
        slots:
          criteria: requestBody.CriteriaExpression
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/requests/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Search contract requests
      effect: read
      questions:
      - Can I search all contract request records with custom criteria?
      - What fields can I return when querying contract requests?
      instructions:
      - text: Search contract requests matching {criteria}.
        slots:
          criteria: requestBody.CriteriaExpression
      - text: Query contract requests returning {fields}, limit {limit}.
        slots:
          fields: requestBody.Fields
          limit: requestBody.Limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/requests/{contractRequestId}/convert'].post
  update:
    x-apievangelist-phrasing:
      intent: Convert a contract request to an agreement
      effect: write
      questions:
      - How do I turn an approved contract request into an agreement?
      - Can document AI run on copied documents during conversion?
      instructions:
      - text: Convert contract request {request_id} into an agreement.
        slots:
          request_id: path.contractRequestId
      - text: Convert request {request_id} using document AI with worksheet {worksheet_id}.
        slots:
          request_id: path.contractRequestId
          worksheet_id: query.worksheetId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/requests/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a contract request
      effect: read
      questions:
      - What are the details of a specific contract request?
      - Can I look up one contract request by ID?
      instructions:
      - text: Show contract request {request_id}.
        slots:
          request_id: path.id
      - text: Get the details of request {request_id}.
        slots:
          request_id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/requests/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a contract request
      effect: write
      questions:
      - Can I edit an existing contract request's fields?
      - Which fields are required when updating a contract request?
      instructions:
      - text: Update contract request {request_id} with these values.
        slots:
          request_id: path.id
      - text: Change the details on request {request_id}.
        slots:
          request_id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/requests/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a contract request
      effect: destructive
      questions:
      - How do I permanently remove a contract request?
      - Is deleting a contract request reversible?
      instructions:
      - text: Delete contract request {request_id}.
        slots:
          request_id: path.id
      - text: Permanently remove request {request_id}.
        slots:
          request_id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/requests/{id}/action-eligibility'].get
  update:
    x-apievangelist-phrasing:
      intent: Check my authority on a contract request
      effect: read
      questions:
      - Am I allowed to approve, reject or convert a given contract request?
      - Which actions does my role permit on a contract request?
      instructions:
      - text: Check whether I can approve or convert request {request_id}.
        slots:
          request_id: path.id
      - text: Show my action eligibility for contract request {request_id}.
        slots:
          request_id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/requests/{id}/documents'].get
  update:
    x-apievangelist-phrasing:
      intent: List a contract request's documents
      effect: read
      questions:
      - Which documents are attached to a contract request?
      - Can I see the metadata of documents on a request?
      instructions:
      - text: List the documents on contract request {request_id}.
        slots:
          request_id: path.id
      - text: Show document metadata for request {request_id}.
        slots:
          request_id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/requests/{id}/documents'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload documents to a contract request
      effect: write
      questions:
      - How do I attach a file to a contract request?
      - Can I set document attributes while uploading to a request?
      instructions:
      - text: Upload {file} to contract request {request_id}.
        slots:
          file: requestBody.file
          request_id: path.id
      - text: Attach a document with attributes {attributes} to request {request_id}.
        slots:
          attributes: requestBody.documentAttributes
          request_id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/requests/{id}/documents'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete documents from a contract request
      effect: destructive
      questions:
      - Can I remove several attached documents from a contract request?
      - What's the way to delete files I uploaded to a request?
      instructions:
      - text: Delete the listed documents from contract request {request_id}.
        slots:
          request_id: path.id
      - text: Remove attachments from request {request_id}.
        slots:
          request_id: path.id
      method: generated
      generated: '2026-10-01'