ZnanyLekarz · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Docplanner Integrations Insurances API

7 actions 7 updates phrasing extends openapi/znanylekarz-insurances-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['/insurance-providers'].get
$.paths['/insurance-providers/{insurance_provider_id}/plans'].get
$.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/insurance-providers'].get
$.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/insurance-providers'].put
$.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/insurance-providers'].post
$.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/insurance-providers/{insurance_provider_id}'].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 Insurances API
  version: 1.0.0
extends: openapi/znanylekarz-insurances-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['/insurance-providers'].get
  update:
    x-apievangelist-phrasing:
      intent: List available insurance providers
      effect: read
      questions:
      - Which insurance companies are in the ZnanyLekarz dictionary?
      - What insurance provider IDs can I attach to an address?
      instructions:
      - text: List all available insurance providers.
      - text: Show the full dictionary of insurers I can choose from.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/insurance-providers/{insurance_provider_id}/plans'].get
  update:
    x-apievangelist-phrasing:
      intent: List an insurer's plans
      effect: read
      questions:
      - What plans does a given insurance provider offer?
      - How do I find the plan IDs for one insurer?
      instructions:
      - text: List the plans for insurance provider {insurance_provider}.
        slots:
          insurance_provider: path.insurance_provider_id
      - text: Show available insurance plans under insurer {insurance_provider}.
        slots:
          insurance_provider: path.insurance_provider_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/insurance-providers'].get
  update:
    x-apievangelist-phrasing:
      intent: List insurers accepted at an address
      effect: read
      questions:
      - Which insurance providers does a doctor accept at a specific address?
      - Is this insurer already set up on the address?
      instructions:
      - text: List insurance providers accepted at address {address} of doctor {doctor} in facility {facility}.
        slots:
          facility: path.facility_id
          doctor: path.doctor_id
          address: path.address_id
      - text: Show which insurers address {address} takes.
        slots:
          address: path.address_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/insurance-providers'].put
  update:
    x-apievangelist-phrasing:
      intent: Set an insurer's plans on an address
      effect: write
      questions:
      - How do I update the accepted plans for an insurer that may or may not already be on an address?
      - Can I upsert an insurance provider on a doctor's address in one call?
      instructions:
      - text: Update or create insurer {insurance_provider_id} on address {address} of doctor {doctor} in facility {facility}.
        slots:
          facility: path.facility_id
          doctor: path.doctor_id
          address: path.address_id
          insurance_provider_id: requestBody.insurance_provider_id
      - text: Replace the accepted plans for insurer {insurance_provider_id} on address {address} with {insurance_plans}.
        slots:
          insurance_provider_id: requestBody.insurance_provider_id
          address: path.address_id
          insurance_plans: requestBody.insurance_plans
      method: generated
      generated: '2026-10-01'
- target: $.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/insurance-providers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a new insurer to an address
      effect: write
      questions:
      - How do I start accepting a new insurance company at a doctor's address?
      - Can I attach specific plans when adding an insurer to an address for the first time?
      instructions:
      - text: Add insurer {insurance_provider_id} as a new provider on address {address} of doctor {doctor} in facility {facility}.
        slots:
          facility: path.facility_id
          doctor: path.doctor_id
          address: path.address_id
          insurance_provider_id: requestBody.insurance_provider_id
      - text: Add new insurer {insurance_provider_id} to address {address} with plans {insurance_plans}.
        slots:
          insurance_provider_id: requestBody.insurance_provider_id
          address: path.address_id
          insurance_plans: requestBody.insurance_plans
      method: generated
      generated: '2026-10-01'
- target: $.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/insurance-providers/{insurance_provider_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an insurer from an address
      effect: destructive
      questions:
      - How do I stop accepting an insurance provider at a doctor's address?
      - Can I drop one insurer from an address without affecting the others?
      instructions:
      - text: Remove insurer {insurance_provider} from address {address} of doctor {doctor} in facility {facility}.
        slots:
          facility: path.facility_id
          doctor: path.doctor_id
          address: path.address_id
          insurance_provider: path.insurance_provider_id
      - text: Delete insurance provider {insurance_provider} from address {address}.
        slots:
          insurance_provider: path.insurance_provider_id
          address: path.address_id
      method: generated
      generated: '2026-10-01'