# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cart - V1 Collaboration Request API
  version: 1.0.0
extends: openapi/conga-collaborationrequest-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: 7
- target: $.paths['/api/cart/v1/carts/collaboration-request'].get
  update:
    x-apievangelist-phrasing:
      intent: List collaboration requests
      effect: read
      questions:
      - Which cart collaboration requests are open in Conga CPQ?
      - Can I filter and page through all collaboration requests?
      instructions:
      - text: List all cart collaboration requests.
      - text: Find collaboration requests matching {filter}, {limit} at a time.
        slots:
          filter: query.filter
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/collaboration-request/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a collaboration request
      effect: read
      questions:
      - What are the details of one specific collaboration request?
      - Who owns a given collaboration request and when is it due?
      instructions:
      - text: Fetch collaboration request {id}.
        slots:
          id: path.id
      - text: Show me the due date and owner of collaboration request {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/collaboration-request/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a collaboration request
      effect: destructive
      questions:
      - How do I cancel a collaboration request I no longer need?
      - Can I delete a collaboration request that was sent by mistake?
      instructions:
      - text: Cancel collaboration request {id}.
        slots:
          id: path.id
      - text: Delete the collaboration request with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/collaboration-request/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a collaboration request
      effect: write
      questions:
      - Can I change the due date or priority of an existing collaboration request?
      - Is it possible to reassign the primary contact on a collaboration request?
      instructions:
      - text: Set the completion due date of collaboration request {id} to {completionDueDate}.
        slots:
          id: path.id
          completionDueDate: requestBody.completionDueDate
      - text: Change priority on collaboration request {id} to {priority}.
        slots:
          id: path.id
          priority: requestBody.priority
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/collaboration-request'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a collaboration request on a cart
      effect: write
      questions:
      - How do I ask a colleague to collaborate on some line items of my cart?
      - Can I send only certain cart line numbers out for collaboration?
      - What can I set when creating a collaboration request, like due date and priority?
      instructions:
      - text: Create a collaboration request on cart {cartId} for line numbers {lineNumbers}.
        slots:
          cartId: path.cartId
          lineNumbers: requestBody.lineNumbers
      - text: Open a new collaboration request named {name} on cart {cartId} due {completionDueDate}.
        slots:
          name: requestBody.name
          cartId: path.cartId
          completionDueDate: requestBody.completionDueDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/collaboration-request/{id}/merge'].post
  update:
    x-apievangelist-phrasing:
      intent: Merge a collaboration request into its cart
      effect: write
      questions:
      - How do I bring a collaborator's changes back into the parent cart?
      - Can I merge a finished collaboration request into the main cart?
      instructions:
      - text: Merge collaboration request {id} into cart {cartId}.
        slots:
          id: path.id
          cartId: path.cartId
      - text: Pull the work from collaboration {id} back into parent cart {cartId}.
        slots:
          id: path.id
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/collaboration-request/{id}/submit-for-merge'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a collaboration request for merge
      effect: write
      questions:
      - As a collaborator, how do I hand my finished work back for merging?
      - Can I mark a collaboration request ready to be merged without merging it myself?
      instructions:
      - text: Submit collaboration request {id} on cart {cartId} for merge.
        slots:
          id: path.id
          cartId: path.cartId
      - text: Mark collaboration {id} of cart {cartId} as ready for the owner to merge.
        slots:
          id: path.id
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'