API Evangelist conversational phrasing for Docplanner Integrations Calendar Breaks API

# 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 Calendar Breaks API
  version: 1.0.0
extends: openapi/znanylekarz-calendar-breaks-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: 5
- target: $.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/breaks'].get
  update:
    x-apievangelist-phrasing:
      intent: List calendar breaks in a date range
      effect: read
      questions:
      - Which breaks are blocked out in a doctor's calendar this month?
      - How do I see the time-off blocks for an address between two dates?
      instructions:
      - text: List calendar breaks for doctor {doctor} at address {address} in facility {facility} from {since} to {till}.
        slots:
          facility: path.facility_id
          doctor: path.doctor_id
          address: path.address_id
          since: query.since
          till: query.till
      - text: Show breaks on address {address} between {since} and {till}.
        slots:
          address: path.address_id
          since: query.since
          till: query.till
      method: generated
      generated: '2026-10-01'
- target: $.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/breaks'].post
  update:
    x-apievangelist-phrasing:
      intent: Block out a break in a doctor's calendar
      effect: write
      questions:
      - How do I add a lunch break or day off to a doctor's calendar?
      - Can a new break also apply to the doctor's coupled addresses?
      instructions:
      - text: Add a break from {since} to {till} on address {address} of doctor {doctor} in facility {facility}.
        slots:
          facility: path.facility_id
          doctor: path.doctor_id
          address: path.address_id
          since: requestBody.since
          till: requestBody.till
      - text: Block {since} to {till} on address {address} labelled {description}, and on coupled addresses too ({apply_on_coupled_addresses}).
        slots:
          since: requestBody.since
          till: requestBody.till
          address: path.address_id
          description: requestBody.description
          apply_on_coupled_addresses: requestBody.apply_on_coupled_addresses
      method: generated
      generated: '2026-10-01'
- target: $.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/breaks/{break_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View one calendar break
      effect: read
      questions:
      - How do I check the start and end of one specific calendar break?
      - What description was given to this break?
      instructions:
      - text: Get break {break_id} on address {address} of doctor {doctor} in facility {facility}.
        slots:
          facility: path.facility_id
          doctor: path.doctor_id
          address: path.address_id
          break_id: path.break_id
      - text: Show me the details of calendar break {break_id}.
        slots:
          break_id: path.break_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/breaks/{break_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a calendar break
      effect: destructive
      questions:
      - How do I remove a break so the doctor's time is open again?
      - Will deleting a break also remove the copies on coupled addresses?
      instructions:
      - text: Delete break {break_id} on address {address} of doctor {doctor} in facility {facility}.
        slots:
          facility: path.facility_id
          doctor: path.doctor_id
          address: path.address_id
          break_id: path.break_id
      - text: Remove calendar break {break_id}.
        slots:
          break_id: path.break_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/breaks/{break_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Move a calendar break to a new time
      effect: write
      questions:
      - Can I shift an existing break to a different time range instead of recreating it?
      - Do coupled-address breaks move along when I reschedule the original break?
      instructions:
      - text: Move break {break_id} on address {address} of doctor {doctor} in facility {facility} to {since}–{till}.
        slots:
          facility: path.facility_id
          doctor: path.doctor_id
          address: path.address_id
          break_id: path.break_id
          since: requestBody.since
          till: requestBody.till
      - text: Reschedule calendar break {break_id} to run from {since} until {till}.
        slots:
          break_id: path.break_id
          since: requestBody.since
          till: requestBody.till
      method: generated
      generated: '2026-10-01'