@twin.org/telemetry-service 0.0.3-next.1 → 0.0.3-next.10

package/docs/open-api/spec.json

@@ -56,15 +56,8 @@
 					}
 				},
 				"responses": {
-					"200": {
+					"201": {
 						"description": "The rest request ended in created response.",
-						"content": {
-							"text/plain": {
-								"schema": {
-									"$ref": "#/components/schemas/CreatedResponse"
-								}
-							}
-						},
 						"headers": {
 							"location": {
 								"schema": {
@@ -73,6 +66,63 @@
 								"description": "e.g. my-counter"
 							}
 						}
+					},
+					"400": {
+						"description": "The server cannot process the request, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "GeneralError",
+											"message": "errorMessage",
+											"properties": {
+												"foo": "bar"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "UnauthorizedError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					},
+					"500": {
+						"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "InternalServerError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
 					}
 				}
 			},
@@ -89,8 +139,9 @@
 						"in": "query",
 						"required": false,
 						"schema": {
-							"$ref": "#/components/schemas/MetricType"
-						}
+							"type": "string"
+						},
+						"example": "0"
 					},
 					{
 						"name": "cursor",
@@ -147,6 +198,63 @@
 								}
 							}
 						}
+					},
+					"400": {
+						"description": "The server cannot process the request, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "GeneralError",
+											"message": "errorMessage",
+											"properties": {
+												"foo": "bar"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "UnauthorizedError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					},
+					"500": {
+						"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "InternalServerError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
 					}
 				}
 			}
@@ -204,6 +312,63 @@
 								}
 							}
 						}
+					},
+					"400": {
+						"description": "The server cannot process the request, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "GeneralError",
+											"message": "errorMessage",
+											"properties": {
+												"foo": "bar"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "UnauthorizedError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					},
+					"500": {
+						"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "InternalServerError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
 					}
 				}
 			},
@@ -250,12 +415,62 @@
 					}
 				},
 				"responses": {
-					"200": {
-						"description": "The rest request ended in success with no data.",
+					"204": {
+						"description": "The rest request ended in success with no data."
+					},
+					"400": {
+						"description": "The server cannot process the request, see the content for more details.",
 						"content": {
-							"text/plain": {
+							"application/json": {
 								"schema": {
-									"$ref": "#/components/schemas/NoContentResponse"
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "GeneralError",
+											"message": "errorMessage",
+											"properties": {
+												"foo": "bar"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "UnauthorizedError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					},
+					"500": {
+						"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "InternalServerError",
+											"message": "errorMessage"
+										}
+									}
 								}
 							}
 						}
@@ -287,12 +502,62 @@
 					}
 				],
 				"responses": {
-					"200": {
-						"description": "The rest request ended in success with no data.",
+					"204": {
+						"description": "The rest request ended in success with no data."
+					},
+					"400": {
+						"description": "The server cannot process the request, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "GeneralError",
+											"message": "errorMessage",
+											"properties": {
+												"foo": "bar"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "UnauthorizedError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					},
+					"500": {
+						"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
 						"content": {
-							"text/plain": {
+							"application/json": {
 								"schema": {
-									"$ref": "#/components/schemas/NoContentResponse"
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "InternalServerError",
+											"message": "errorMessage"
+										}
+									}
 								}
 							}
 						}
@@ -349,15 +614,8 @@
 					}
 				},
 				"responses": {
-					"200": {
+					"201": {
 						"description": "The rest request ended in created response.",
-						"content": {
-							"text/plain": {
-								"schema": {
-									"$ref": "#/components/schemas/CreatedResponse"
-								}
-							}
-						},
 						"headers": {
 							"location": {
 								"schema": {
@@ -366,6 +624,63 @@
 								"description": "e.g. aabbccdd11223445566"
 							}
 						}
+					},
+					"400": {
+						"description": "The server cannot process the request, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "GeneralError",
+											"message": "errorMessage",
+											"properties": {
+												"foo": "bar"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "UnauthorizedError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					},
+					"500": {
+						"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "InternalServerError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
 					}
 				}
 			},
@@ -393,10 +708,7 @@
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": [
-								"number",
-								"string"
-							]
+							"type": "string"
 						}
 					},
 					{
@@ -405,10 +717,7 @@
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": [
-								"number",
-								"string"
-							]
+							"type": "string"
 						}
 					},
 					{
@@ -470,6 +779,63 @@
 								}
 							}
 						}
+					},
+					"400": {
+						"description": "The server cannot process the request, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "GeneralError",
+											"message": "errorMessage",
+											"properties": {
+												"foo": "bar"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "UnauthorizedError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					},
+					"500": {
+						"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "InternalServerError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
 					}
 				}
 			}
@@ -477,25 +843,69 @@
 	},
 	"components": {
 		"schemas": {
+			"Error": {
+				"description": "Model to describe serialized error.",
+				"type": "object",
+				"properties": {
+					"name": {
+						"type": "string",
+						"description": "The name for the error."
+					},
+					"message": {
+						"type": "string",
+						"description": "The message for the error as an i18n key."
+					},
+					"source": {
+						"type": "string",
+						"description": "The source of the error."
+					},
+					"properties": {
+						"type": "object",
+						"additionalProperties": {},
+						"description": "Any additional information for the error."
+					},
+					"stack": {
+						"type": "string",
+						"description": "The stack trace for the error."
+					},
+					"cause": {
+						"$ref": "#/components/schemas/Error"
+					}
+				},
+				"required": [
+					"name",
+					"message"
+				]
+			},
+			"MetricCounterOperation": {
+				"description": "The types of metric counter operations.",
+				"anyOf": [
+					{
+						"const": "inc",
+						"description": "Increment Counter."
+					},
+					{
+						"const": "dec",
+						"description": "Decrement Counter."
+					}
+				]
+			},
 			"MetricType": {
+				"description": "The types of metrics.",
 				"anyOf": [
 					{
-						"type": "number",
 						"const": 0,
 						"description": "Counter."
 					},
 					{
-						"type": "number",
 						"const": 1,
 						"description": "Increment Decrement Counter."
 					},
 					{
-						"type": "number",
 						"const": 2,
 						"description": "Gauge."
 					}
-				],
-				"description": "The types of metrics."
+				]
 			},
 			"TelemetryAddMetricValueRequest": {
 				"type": "object",
@@ -503,12 +913,7 @@
 					"value": {
 						"anyOf": [
 							{
-								"type": "string",
-								"const": "inc"
-							},
-							{
-								"type": "string",
-								"const": "dec"
+								"$ref": "#/components/schemas/MetricCounterOperation"
 							},
 							{
 								"type": "number"
@@ -525,7 +930,6 @@
 				"required": [
 					"value"
 				],
-				"additionalProperties": false,
 				"description": "The data to be used in the update."
 			},
 			"TelemetryGetMetricResponse": {
@@ -542,7 +946,6 @@
 					"metric",
 					"value"
 				],
-				"additionalProperties": false,
 				"description": "The body parameters."
 			},
 			"TelemetryListResponse": {
@@ -563,10 +966,10 @@
 				"required": [
 					"entities"
 				],
-				"additionalProperties": false,
 				"description": "The response payload."
 			},
 			"TelemetryMetric": {
+				"description": "Interface describing a telemetry metric.",
 				"type": "object",
 				"properties": {
 					"id": {
@@ -587,17 +990,20 @@
 					"unit": {
 						"type": "string",
 						"description": "The unit the metric describes."
+					},
+					"maxHistory": {
+						"type": "number",
+						"description": "The maximum number of values to retain; oldest are trimmed on each addMetricValue call.\nUnlimited when absent."
 					}
 				},
 				"required": [
 					"id",
 					"label",
 					"type"
-				],
-				"additionalProperties": false,
-				"description": "Interface describing a telemetry metric."
+				]
 			},
 			"TelemetryMetricValue": {
+				"description": "Interface describing a telemetry metric value.",
 				"type": "object",
 				"properties": {
 					"id": {
@@ -622,9 +1028,7 @@
 					"id",
 					"ts",
 					"value"
-				],
-				"additionalProperties": false,
-				"description": "Interface describing a telemetry metric value."
+				]
 			},
 			"TelemetryUpdateMetricRequest": {
 				"type": "object",
@@ -645,7 +1049,6 @@
 				"required": [
 					"label"
 				],
-				"additionalProperties": false,
 				"description": "The data to be used in the update."
 			},
 			"TelemetryValuesListResponse": {
@@ -670,7 +1073,6 @@
 					"metric",
 					"entities"
 				],
-				"additionalProperties": false,
 				"description": "The response payload."
 			}
 		},