Schema for Bach Session Status Metadata

From SessionStatusMetadata.schema.yaml (bach/SessionStatusMetadata.schema)

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

title: Session Status Metadata
description: >-
  `SessionStatus.metadata` contains additional metadata about the test status update.

type: object
additionalProperties:
  $ref: "#/definitions/serviceStatus"

definitions:
  serviceStatus:
    title: Container Status
    description: Provides information about the status of the container at the point the test status update was sent.

    type: object
    additionalProperties: false
    required: [started, died]
    properties:
      healthy:
        title: Healthy
        description: Specifies whether the container has started at the point the test status update was sent.

        type: boolean
      #end healthy

      started:
        title: Started
        description: Specifies whether the container has started at the point the test status update was sent.

        type: boolean
      #end started

      died:
        title: Died
        description: Specifies whether the container has died at the point the test status update was sent.

        type: boolean
      #end died

      exitCode:
        title: Exit Code
        description: Specifies the exit code of the container if it has already died.

        type: number
      #end exitCode
    #end properties
  #end serviceStatus
#end definitions

[Main Page] [Schema Documentation] [Examples]