Schemas

• /component/v1/component.json

  Code

  1
  2
  3
  4
  5
  6
  7
  8
  9
  10
  11
  12
  13
  14
  15
  16
  17
  18
  19
  20
  21
  22
  23
  24
  25
  26
  27
  28
  29
  30
  31
  32
  33
  34
  35
  36
  37
  38
  39
  40
  41
  42
  43
  44
  45
  46
  47
  48
  49
  50
  51
  52
  53
  54
  55
  56
  57
  58
  59
  60
  61
  62
  {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "http://schema.doctorlogic.com/component/v1/component.json#",
      "definitions": {
          "name": {
              "description": "The name of the Component.",
              "pattern": "^[a-z0-9_-]+$",
              "type": "string"
          },
          "type": {
              "description": "The type of the Component.",
              "pattern": "^[a-z0-9_-]+$",
              "type": "string"
          }
      },
      "additionalProperties": false,
      "properties": {
          "dependencies": {
              "description": "A list of absolute or relative URLs required for this Component. Relative paths will be resolved from the manifest file path.",
              "additionalProperties": true,
              "properties": {
                  "scripts": {
                      "type": "array",
                      "items": {
                          "type": "string"
                      }
                  },
                  "styles": {
                      "type": "array",
                      "items": {
                          "type": "string"
                      }
                  }
              },
              "type": "object"
          },
          "description": {
              "description": "The description of the Component.",
              "type": "string"
          },
          "name": {
              "$ref": "#/definitions/name"
          },
          "template": {
              "description": "The optional template to be used by the Component.",
              "type": "string"
          },
          "type": {
              "$ref": "#/definitions/type"
          },
          "context": {
              "description": "The default rendering context for all instances of the Component.",
              "type": "object"
          }
      },
      "required": [
          "description",
          "name",
          "type"
      ],
      "type": "object"
  }

• /component/v1/tree.json

  Code

  1
  2
  3
  4
  5
  6
  7
  8
  9
  10
  11
  12
  13
  14
  15
  16
  17
  18
  19
  20
  21
  22
  23
  24
  25
  26
  27
  28
  29
  30
  31
  32
  33
  34
  35
  36
  37
  38
  39
  40
  41
  42
  43
  44
  45
  46
  47
  48
  49
  50
  51
  52
  53
  {
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "http://schema.doctorlogic.com/component/v1/tree.json#",
      "definitions": {},
      "additionalProperties": false,
      "properties": {
          "name": {
              "$ref": "component.json#/properties/name"
          },
          "type": {
              "$ref": "component.json#/properties/type"
          },
          "children": {
              "description": "A list of component trees.",
              "items": {
                  "$ref": "#"
              },
              "type": "array"
          },
          "context": {
              "type": "object",
              "description": "The rendering context for the Component."
          },
          "config": {
              "description": "The configuration to override the database configuration.",
              "type": "object"
          },
          "additionalDependencies": {
              "description": "A list of absolute or relative URLs required for this Component instance. Relative paths will be resolved from the manifest file path.",
              "additionalProperties": true,
              "properties": {
                  "scripts": {
                      "type": "array",
                      "items": {
                          "type": "string"
                      }
                  },
                  "styles": {
                      "type": "array",
                      "items": {
                          "type": "string"
                      }
                  }
              },
              "type": "object"
          }
      },
      "required": [
          "name",
          "type"
      ],
      "type": "object"
  }