# 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 Library API
  version: 1.0.0
extends: openapi/conga-clauselibrary-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/clauses/advance-query'].post
  update:
    x-apievangelist-phrasing:
      intent: Filter clauses with an advanced query
      effect: read
      questions:
      - Can I filter clauses by arbitrary fields, sort them and group them?
      - What's the way to run a field-level advanced query over clauses?
      instructions:
      - text: Filter clauses using {filters}, ordered by {order_by}.
        slots:
          filters: requestBody.filters
          order_by: requestBody.orderBy
      - text: Run an advanced clause query returning {fields}, limit {limit}.
        slots:
          fields: requestBody.fields
          limit: requestBody.limit
      - text: Advanced-filter clauses for org type {org_type}.
        slots:
          org_type: header.OrgType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/clauses/promote'].post
  update:
    x-apievangelist-phrasing:
      intent: Promote a marked clause to the clause library
      effect: write
      questions:
      - How do I add a clause marked in an agreement into the shared clause library?
      - Can a promoted clause be saved as a draft or activated right away?
      instructions:
      - text: Promote clause {name} from the agreement into the clause library.
        slots:
          name: requestBody.name
      - text: Promote marked clause {reference_id} and activate it.
        slots:
          reference_id: requestBody.referenceId
      - text: Promote a clause to the library for org type {org_type}.
        slots:
          org_type: header.OrgType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/clauses/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Browse clauses in the clause library
      effect: read
      questions:
      - Which reusable clauses in the library fit a given category and locale?
      - Can I find library clauses for a specific agreement or contract type?
      instructions:
      - text: Get library clauses in category {category}.
        slots:
          category: requestBody.category
      - text: Show library clauses usable on agreement {agreement_id}, {size} at a time.
        slots:
          agreement_id: requestBody.agreementId
          size: requestBody.size
      - text: List clause library entries in language {language} for org type {org_type}.
        slots:
          language: requestBody.language
          org_type: header.OrgType
      method: generated
      generated: '2026-10-01'