ZnanyLekarz · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Docplanner Integrations Calendars API

4 actions 4 updates phrasing extends openapi/znanylekarz-calendars-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 4

$.info
$.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/calendar'].get
$.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/calendar/enable'].post
$.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/calendar/disable'].post

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 Calendars API
  version: 1.0.0
extends: openapi/znanylekarz-calendars-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: 3
- target: $.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/calendar'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an address's calendar status
      effect: read
      questions:
      - Is the online calendar turned on for a doctor's address?
      - How do I check the calendar settings of a specific address?
      instructions:
      - text: Get the calendar for address {address} of doctor {doctor} in facility {facility}.
        slots:
          facility: path.facility_id
          doctor: path.doctor_id
          address: path.address_id
      - text: Check whether address {address} has its calendar enabled.
        slots:
          address: path.address_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/calendar/enable'].post
  update:
    x-apievangelist-phrasing:
      intent: Turn on the calendar for an address
      effect: write
      questions:
      - How do I enable online booking on a doctor's address calendar?
      - Can I switch an address's calendar back on after it was disabled?
      instructions:
      - text: Enable the calendar on address {address} of doctor {doctor} in facility {facility}.
        slots:
          facility: path.facility_id
          doctor: path.doctor_id
          address: path.address_id
      - text: Turn on the calendar for address {address}.
        slots:
          address: path.address_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/calendar/disable'].post
  update:
    x-apievangelist-phrasing:
      intent: Turn off the calendar for an address
      effect: write
      questions:
      - How do I stop patients booking at an address by disabling its calendar?
      - What happens to an address when I switch its calendar off?
      instructions:
      - text: Disable the calendar on address {address} of doctor {doctor} in facility {facility}.
        slots:
          facility: path.facility_id
          doctor: path.doctor_id
          address: path.address_id
      - text: Switch off the calendar for address {address}.
        slots:
          address: path.address_id
      method: generated
      generated: '2026-10-01'