# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Contracts Clause Obligations API
  version: 1.0.0
extends: openapi/conga-clause-obligations-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: 6
- target: $.paths['/api/clm/v1/clauses/{clauseId}/obligations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an obligation on a clause
      effect: write
      questions:
      - Can I attach a new obligation to a clause in the clause library?
      - Does creating a clause obligation also add it to the master obligations?
      instructions:
      - text: Create an obligation for clause {clause}.
        slots:
          clause: path.clauseId
      - text: Add a new master obligation linked to clause {clause}.
        slots:
          clause: path.clauseId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/clauses/{clauseId}/obligations'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete obligations from a clause
      effect: destructive
      questions:
      - Can I remove several obligations from a clause at once?
      - How do I clear every obligation tied to a clause?
      instructions:
      - text: Delete the listed obligations from clause {clause}.
        slots:
          clause: path.clauseId
      - text: 'Remove all obligations from clause {clause}: {all}.'
        slots:
          clause: path.clauseId
          all: query.deleteAll
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/clauses/{clauseId}/obligations/query'].post
  update:
    x-apievangelist-phrasing:
      intent: List a clause's obligations
      effect: read
      questions:
      - Which obligations are defined on a particular clause?
      - Can I filter and sort the obligations attached to a clause?
      instructions:
      - text: List the obligations of clause {clause}.
        slots:
          clause: path.clauseId
      - text: Show {limit} obligations on clause {clause} matching {criteria}.
        slots:
          limit: requestBody.Limit
          clause: path.clauseId
          criteria: requestBody.CriteriaExpression
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/clauses/{clauseId}/obligations/{obligationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one clause obligation
      effect: read
      questions:
      - How do I read the details of a single obligation on a clause?
      - What does a specific clause obligation require?
      instructions:
      - text: Get obligation {obligation} on clause {clause}.
        slots:
          obligation: path.obligationId
          clause: path.clauseId
      - text: Show clause {clause} obligation {obligation}.
        slots:
          clause: path.clauseId
          obligation: path.obligationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/clauses/{clauseId}/obligations/{obligationId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a clause obligation
      effect: write
      questions:
      - What's the way to edit an obligation that is attached to a clause?
      - Can I change the details of an existing clause obligation?
      instructions:
      - text: Update obligation {obligation} on clause {clause}.
        slots:
          obligation: path.obligationId
          clause: path.clauseId
      - text: Edit the clause {clause} obligation {obligation} with these values.
        slots:
          clause: path.clauseId
          obligation: path.obligationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/clauses/{clauseId}/obligations/{obligationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one clause obligation
      effect: destructive
      questions:
      - How do I delete a single obligation from a clause by its ID?
      - Is removing one clause obligation reversible?
      instructions:
      - text: Delete obligation {obligation} from clause {clause}.
        slots:
          obligation: path.obligationId
          clause: path.clauseId
      - text: Remove just clause obligation {obligation} on {clause}.
        slots:
          obligation: path.obligationId
          clause: path.clauseId
      method: generated
      generated: '2026-10-01'