ZnanyLekarz · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Docplanner Integrations Addresses API

5 actions 5 updates phrasing extends openapi/znanylekarz-addresses-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 5

$.info
$.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses'].get
$.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}'].get
$.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}'].patch
$.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/integration'].delete

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 Addresses API
  version: 1.0.0
extends: openapi/znanylekarz-addresses-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['/facilities/{facility_id}/doctors/{doctor_id}/addresses'].get
  update:
    x-apievangelist-phrasing:
      intent: List a doctor's practice addresses
      effect: read
      questions:
      - Which addresses does a doctor practice at within a facility on ZnanyLekarz?
      - Can I see which of a doctor's addresses are only for video consultations?
      - What locations is this doctor registered under in our clinic?
      instructions:
      - text: List all addresses for doctor {doctor} in facility {facility}.
        slots:
          doctor: path.doctor_id
          facility: path.facility_id
      - text: Show doctor {doctor}'s addresses in facility {facility} with the {with} extension included.
        slots:
          doctor: path.doctor_id
          facility: path.facility_id
          with: query.with
      method: generated
      generated: '2026-10-01'
- target: $.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one of a doctor's addresses
      effect: read
      questions:
      - How do I look up the details of one specific doctor address?
      - Does a particular address of a doctor have visit payments enabled?
      instructions:
      - text: Get 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} for doctor {doctor} at facility {facility} is online-only, using extension {with}.
        slots:
          facility: path.facility_id
          doctor: path.doctor_id
          address: path.address_id
          with: query.with
      method: generated
      generated: '2026-10-01'
- target: $.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change insurance support on a doctor's address
      effect: write
      questions:
      - Can I change whether a doctor's address accepts insured patients?
      - Is it possible to switch an address between private-only and insurance-supported visits?
      instructions:
      - text: Set insurance support to {insurance_support} on address {address} of doctor {doctor} in facility {facility}.
        slots:
          facility: path.facility_id
          doctor: path.doctor_id
          address: path.address_id
          insurance_support: requestBody.insurance_support
      - text: Update the insurance support setting 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}/integration'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove the integration mark from an address
      effect: destructive
      questions:
      - How do I stop Docplanner treating an address as integrated with my system?
      - Does removing an address integration delete the address itself?
      instructions:
      - text: Remove the integration mark from address {address} of doctor {doctor} in facility {facility}.
        slots:
          facility: path.facility_id
          doctor: path.doctor_id
          address: path.address_id
      - text: Unlink address {address} from our PMS integration without deleting it.
        slots:
          address: path.address_id
      method: generated
      generated: '2026-10-01'