# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Punchh Feedback API
  version: 1.0.0
extends: openapi/punchh-feedback-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['/api2/mobile/feedbacks'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit guest feedback from the app
      effect: write
      questions:
      - How does a guest leave a rating and comment about a visit in the app?
      - Can a guest ask the business to contact them about their feedback?
      instructions:
      - text: Leave a {rating} rating with the comment {message}.
        slots:
          rating: requestBody.rating
          message: requestBody.message
      - text: Submit my feedback {message} for check-in {checkin_id} and ask for a reply {requires_response}.
        slots:
          message: requestBody.message
          checkin_id: requestBody.checkin_id
          requires_response: requestBody.requires_response
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/mobile/feedbacks/{feedback_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Attach media to feedback from the app
      effect: write
      questions:
      - Can a guest add a photo or video to feedback they already sent from the app?
      - How does the app link existing feedback to a check-in?
      instructions:
      - text: Add photo {photo_url} to my feedback {feedback_id}.
        slots:
          photo_url: requestBody.photo_url
          feedback_id: path.feedback_id
      - text: Attach video {video_url} to app feedback {feedback_id}.
        slots:
          video_url: requestBody.video_url
          feedback_id: path.feedback_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/dashboard/feedbacks'].post
  update:
    x-apievangelist-phrasing:
      intent: Record feedback for a guest from the back end
      effect: write
      questions:
      - How can our support system log feedback for a guest without their access token?
      - Can I record a guest's rating by user ID from the dashboard side?
      instructions:
      - text: Record feedback {message} with rating {rating} for user {user_id}.
        slots:
          message: requestBody.message
          rating: requestBody.rating
          user_id: requestBody.user_id
      - text: Log admin feedback for user {user_id} on check-in {checkin_id}.
        slots:
          user_id: requestBody.user_id
          checkin_id: requestBody.checkin_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/dashboard/feedbacks/{feedback_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a guest's feedback from the back end
      effect: write
      questions:
      - Can an admin edit the message on feedback that was already recorded?
      - How do I flag existing feedback as needing a response from the dashboard?
      instructions:
      - text: Update feedback {feedback_id} with the message {message} as an admin.
        slots:
          feedback_id: path.feedback_id
          message: requestBody.message
      - text: 'Mark dashboard feedback {feedback_id} as requiring a response: {requires_response}.'
        slots:
          feedback_id: path.feedback_id
          requires_response: requestBody.requires_response
      method: generated
      generated: '2026-10-01'