ZnanyLekarz · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Docplanner Integrations Doctors API

3 actions 3 updates phrasing extends openapi/znanylekarz-doctors-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 3

$.info
$.paths['/facilities/{facility_id}/doctors'].get
$.paths['/facilities/{facility_id}/doctors/{doctor_id}'].get

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 Doctors API
  version: 1.0.0
extends: openapi/znanylekarz-doctors-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: 2
- target: $.paths['/facilities/{facility_id}/doctors'].get
  update:
    x-apievangelist-phrasing:
      intent: List the doctors in a facility
      effect: read
      questions:
      - Which doctors work in my facility on ZnanyLekarz?
      - Can I get every doctor's profile URL and specializations in one list?
      instructions:
      - text: List all doctors in facility {facility}.
        slots:
          facility: path.facility_id
      - text: List doctors in facility {facility} including the {with} extension.
        slots:
          facility: path.facility_id
          with: query.with
      method: generated
      generated: '2026-10-01'
- target: $.paths['/facilities/{facility_id}/doctors/{doctor_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one doctor's details
      effect: read
      questions:
      - How do I look up a single doctor's profile in a facility?
      - Can I get a doctor together with all of their addresses?
      instructions:
      - text: Get doctor {doctor} in facility {facility}.
        slots:
          doctor: path.doctor_id
          facility: path.facility_id
      - text: Show doctor {doctor} with the {with} extension so I can see their profile URL.
        slots:
          doctor: path.doctor_id
          with: query.with
      method: generated
      generated: '2026-10-01'