# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for SendPulse CRM Public Deal notes API
  version: 1.0.0
extends: openapi/sendpulse-deal-notes-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: 4
- target: $.paths['/deals/{dealId}/comments'].get
  update:
    x-apievangelist-phrasing:
      intent: List notes on a deal
      effect: read
      questions:
      - What notes have been left on a deal?
      - Can I see who wrote each note on a deal?
      instructions:
      - text: List the notes on deal {dealId}.
        slots:
          dealId: path.dealId
      - text: Show all comments left on deal {dealId}.
        slots:
          dealId: path.dealId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deals/{dealId}/comments'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a note to a deal
      effect: write
      questions:
      - How do I add a note to a deal?
      - Can I log a comment on a deal record?
      instructions:
      - text: Add the note {message} to deal {dealId}.
        slots:
          message: requestBody.message
          dealId: path.dealId
      - text: 'Log on deal {dealId}: {message}.'
        slots:
          dealId: path.dealId
          message: requestBody.message
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deals/{dealId}/comments/{commentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a note on a deal
      effect: write
      questions:
      - Can I edit a note I already added to a deal?
      - Does changing a deal note overwrite the old text?
      instructions:
      - text: Change note {commentId} on deal {dealId} to {message}.
        slots:
          commentId: path.commentId
          dealId: path.dealId
          message: requestBody.message
      - text: Rewrite deal {dealId} note {commentId} as {message}.
        slots:
          dealId: path.dealId
          commentId: path.commentId
          message: requestBody.message
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deals/{dealId}/comments/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a note from a deal
      effect: destructive
      questions:
      - Can I delete a note from a deal?
      - What's the way to remove a wrong comment on a deal?
      instructions:
      - text: Delete note {commentId} from deal {dealId}.
        slots:
          commentId: path.commentId
          dealId: path.dealId
      - text: Remove comment {commentId} on deal {dealId}.
        slots:
          commentId: path.commentId
          dealId: path.dealId
      method: generated
      generated: '2026-10-01'