Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for X-Author Intelligent Import Risk API

6 actions 6 updates phrasing extends openapi/conga-intelligentimportrisk-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 6

$.info
$.paths['/api/xauthor/v1/intelligent-imports/risks/insight/delete'].post
$.paths['/api/xauthor/v1/intelligent-imports/risks/insights'].post
$.paths['/api/xauthor/v1/intelligent-imports/risks/insights'].patch
$.paths['/api/xauthor/v1/intelligent-imports/risks/insights/query'].post
$.paths['/api/xauthor/v1/intelligent-imports/risks/scales'].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 X-Author Intelligent Import Risk API
  version: 1.0.0
extends: openapi/conga-intelligentimportrisk-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: 5
- target: $.paths['/api/xauthor/v1/intelligent-imports/risks/insight/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete risk insights
      effect: destructive
      questions:
      - Can I delete risk insights recorded for a contract?
      - How do I remove a risk insight record?
      instructions:
      - text: Delete risk insight record {record}.
        slots:
          record: requestBody.deleteRecordId
      - text: Remove risk insights for request {request}.
        slots:
          request: requestBody.riskInsightRequest
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/intelligent-imports/risks/insights'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a risk insight score
      effect: write
      questions:
      - How do I record a risk insight for a document?
      - Can I attach a new risk score to an imported contract?
      instructions:
      - text: Add risk insight {insight}.
        slots:
          insight: requestBody.insight
      - text: Record a risk score for request {request}.
        slots:
          request: requestBody.riskInsightRequest
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/intelligent-imports/risks/insights'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a risk insight score
      effect: write
      questions:
      - Can I change the risk score on a record?
      - How do I update a document's risk level?
      instructions:
      - text: Set risk score {score} on record {record}.
        slots:
          score: requestBody.riskScore
          record: requestBody.recordId
      - text: Change the risk level of record {record} to {level}.
        slots:
          record: requestBody.recordId
          level: requestBody.riskLevel
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/intelligent-imports/risks/insights/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Get risk insight data
      effect: read
      questions:
      - What risk insights exist for a document?
      - Can I look up risk data for an attachment?
      instructions:
      - text: Get risk insights for document {doc}.
        slots:
          doc: requestBody.documentId
      - text: Show risk data for attachment {attachment} on object {object}.
        slots:
          attachment: requestBody.attachmentId
          object: requestBody.objectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/intelligent-imports/risks/scales'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the risk scale
      effect: read
      questions:
      - What risk levels and scale does intelligent import use?
      - How is a risk score mapped to a level?
      instructions:
      - text: Show the risk scale data for org type {org}.
        slots:
          org: header.OrgType
      - text: Get the risk scale definitions.
      method: generated
      generated: '2026-10-01'