ZnanyLekarz · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Docplanner Integrations Facilities API

3 actions 3 updates phrasing extends openapi/znanylekarz-facilities-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'].get

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

OpenAPI Overlay

# 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 Facilities API
  version: 1.0.0
extends: openapi/znanylekarz-facilities-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'].get
  update:
    x-apievangelist-phrasing:
      intent: List my facilities
      effect: read
      questions:
      - Which facilities does my ZnanyLekarz integration have access to?
      - What clinics can I manage through this account?
      instructions:
      - text: List all my facilities.
      - text: Show the clinics I can integrate with.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/facilities/{facility_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one facility's details
      effect: read
      questions:
      - How do I fetch the details of a single facility?
      - Can I get a facility along with every doctor who works there?
      instructions:
      - text: Get facility {facility}.
        slots:
          facility: path.facility_id
      - text: Show facility {facility} with the {with} extension to include its doctors.
        slots:
          facility: path.facility_id
          with: query.with
      method: generated
      generated: '2026-10-01'