add mirrored_hosts_status into OpenAPI of api/info (#9867)
add mirrored_hosts_status into OpenAPI of api/info
Timotej S committed
Sep 17, 2020 at 08:25 UTC
47e71bd771fef2365f30bd850fa3ca272cf77510
2 files changed
+56
web/api/netdata-swagger.json
+29
@@ -1091,6 +1091,35 @@
1091
"host2.example.com"
1092
]
1093
},
1094
+ "mirrored_hosts_status": {
1095
+ "type": "array",
1096
+ "description": "List of details of hosts mirrored to this served (including self). Indexes correspond to indexes in \"mirrored_hosts\".",
1097
+ "items": {
1098
+ "type": "object",
1099
+ "description": "Host data",
1100
+ "properties": {
1101
+ "guid": {
1102
+ "type": "string",
1103
+ "format": "uuid",
1104
+ "nullable": false,
1105
+ "description": "Host unique GUID from `netdata.public.unique.id`.",
1106
+ "example": "245e4bff-3b34-47c1-a6e5-5c535a9abfb2"
1107
+ },
1108
+ "reachable": {
1109
+ "type": "boolean",
1110
+ "nullable": false,
1111
+ "description": "Current state of streaming. Always true for localhost/self."
1112
+ },
1113
+ "claim_id": {
1114
+ "type": "string",
1115
+ "format": "uuid",
1116
+ "nullable": true,
1117
+ "description": "Cloud GUID/identifier in case the host is claimed. If child status unknown or unclaimed this field is set to `null`",
1118
+ "example": "c3b2a66a-3052-498c-ac52-7fe9e8cccb0c"
1119
+ }
1120
+ }
1121
+ }
1122
+ },
1123
"os_name": {
1124
"type": "string",
1125
"description": "Operating System Name.",
web/api/netdata-swagger.yaml
+27
@@ -881,6 +881,33 @@ components:
881
example:
882
- host1.example.com
883
- host2.example.com
884
+ mirrored_hosts_status:
885
+ type: array
886
+ description: >-
887
+ List of details of hosts mirrored to this served (including self).
888
+ Indexes correspond to indexes in "mirrored_hosts".
889
+ items:
890
+ type: object
891
+ description: Host data
892
+ properties:
893
+ guid:
894
+ type: string
895
+ format: uuid
896
+ nullable: false
897
+ description: Host unique GUID from `netdata.public.unique.id`.
898
+ example: 245e4bff-3b34-47c1-a6e5-5c535a9abfb2
899
+ reachable:
900
+ type: boolean
901
+ nullable: false
902
+ description: Current state of streaming. Always true for localhost/self.
903
+ claim_id:
904
+ type: string
905
+ format: uuid
906
+ nullable: true
907
+ description: >-
908
+ Cloud GUID/identifier in case the host is claimed.
909
+ If child status unknown or unclaimed this field is set to `null`
910
+ example: c3b2a66a-3052-498c-ac52-7fe9e8cccb0c
911
os_name:
912
type: string
913
description: Operating System Name.