API Evangelist conversational phrasing for Contracts Document Settings API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Contracts Document Settings API
  version: 1.0.0
extends: openapi/conga-document-settings-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/settings/documents/output-formats'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a document output format
      effect: write
      questions:
      - How do I change an existing document output format's properties?
      - Can I update a document output format by its ID in the body?
      instructions:
      - text: Update this document output format and its properties.
      - text: Edit an existing output format setting identified in the request.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/settings/documents/output-formats'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a document output format
      effect: write
      questions:
      - How do I set up a new document output format like PDF or DOCX?
      - Can I make a role-specific output format that includes a watermark?
      instructions:
      - text: Create a document output format {Name} producing {OutputFormat}.
        slots:
          Name: requestBody.Name
          OutputFormat: requestBody.OutputFormat
      - text: Add an output format for role {Role} with watermark set to {IncludeWatermark}.
        slots:
          Role: requestBody.Role
          IncludeWatermark: requestBody.IncludeWatermark
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/settings/documents/output-formats/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Query document output formats
      effect: read
      questions:
      - Which document output format records match my criteria?
      - Can I sort and limit results when searching output formats?
      instructions:
      - text: Find document output formats where {CriteriaExpression}.
        slots:
          CriteriaExpression: requestBody.CriteriaExpression
      - text: Show the first {Limit} document output format records.
        slots:
          Limit: requestBody.Limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/settings/documents/output-formats/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a document output format
      effect: read
      questions:
      - How do I look up one document output format by ID?
      - Can I see a single output format's watermark and role options?
      instructions:
      - text: Show document output format {id}.
        slots:
          id: path.id
      - text: Get details for output format {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/settings/documents/output-formats/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a document output format
      effect: destructive
      questions:
      - How do I delete a document output format I no longer use?
      - Can I remove an output format by its ID?
      instructions:
      - text: Delete document output format {id}.
        slots:
          id: path.id
      - text: Remove output format setting {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/settings/documents/protections'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a document protection setting
      effect: write
      questions:
      - How do I change fields on a document protection setting?
      - Can I update the protection level on an existing setting?
      instructions:
      - text: Update this document protection setting's fields.
      - text: Edit an existing protection setting identified in the request.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/settings/documents/protections'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a document protection setting
      effect: write
      questions:
      - How do I add document protection for a user role and contract type?
      - What protection levels and types can a new protection setting use?
      instructions:
      - text: Add a document protection setting for role {Role} at level {ProtectionLevel}.
        slots:
          Role: requestBody.Role
          ProtectionLevel: requestBody.ProtectionLevel
      - text: Create protection setting {Name} of type {ProtectionType}.
        slots:
          Name: requestBody.Name
          ProtectionType: requestBody.ProtectionType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/settings/documents/protections/clone'].post
  update:
    x-apievangelist-phrasing:
      intent: Copy protection settings between roles
      effect: write
      questions:
      - Can I copy one role's document protection settings to other roles?
      - Does cloning protection settings overwrite ones the destination role already has?
      instructions:
      - text: Copy document protection settings from role {SourceRoleId} to roles {DestinationRoles}.
        slots:
          SourceRoleId: requestBody.SourceRoleId
          DestinationRoles: requestBody.DestinationRoles
      - text: Clone protection setting {DocumentProtection} from {SourceRoleId} into {DestinationRoles}.
        slots:
          DocumentProtection: requestBody.DocumentProtection
          SourceRoleId: requestBody.SourceRoleId
          DestinationRoles: requestBody.DestinationRoles
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/settings/documents/protections/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Query document protection settings
      effect: read
      questions:
      - Which document protection settings match my filter?
      - Can I group or page through document protection settings?
      instructions:
      - text: Find document protection settings where {CriteriaExpression}.
        slots:
          CriteriaExpression: requestBody.CriteriaExpression
      - text: List protection settings skipping {Skip} and returning {Limit}.
        slots:
          Skip: requestBody.Skip
          Limit: requestBody.Limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/settings/documents/protections/{documentProtectionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a document protection setting
      effect: read
      questions:
      - How do I view one document protection setting?
      - Can I fetch a protection setting by its ID?
      instructions:
      - text: Show document protection setting {documentProtectionId}.
        slots:
          documentProtectionId: path.documentProtectionId
      - text: Get protection setting {documentProtectionId}'s details.
        slots:
          documentProtectionId: path.documentProtectionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/settings/documents/protections/{documentProtectionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a document protection setting
      effect: destructive
      questions:
      - How do I delete a document protection setting?
      - Can I remove a protection rule for a role by its ID?
      instructions:
      - text: Delete document protection setting {documentProtectionId}.
        slots:
          documentProtectionId: path.documentProtectionId
      - text: Remove protection setting {documentProtectionId}.
        slots:
          documentProtectionId: path.documentProtectionId
      method: generated
      generated: '2026-10-01'