ZnanyLekarz · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Docplanner Integrations Bookings API

7 actions 7 updates phrasing extends openapi/znanylekarz-bookings-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for ZnanyLekarz's API. It is a proposal applied on top of the contract, not a document ZnanyLekarz publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/bookings'].get
$.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/bookings/{booking_id}'].get
$.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/bookings/{booking_id}'].delete
$.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/bookings/{booking_id}/move'].post
$.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/bookings/{booking_id}/confirm'].put
$.paths['/facilities/{facility_id}/doctors/{doctor_id}/opinion-request'].put

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Docplanner Integrations Bookings API
  version: 1.0.0
extends: openapi/znanylekarz-bookings-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: 6
- target: $.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/bookings'].get
  update:
    x-apievangelist-phrasing:
      intent: List a doctor's bookings in a date range
      effect: read
      questions:
      - How do I see all appointments booked with a doctor at an address between two dates?
      - Can I page through bookings and include patient details?
      - Which visits are booked for this doctor next week?
      instructions:
      - text: List bookings for doctor {doctor} at address {address} in facility {facility} from {start} to {end}.
        slots:
          facility: path.facility_id
          doctor: path.doctor_id
          address: path.address_id
          start: query.start
          end: query.end
      - text: Show page {page} of bookings between {start} and {end} for address {address}, {limit} per page.
        slots:
          page: query.page
          start: query.start
          end: query.end
          address: path.address_id
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/bookings/{booking_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a single booking
      effect: read
      questions:
      - How do I look up the details of one specific appointment?
      - Can I tell whether a booking was moved and what its original booking was?
      instructions:
      - text: Get booking {booking} for doctor {doctor} at address {address} in facility {facility}.
        slots:
          facility: path.facility_id
          doctor: path.doctor_id
          address: path.address_id
          booking: path.booking_id
      - text: Show booking {booking} with the {with} extension so I can see its move history.
        slots:
          booking: path.booking_id
          with: query.with
      method: generated
      generated: '2026-10-01'
- target: $.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/bookings/{booking_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a patient's booking
      effect: destructive
      questions:
      - How do I cancel a patient's appointment on ZnanyLekarz?
      - Can I record a reason when cancelling a visit?
      instructions:
      - text: Cancel booking {booking} for doctor {doctor} at address {address} in facility {facility}.
        slots:
          facility: path.facility_id
          doctor: path.doctor_id
          address: path.address_id
          booking: path.booking_id
      - text: Cancel booking {booking} because {reason}.
        slots:
          booking: path.booking_id
          reason: requestBody.reason
      method: generated
      generated: '2026-10-01'
- target: $.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/bookings/{booking_id}/move'].post
  update:
    x-apievangelist-phrasing:
      intent: Reschedule a booking to a new time or doctor
      effect: write
      questions:
      - How do I reschedule an existing appointment to a different time?
      - Can I move a booking to another doctor in the same facility?
      instructions:
      - text: Move booking {booking} at address {address} of doctor {doctor} in facility {facility} to {start} for service {address_service_id}.
        slots:
          facility: path.facility_id
          doctor: path.doctor_id
          address: path.address_id
          booking: path.booking_id
          start: requestBody.start
          address_service_id: requestBody.address_service_id
      - text: Reassign booking {booking} to address {new_address} with service {address_service_id}.
        slots:
          booking: path.booking_id
          new_address: requestBody.address_id
          address_service_id: requestBody.address_service_id
      - text: Change booking {booking} to last {duration} minutes for service {address_service_id}.
        slots:
          booking: path.booking_id
          duration: requestBody.duration
          address_service_id: requestBody.address_service_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/bookings/{booking_id}/confirm'].put
  update:
    x-apievangelist-phrasing:
      intent: Confirm a patient's booking
      effect: write
      questions:
      - How do I mark an appointment as confirmed?
      - Do I have to say who confirmed a booking?
      instructions:
      - text: Confirm booking {booking} for doctor {doctor} at address {address} in facility {facility}, confirmed by {confirmed_by}.
        slots:
          facility: path.facility_id
          doctor: path.doctor_id
          address: path.address_id
          booking: path.booking_id
          confirmed_by: requestBody.confirmed_by
      - text: Mark booking {booking} as confirmed by {confirmed_by}.
        slots:
          booking: path.booking_id
          confirmed_by: requestBody.confirmed_by
      method: generated
      generated: '2026-10-01'
- target: $.paths['/facilities/{facility_id}/doctors/{doctor_id}/opinion-request'].put
  update:
    x-apievangelist-phrasing:
      intent: Ask a patient by SMS to leave a review
      effect: write
      questions:
      - Can I send a patient an SMS asking them to review the doctor after a visit booked in our clinic software?
      - What do I need to request a patient opinion for a doctor?
      instructions:
      - text: Send an opinion request SMS to {phone} for doctor {doctor} in facility {facility}.
        slots:
          phone: requestBody.phone
          doctor: path.doctor_id
          facility: path.facility_id
      - text: Ask the patient at {phone} to leave a review of their visit.
        slots:
          phone: requestBody.phone
      method: generated
      generated: '2026-10-01'