# 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 Clause Content API
  version: 1.0.0
extends: openapi/conga-clausecontent-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['/api/xauthor/v1/clause-content/mark'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark plain text as a clause
      effect: write
      questions:
      - How can I turn a passage of plain text in an agreement into a tracked clause?
      - Can I set a risk rating or category when marking text as a clause?
      instructions:
      - text: Mark this text as clause {name} on agreement {agreement_id}.
        slots:
          name: requestBody.name
          agreement_id: requestBody.agreementId
      - text: Apply clause boundaries to the selected text with risk rating {risk_rating}.
        slots:
          risk_rating: requestBody.riskRating
      - text: Mark plain text as a clause for org type {org_type}.
        slots:
          org_type: header.OrgType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/clause-content/markup-metadata'].post
  update:
    x-apievangelist-phrasing:
      intent: Get encoded clause markup details
      effect: read
      questions:
      - Where do I get the markup clause details for a template or agreement in encoded form?
      - Can I preview clause markup metadata without marking anything?
      instructions:
      - text: Get the encoded clause markup details for agreement {agreement_id}.
        slots:
          agreement_id: requestBody.agreementId
      - text: Fetch clause markup metadata for org type {org_type}.
        slots:
          org_type: header.OrgType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/clause-content/{clauseId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Get clause content to insert in a document
      effect: read
      questions:
      - How do I pull a library clause's content so I can insert it into a document?
      - Can I keep the clause's own formatting when inserting it?
      instructions:
      - text: Get insertable content for clause {clause_id}.
        slots:
          clause_id: path.clauseId
      - text: Fetch clause {clause_id} content for agreement {agreement_id} with org type {org_type}.
        slots:
          clause_id: path.clauseId
          agreement_id: requestBody.agreementId
          org_type: header.OrgType
      method: generated
      generated: '2026-10-01'