docs. swagger

Author: yjeong-hz

BackEnd/src/main/java/com/mcmp/costbe/common/CommonController.java

@@ -3,6 +3,7 @@
 import com.mcmp.costbe.common.config.ReadyzConfig;
 import com.mcmp.costbe.common.model.ReadyzModel;
 import com.mcmp.costbe.common.model.ResultModel;
+import io.swagger.v3.oas.annotations.Hidden;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.media.Content;
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
@@ -42,8 +43,9 @@ public ResponseEntity getReadyz(){
     }
 
     @PostMapping(path = "/change/readyz")
-//    @Tag(name = "Application", description = "Status API")
-//    @Operation(summary = "어플리케이션 상태 변경", description = "어플리케이션의 상태를 변경합니다.")
+    @Tag(name = "Application", description = "Status API")
+    @Operation(summary = "어플리케이션 상태 변경", description = "어플리케이션의 상태를 변경합니다.")
+    @Hidden
 //    @ApiResponses(value={
 //            @ApiResponse(responseCode = "200", description = "성공"),
 //            @ApiResponse(responseCode = "500", description = "서버 오류", content = {@Content(examples = {})})

swagger.yaml

@@ -57,9 +57,6 @@
           "required": true
         },
         "responses": {
-          "500": {
-            "description": "서버 오류"
-          },
           "200": {
             "description": "성공",
             "content": {
@@ -69,6 +66,9 @@
                 }
               }
             }
+          },
+          "500": {
+            "description": "서버 오류"
           }
         }
       }
@@ -127,9 +127,6 @@
           "required": true
         },
         "responses": {
-          "500": {
-            "description": "서버 오류"
-          },
           "200": {
             "description": "성공",
             "content": {
@@ -139,6 +136,9 @@
                 }
               }
             }
+          },
+          "500": {
+            "description": "서버 오류"
           }
         }
       }
@@ -197,9 +197,6 @@
           "required": true
         },
         "responses": {
-          "500": {
-            "description": "서버 오류"
-          },
           "200": {
             "description": "성공",
             "content": {
@@ -209,6 +206,9 @@
                 }
               }
             }
+          },
+          "500": {
+            "description": "서버 오류"
           }
         }
       }
@@ -232,6 +232,9 @@
           "required": true
         },
         "responses": {
+          "500": {
+            "description": "서버 오류"
+          },
           "200": {
             "description": "성공",
             "content": {
@@ -244,9 +247,6 @@
                 }
               }
             }
-          },
-          "500": {
-            "description": "서버 오류"
           }
         }
       }
@@ -340,9 +340,6 @@
           "required": true
         },
         "responses": {
-          "500": {
-            "description": "서버 오류"
-          },
           "200": {
             "description": "성공",
             "content": {
@@ -352,36 +349,9 @@
                 }
               }
             }
-          }
-        }
-      }
-    },
-    "/api/costopti/be/change/readyz": {
-      "post": {
-        "tags": [
-          "common-controller"
-        ],
-        "operationId": "changeReadyz",
-        "requestBody": {
-          "content": {
-            "application/json;charset=UTF-8": {
-              "schema": {
-                "$ref": "#/components/schemas/ReadyzModel"
-              }
-            }
           },
-          "required": true
-        },
-        "responses": {
-          "200": {
-            "description": "OK",
-            "content": {
-              "application/json;charset=UTF-8": {
-                "schema": {
-                  "type": "string"
-                }
-              }
-            }
+          "500": {
+            "description": "서버 오류"
           }
         }
       }
@@ -405,9 +375,6 @@
           "required": true
         },
         "responses": {
-          "500": {
-            "description": "서버 오류"
-          },
           "200": {
             "description": "성공",
             "content": {
@@ -417,6 +384,9 @@
                 }
               }
             }
+          },
+          "500": {
+            "description": "서버 오류"
           }
         }
       }
@@ -1726,14 +1696,6 @@
         },
         "description": "이번달 리소스 사용량 및 비용 조회 응답 모델"
       },
-      "ReadyzModel": {
-        "type": "object",
-        "properties": {
-          "status": {
-            "type": "string"
-          }
-        }
-      },
       "AlarmHistoryReqModel": {
         "required": [
           "selectedCsps",