mhome-core-api 2.0.0

Shared wire types and service contracts for the mHome core
Documentation 
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://mhome.dev/contracts/node-service-protocol-v1.json",
  "title": "Node Service Protocol V1",
  "$defs": {
    "emptyRequest": {
      "type": "object",
      "properties": {},
      "additionalProperties": false
    },
    "describe": {
      "type": "object",
      "required": [
        "schemaVersion",
        "nodeType",
        "serviceId",
        "serviceVersion",
        "instancePolicy",
        "routes",
        "capabilities",
        "details"
      ],
      "properties": {
        "schemaVersion": { "const": "mhome.node.describe.v1" },
        "nodeType": { "type": "string", "minLength": 1 },
        "serviceId": { "type": "string", "minLength": 1 },
        "serviceVersion": { "type": "string", "minLength": 1 },
        "instancePolicy": {
          "enum": ["multiple", "singleton", "shared"]
        },
        "routes": {
          "type": "array",
          "items": { "type": "string", "pattern": "^/" },
          "uniqueItems": true
        },
        "capabilities": {
          "type": "array",
          "items": { "type": "string", "minLength": 1 },
          "uniqueItems": true
        },
        "details": { "type": "object" }
      },
      "additionalProperties": true
    },
    "readinessReason": {
      "type": "object",
      "required": ["code", "message", "retryable"],
      "properties": {
        "code": { "type": "string", "minLength": 1 },
        "message": { "type": "string", "minLength": 1 },
        "retryable": { "type": "boolean" }
      },
      "additionalProperties": true
    },
    "readiness": {
      "type": "object",
      "required": [
        "schemaVersion",
        "nodeType",
        "serviceId",
        "serviceVersion",
        "processGeneration",
        "state",
        "ready",
        "revision",
        "updatedAtMs",
        "reason",
        "details"
      ],
      "properties": {
        "schemaVersion": { "const": "mhome.node.readiness.v1" },
        "nodeType": { "type": "string", "minLength": 1 },
        "serviceId": { "type": "string", "minLength": 1 },
        "serviceVersion": { "type": "string", "minLength": 1 },
        "processGeneration": { "type": "string", "minLength": 1 },
        "state": {
          "enum": [
            "starting",
            "ready",
            "degraded",
            "failed",
            "stopping",
            "stopped"
          ]
        },
        "ready": { "type": "boolean" },
        "revision": { "type": "integer", "minimum": 0 },
        "updatedAtMs": { "type": "integer" },
        "reason": {
          "oneOf": [
            { "type": "null" },
            { "$ref": "#/$defs/readinessReason" }
          ]
        },
        "details": { "type": "object" }
      },
      "additionalProperties": true
    }
  },
  "type": "object",
  "required": ["describeRequest", "readinessRequest", "describe", "readiness"],
  "properties": {
    "describeRequest": { "$ref": "#/$defs/emptyRequest" },
    "readinessRequest": { "$ref": "#/$defs/emptyRequest" },
    "describe": { "$ref": "#/$defs/describe" },
    "readiness": { "$ref": "#/$defs/readiness" }
  },
  "additionalProperties": false
}