Schema for Heisenberg Provider Settings

From ProviderSettings.schema.yaml (heisenberg/ProviderSettings.schema)

---
$id: https://skeleton.botmd.io/heisenberg/ProviderSettings.schema
$schema: http://json-schema.org/draft-07/schema#

title: Provider Settings
description: >-
  These settings are used for configuring the HeisenbergProvider in Jarvis.

oneOf:
  - title: AHFS Provider
    description: Provider settings for `AHFSProvider`.
    type: object

    additionalProperties: true
    required: []
    allOf:
      - $ref: "/hospital/Permissions.schema"
      - properties:
          ahfs:
            $ref: "#/definitions/ahfs"
          mims:
            $ref: "#/definitions/mims"
    #end properties
#end oneOf

definitions:
  ahfs:
    title: AHFS
    description: Provider settings for `AHFSProvider`.

    type: object
    additionalProperties: false
    required: [url]
    properties:
      url:
        title: url
        description: The URI for AHFS provider data files. Examples are sftp://user:pass@hostname/path, s3://bucket/key/ .
        type: string
      #end url

      logo_url:
        title: Logo URL
        description: Logo URL to be used when generating carousel for provider.
        type: string
      #end image_url
    #end properties
  #end ahfs
  mims:
    title: MIMS
    description: Provider settings for `MIMSProvider`.

    type: object
    additionalProperties: false
    required: [url]
    properties:
      url:
        title: url
        description: The URI for MIMS provider data files. Examples are sftp://user:pass@hostname/path, s3://bucket/key/ .
        type: string
      #end url

      logo_url:
        title: Logo URL
        description: Logo URL to be used when generating carousel for provider.
        type: string
      #end image_url
    #end properties
  #end mims
#end definitions

[Main Page] [Schema Documentation] [Examples]