drchrono · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Drchrono Administrative API

9 actions 9 updates phrasing extends openapi/drchrono-administrative-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for drchrono's API. It is a proposal applied on top of the contract, not a document drchrono publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 9

$.info

$.paths['/api/user_groups'].get

$.paths['/api/doctor_options'].get

$.paths['/api/doctors/{id}'].get

$.paths['/api/users/{id}'].get

$.paths['/api/users'].get

$.paths['/api/doctor_options/{id}'].get

$.paths['/api/doctors'].get

$.paths['/api/user_groups/{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 Drchrono Administrative API
  version: 1.0.0
extends: openapi/drchrono-administrative-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 8
- target: $.paths['/api/user_groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List user groups
      effect: read
      questions:
      - What user groups exist in the practice?
      - Can I list the user groups for one doctor?
      instructions:
      - text: List all user groups.
      - text: Show user groups for doctor {doctor}.
        slots:
          doctor: query.doctor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/doctor_options'].get
  update:
    x-apievangelist-phrasing:
      intent: List doctor options in the practice group
      effect: read
      questions:
      - What settings or options are configured for doctors in the practice group?
      - Can I list options for a single doctor?
      instructions:
      - text: List doctor options across the practice group.
      - text: Show options configured for doctor {doctor}.
        slots:
          doctor: query.doctor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/doctors/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a doctor
      effect: read
      questions:
      - How do I get the profile of one doctor by ID?
      - What specialty and contact details are stored for a doctor?
      instructions:
      - text: Get doctor {id}.
        slots:
          id: path.id
      - text: Show the profile of doctor {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/users/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a user
      effect: read
      questions:
      - How do I find out which user is currently logged in?
      - What details come back for a specific user?
      instructions:
      - text: Get user {id}.
        slots:
          id: path.id
      - text: Look up the currently logged-in user with id {id} set to current.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List practice users
      effect: read
      questions:
      - Who are the users in my drchrono practice?
      - Can I list users associated with one doctor?
      instructions:
      - text: List all practice users.
      - text: Show users for doctor {doctor}.
        slots:
          doctor: query.doctor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/doctor_options/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a doctor's options
      effect: read
      questions:
      - How do I read one doctor options record by ID?
      - Which preferences are set in a specific doctor options record?
      instructions:
      - text: Get doctor options record {id}.
        slots:
          id: path.id
      - text: Show preferences in doctor options {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/doctors'].get
  update:
    x-apievangelist-phrasing:
      intent: List doctors in the practice group
      effect: read
      questions:
      - Which doctors are in my practice group?
      - Can I look up a doctor within the practice group by ID filter?
      instructions:
      - text: List all doctors in the practice group.
      - text: Show the doctor record for doctor {doctor}.
        slots:
          doctor: query.doctor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/user_groups/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a user group
      effect: read
      questions:
      - How do I see who belongs to a particular user group?
      - What does one user group record contain?
      instructions:
      - text: Get user group {id}.
        slots:
          id: path.id
      - text: Show the members of user group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'