ZnanyLekarz · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Docplanner Integrations Services API

7 actions 7 updates phrasing extends openapi/znanylekarz-services-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['/services'].get
$.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/services'].get
$.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/services'].post
$.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/services/{address_service_id}'].get
$.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/services/{address_service_id}'].delete
$.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/services/{address_service_id}'].patch

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 Services API
  version: 1.0.0
extends: openapi/znanylekarz-services-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['/services'].get
  update:
    x-apievangelist-phrasing:
      intent: List the dictionary of services
      effect: read
      questions:
      - Which services are in the ZnanyLekarz service dictionary?
      - Can I filter dictionary services by specialization?
      - Is there a way to list only diagnostic services?
      instructions:
      - text: List all dictionary services.
      - text: List dictionary services for specialization {specialization_id}.
        slots:
          specialization_id: query.specialization_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/services'].get
  update:
    x-apievangelist-phrasing:
      intent: List services offered at an address
      effect: read
      questions:
      - What services does a doctor offer at a particular address, with prices?
      - Which patients are allowed for each service at an address?
      instructions:
      - text: List services offered at address {address} of doctor {doctor} in facility {facility}.
        slots:
          facility: path.facility_id
          doctor: path.doctor_id
          address: path.address_id
      - text: Show address {address}'s services with the {with} extension, from {start}.
        slots:
          address: path.address_id
          with: query.with
          start: query.start
      method: generated
      generated: '2026-10-01'
- target: $.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/services'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a service to a doctor's address
      effect: write
      questions:
      - How do I start offering a new service at a doctor's address?
      - Can I set a 'from' price and a custom name when adding a service?
      instructions:
      - text: Add service {service_id} to address {address} of doctor {doctor} in facility {facility}.
        slots:
          facility: path.facility_id
          doctor: path.doctor_id
          address: path.address_id
          service_id: requestBody.service_id
      - text: Add service {service_id} to address {address} at price {price}, named {custom_name}.
        slots:
          service_id: requestBody.service_id
          address: path.address_id
          price: requestBody.price
          custom_name: requestBody.custom_name
      - text: Add service {service_id} to address {address} with visibility {is_visible} and a default duration of {default_duration} minutes.
        slots:
          service_id: requestBody.service_id
          address: path.address_id
          default_duration: requestBody.default_duration
          is_visible: requestBody.is_visible
      method: generated
      generated: '2026-10-01'
- target: $.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/services/{address_service_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one service offered at an address
      effect: read
      questions:
      - How do I see the price and duration of one service a doctor offers at an address?
      - Which patients can book this particular address service?
      instructions:
      - text: Get address service {address_service} at address {address} of doctor {doctor} in facility {facility}.
        slots:
          facility: path.facility_id
          doctor: path.doctor_id
          address: path.address_id
          address_service: path.address_service_id
      - text: Show address service {address_service} with extension {with}.
        slots:
          address_service: path.address_service_id
          with: query.with
      method: generated
      generated: '2026-10-01'
- target: $.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/services/{address_service_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a service from an address
      effect: destructive
      questions:
      - How do I stop offering a service at one of a doctor's addresses?
      - Does deleting an address service remove it from the global dictionary?
      instructions:
      - text: Delete address service {address_service} from address {address} of doctor {doctor} in facility {facility}.
        slots:
          facility: path.facility_id
          doctor: path.doctor_id
          address: path.address_id
          address_service: path.address_service_id
      - text: Remove service {address_service} from address {address}.
        slots:
          address_service: path.address_service_id
          address: path.address_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/services/{address_service_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a service's price or settings
      effect: write
      questions:
      - How do I change the price of a service a doctor already offers at an address?
      - Can I hide an existing address service or change its default duration?
      instructions:
      - text: Update address service {address_service} at address {address} of doctor {doctor} in facility {facility}.
        slots:
          facility: path.facility_id
          doctor: path.doctor_id
          address: path.address_id
          address_service: path.address_service_id
      - text: Change the price of existing address service {address_service} to {price}.
        slots:
          address_service: path.address_service_id
          price: requestBody.price
      - text: Set visibility of address service {address_service} to {is_visible} and its default duration to {default_duration}.
        slots:
          address_service: path.address_service_id
          is_visible: requestBody.is_visible
          default_duration: requestBody.default_duration
      method: generated
      generated: '2026-10-01'