schema_registry: Tidy up swagger for config

Signed-off-by: Ben Pope <ben@redpanda.com>
BenPope · Apr 16, 2024 · 23c12f5 · 23c12f5
1 parent c64c4eb
commit 23c12f5
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 42 deletions.
diff --git a/src/v/pandaproxy/api/api-doc/schema_registry.json b/src/v/pandaproxy/api/api-doc/schema_registry.json
@@ -13,19 +13,20 @@
             "in": "path",
             "required": true,
             "type": "string"
+          },
+          {
+            "name": "defaultToGlobal",
+            "in": "query",
+            "required": false,
+            "type": "boolean"
           }
         ],
         "produces": ["application/vnd.schemaregistry.v1+json"],
         "responses": {
           "200": {
             "description": "OK",
             "schema": {
-              "type": "object",
-              "properties": {
-                "compatibilityLevel": {
-                  "type": "string"
-                }
-              }
+              "$ref": "#/definitions/get_compatibility"
             }
           },
           "500": {
@@ -55,12 +56,7 @@
             "name": "config",
             "in": "body",
             "schema": {
-              "type": "object",
-              "properties": {
-                "compatibility": {
-                  "type": "string"
-                }
-              }
+              "$ref": "#/definitions/put_compatibility"
             }
           }
         ],
@@ -69,12 +65,7 @@
           "200": {
             "description": "OK",
             "schema": {
-              "type": "object",
-              "properties": {
-                "compatibility": {
-                  "type": "string"
-                }
-              }
+              "$ref": "#/definitions/put_compatibility"
             }
           },
           "500": {
@@ -106,12 +97,7 @@
           "200": {
             "description": "OK",
             "schema": {
-              "type": "object",
-              "properties": {
-                "compatibility": {
-                  "type": "string"
-                }
-              }
+              "$ref": "#/definitions/put_compatibility"
             }
           },
           "404": {
@@ -144,12 +130,7 @@
           "200": {
             "description": "OK",
             "schema": {
-              "type": "object",
-              "properties": {
-                "compatibilityLevel": {
-                  "type": "string"
-                }
-              }
+              "$ref": "#/definitions/get_compatibility"
             }
           },
           "500": {
@@ -173,12 +154,7 @@
             "name": "config",
             "in": "body",
             "schema": {
-              "type": "object",
-              "properties": {
-                "compatibility": {
-                  "type": "string"
-                }
-              }
+              "$ref": "#/definitions/put_compatibility"
             }
           }
         ],
@@ -187,12 +163,7 @@
           "200": {
             "description": "OK",
             "schema": {
-              "type": "object",
-              "properties": {
-                "compatibility": {
-                  "type": "string"
-                }
-              }
+              "$ref": "#/definitions/put_compatibility"
             }
           },
           "500": {

diff --git a/src/v/pandaproxy/api/api-doc/schema_registry_definitions.def.json b/src/v/pandaproxy/api/api-doc/schema_registry_definitions.def.json
@@ -74,4 +74,20 @@
           "type": "string"
         }
       }
+    },
+    "get_compatibility": {
+      "type": "object",
+      "properties": {
+          "compatibilityLevel": {
+            "type": "string"
+          }
+      }
+    },
+    "put_compatibility": {
+      "type": "object",
+      "properties": {
+          "compatibility": {
+            "type": "string"
+          }
+      }
     }