From 1eeb3bd77868ab5c1bfd33513c56e4d904e5a3bd Mon Sep 17 00:00:00 2001
From: "Joshua M. Boniface" <joshua@boniface.me>
Date: Wed, 10 Jan 2024 16:26:00 -0500
Subject: [PATCH] Add Zookeeper metric endpoint and update descrs

---
 docs/manuals/swagger.json | 25 +++++++++++++++++++++----
 1 file changed, 21 insertions(+), 4 deletions(-)

diff --git a/docs/manuals/swagger.json b/docs/manuals/swagger.json
index 30d1e66..ca99700 100644
--- a/docs/manuals/swagger.json
+++ b/docs/manuals/swagger.json
@@ -1992,7 +1992,7 @@
         },
         "/api/v1/metrics": {
             "get": {
-                "description": "the Ceph cluster metrics as one document.<br/><br/>Endpoint is unauthenticated to allow metrics exfiltration without having to deal<br/>with the Prometheus compatibility later.",
+                "description": "the Ceph cluster metrics as one document.<br/><br/>Endpoint is UNAUTHENTICATED to allow metrics exfiltration without having to deal<br/>with Prometheus compatibility (only basic auth support). Ensure this API endpoint<br/>is only opened to trusted networks that cannot abuse the data provided!",
                 "responses": {
                     "200": {
                         "description": "OK"
@@ -2009,7 +2009,7 @@
         },
         "/api/v1/metrics/ceph": {
             "get": {
-                "description": "<br/>Proxies a metrics request to the current active MGR, since this is dynamic<br/>and can't be controlled by PVC easily.",
+                "description": "<br/>Proxies a metrics request to the current active MGR, since this is dynamic<br/>and can't be controlled by PVC easily.<br/><br/>Endpoint is UNAUTHENTICATED to allow metrics exfiltration without having to deal<br/>with Prometheus compatibility (only basic auth support). Ensure this API endpoint<br/>is only opened to trusted networks that cannot abuse the data provided!",
                 "responses": {
                     "200": {
                         "description": "OK"
@@ -2026,7 +2026,7 @@
         },
         "/api/v1/metrics/health": {
             "get": {
-                "description": "<br/>Endpoint is unauthenticated to allow metrics exfiltration without having to deal<br/>with the Prometheus compatibility later.",
+                "description": "<br/>Endpoint is UNAUTHENTICATED to allow metrics exfiltration without having to deal<br/>with Prometheus compatibility (only basic auth support). Ensure this API endpoint<br/>is only opened to trusted networks that cannot abuse the data provided!",
                 "responses": {
                     "200": {
                         "description": "OK"
@@ -2043,7 +2043,7 @@
         },
         "/api/v1/metrics/resource": {
             "get": {
-                "description": "<br/>Endpoint is unauthenticated to allow metrics exfiltration without having to deal<br/>with the Prometheus compatibility later.",
+                "description": "<br/>Endpoint is UNAUTHENTICATED to allow metrics exfiltration without having to deal<br/>with Prometheus compatibility (only basic auth support). Ensure this API endpoint<br/>is only opened to trusted networks that cannot abuse the data provided!",
                 "responses": {
                     "200": {
                         "description": "OK"
@@ -2058,6 +2058,23 @@
                 ]
             }
         },
+        "/api/v1/metrics/zookeeper": {
+            "get": {
+                "description": "<br/>Proxies a metrics request to the current primary node, since all coordinators<br/>run an active Zookeeper instance and we want one central location.<br/><br/>Endpoint is UNAUTHENTICATED to allow metrics exfiltration without having to deal<br/>with Prometheus compatibility (only basic auth support). Ensure this API endpoint<br/>is only opened to trusted networks that cannot abuse the data provided!",
+                "responses": {
+                    "200": {
+                        "description": "OK"
+                    },
+                    "400": {
+                        "description": "Bad request"
+                    }
+                },
+                "summary": "Return the current PVC Zookeeper Prometheus metrics",
+                "tags": [
+                    "root"
+                ]
+            }
+        },
         "/api/v1/network": {
             "get": {
                 "description": "",