diff options
| author | Timotej S <6674623+underhood@users.noreply.github.com> | 2020-09-17 08:25:37 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-09-17 08:25:37 +0200 |
| commit | 47e71bd771fef2365f30bd850fa3ca272cf77510 (patch) | |
| tree | 26b7b64d7478c6b266c13c4b1f9bf551ecb8469f /web | |
| parent | 512416f55944cfd35c4700f2f080dc46ccb9822a (diff) | |
add mirrored_hosts_status into OpenAPI of api/info (#9867)
add mirrored_hosts_status into OpenAPI of api/info
Diffstat (limited to 'web')
| -rw-r--r-- | web/api/netdata-swagger.json | 29 | ||||
| -rw-r--r-- | web/api/netdata-swagger.yaml | 27 |
2 files changed, 56 insertions, 0 deletions
diff --git a/web/api/netdata-swagger.json b/web/api/netdata-swagger.json index 1903593f38..c6a24e1af7 100644 --- a/web/api/netdata-swagger.json +++ b/web/api/netdata-swagger.json @@ -1091,6 +1091,35 @@ "host2.example.com" ] }, + "mirrored_hosts_status": { + "type": "array", + "description": "List of details of hosts mirrored to this served (including self). Indexes correspond to indexes in \"mirrored_hosts\".", + "items": { + "type": "object", + "description": "Host data", + "properties": { + "guid": { + "type": "string", + "format": "uuid", + "nullable": false, + "description": "Host unique GUID from `netdata.public.unique.id`.", + "example": "245e4bff-3b34-47c1-a6e5-5c535a9abfb2" + }, + "reachable": { + "type": "boolean", + "nullable": false, + "description": "Current state of streaming. Always true for localhost/self." + }, + "claim_id": { + "type": "string", + "format": "uuid", + "nullable": true, + "description": "Cloud GUID/identifier in case the host is claimed. If child status unknown or unclaimed this field is set to `null`", + "example": "c3b2a66a-3052-498c-ac52-7fe9e8cccb0c" + } + } + } + }, "os_name": { "type": "string", "description": "Operating System Name.", diff --git a/web/api/netdata-swagger.yaml b/web/api/netdata-swagger.yaml index 9a08793d0b..b52de2c9dc 100644 --- a/web/api/netdata-swagger.yaml +++ b/web/api/netdata-swagger.yaml @@ -881,6 +881,33 @@ components: example: - host1.example.com - host2.example.com + mirrored_hosts_status: + type: array + description: >- + List of details of hosts mirrored to this served (including self). + Indexes correspond to indexes in "mirrored_hosts". + items: + type: object + description: Host data + properties: + guid: + type: string + format: uuid + nullable: false + description: Host unique GUID from `netdata.public.unique.id`. + example: 245e4bff-3b34-47c1-a6e5-5c535a9abfb2 + reachable: + type: boolean + nullable: false + description: Current state of streaming. Always true for localhost/self. + claim_id: + type: string + format: uuid + nullable: true + description: >- + Cloud GUID/identifier in case the host is claimed. + If child status unknown or unclaimed this field is set to `null` + example: c3b2a66a-3052-498c-ac52-7fe9e8cccb0c os_name: type: string description: Operating System Name. |