# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Postman Collection Responses API
  version: 1.0.0
extends: openapi/postman-collection-responses-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['/collections/{collectionId}/responses/{responseId}/comments'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on a saved response
      effect: read
      questions:
      - What comments have been left on this example response?
      - Can I read the discussion on a saved response?
      instructions:
      - text: List comments on response {responseId} in collection {collectionId}.
        slots:
          responseId: path.responseId
          collectionId: path.collectionId
      - text: Show the discussion on example response {responseId} of {collectionId}.
        slots:
          responseId: path.responseId
          collectionId: path.collectionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/collections/{collectionId}/responses/{responseId}/comments'].post
  update:
    x-apievangelist-phrasing:
      intent: Comment on a saved response
      effect: write
      questions:
      - How do I comment on an example response?
      - Can I reply to an existing comment thread on a response?
      instructions:
      - text: Comment {body} on response {responseId} in collection {collectionId}.
        slots:
          body: requestBody.body
          responseId: path.responseId
          collectionId: path.collectionId
      - text: Reply {body} to thread {threadId} on response {responseId} of {collectionId}.
        slots:
          body: requestBody.body
          threadId: requestBody.threadId
          responseId: path.responseId
          collectionId: path.collectionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/collections/{collectionId}/responses/{responseId}/comments/{commentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a comment on a saved response
      effect: write
      questions:
      - Can I edit my comment on an example response?
      - Is there a length limit when editing a response comment?
      instructions:
      - text: Change comment {commentId} on response {responseId} in {collectionId} to {body}.
        slots:
          commentId: path.commentId
          responseId: path.responseId
          collectionId: path.collectionId
          body: requestBody.body
      - text: Edit response comment {commentId} ({responseId}, {collectionId}) to read {body}.
        slots:
          commentId: path.commentId
          responseId: path.responseId
          collectionId: path.collectionId
          body: requestBody.body
      method: generated
      generated: '2026-10-01'
- target: $.paths['/collections/{collectionId}/responses/{responseId}/comments/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment on a saved response
      effect: destructive
      questions:
      - How do I delete a comment on an example response?
      - Will deleting the first response comment remove its replies too?
      instructions:
      - text: Delete comment {commentId} from response {responseId} in {collectionId}.
        slots:
          commentId: path.commentId
          responseId: path.responseId
          collectionId: path.collectionId
      - text: Remove response comment {commentId} on {responseId} of collection {collectionId}.
        slots:
          commentId: path.commentId
          responseId: path.responseId
          collectionId: path.collectionId
      method: generated
      generated: '2026-10-01'