From 3b11a74597e22c27e78cc625307e4c975e13a9cb Mon Sep 17 00:00:00 2001 From: "Joshua M. Boniface" Date: Mon, 25 Dec 2023 03:05:26 -0500 Subject: [PATCH] Update Metrics endpoint details --- docs/manuals/swagger.json | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/docs/manuals/swagger.json b/docs/manuals/swagger.json index 57761f5..30d1e66 100644 --- a/docs/manuals/swagger.json +++ b/docs/manuals/swagger.json @@ -540,6 +540,10 @@ }, "type": "array" }, + "interfaces": { + "description": "Details on speed, bytes, and packets per second of each node physical network interface", + "type": "object" + }, "kernel": { "desription": "The running kernel version from uname", "type": "string" @@ -2020,7 +2024,7 @@ ] } }, - "/api/v1/metrics/pvc": { + "/api/v1/metrics/health": { "get": { "description": "
Endpoint is unauthenticated to allow metrics exfiltration without having to deal
with the Prometheus compatibility later.", "responses": { @@ -2031,7 +2035,24 @@ "description": "Bad request" } }, - "summary": "Return the current PVC cluster status in Prometheus-compatible metrics format", + "summary": "Return the current PVC cluster health status in Prometheus-compatible metrics format", + "tags": [ + "root" + ] + } + }, + "/api/v1/metrics/resource": { + "get": { + "description": "
Endpoint is unauthenticated to allow metrics exfiltration without having to deal
with the Prometheus compatibility later.", + "responses": { + "200": { + "description": "OK" + }, + "400": { + "description": "Bad request" + } + }, + "summary": "Return the current PVC cluster resource utilizations in Prometheus-compatible metrics format", "tags": [ "root" ]