Schema for Heimdall Session Metadata

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

title: Session Metadata
description: >-
  `Session.Metadata` are used to store session related metadata from provider/application.

type: object
additionalProperties: true
properties:
  sgid:
    $ref: "#/definitions/sgid"

definitions:
  sgid:
    title: Sgid
    description: Metadata for 'SgidProvider'

    type: object
    additionalProperties: true
    required: []
    properties:
      state:
        title: State
        description: State which will be passed back once the end-user logs in.
        type: string
        minLength: 1

      nonce:
        title: Nonce
        description: Unique nonce for this session.
        type: string
        minLength: 1

      code_verifier:
        title: Code Verifier
        description: The code verifier corresponding to the code challenge that was passed to `authorization_url`.
        type: string
        minLength: 1

      access_token:
        title: Access Token
        description: Access token generated for sub. This will be used to access all sgid endpoint.
        type: string
        minLength: 1

      sub:
        title: Subject Identifier Claim
        description: The subject identifier claim is the end-user's unique ID.
        type: string
        minLength: 1

  chemocalc:
    title: Chemocalc
    description: Metadata for chemocalc

    type: object
    additionalProperties: true
    required: []
    properties:
      nric:
        title: NRIC
        type: string
        minLength: 1

  cleo:
    title: Cleo
    description: Metadata for cleo

    type: object
    additionalProperties: false
    properties:
      clinic:
        title: Clinic
        description: Clinic that this session belongs to.

        type: [string, "null"]
        minLength: 1

      profile_uid:
        title: Profile UID
        description: UID of patient/clinician who own the session.

        type: [string, "null"]
        minLength: 1