IP free and child network free should be DELETE methods. (#274)

metal-stack · Apr 20, 2022 · eee5304 · eee5304
1 parent 135d28a
commit eee5304
Show file tree

Hide file tree

Showing 3 changed files with 108 additions and 2 deletions.
diff --git a/cmd/metal-api/internal/service/ip-service.go b/cmd/metal-api/internal/service/ip-service.go
@@ -90,6 +90,18 @@ func (ir ipResource) webService() *restful.WebService {
 		DefaultReturns("Error", httperrors.HTTPErrorResponse{}))
 
 	ws.Route(ws.POST("/free/{id}").
+		To(editor(ir.freeIP)).
+		Operation("freeIPDeprecated").
+		Doc("frees an ip").
+		Param(ws.PathParameter("id", "identifier of the ip").DataType("string")).
+		Consumes(restful.MIME_JSON, "*/*").
+		Metadata(restfulspec.KeyOpenAPITags, tags).
+		Writes(v1.IPResponse{}).
+		Returns(http.StatusOK, "OK", v1.IPResponse{}).
+		DefaultReturns("Error", httperrors.HTTPErrorResponse{}).
+		Deprecate())
+
+	ws.Route(ws.DELETE("/free/{id}").
 		To(editor(ir.freeIP)).
 		Operation("freeIP").
 		Doc("frees an ip").

diff --git a/cmd/metal-api/internal/service/network-service.go b/cmd/metal-api/internal/service/network-service.go
@@ -127,6 +127,18 @@ func (r networkResource) webService() *restful.WebService {
 		DefaultReturns("Error", httperrors.HTTPErrorResponse{}))
 
 	ws.Route(ws.POST("/free/{id}").
+		To(editor(r.freeNetwork)).
+		Operation("freeNetworkDeprecated").
+		Doc("free a network").
+		Metadata(restfulspec.KeyOpenAPITags, tags).
+		Consumes(restful.MIME_JSON, "*/*").
+		Param(ws.PathParameter("id", "identifier of the network").DataType("string")).
+		Returns(http.StatusOK, "OK", v1.NetworkResponse{}).
+		Returns(http.StatusConflict, "Conflict", httperrors.HTTPErrorResponse{}).
+		DefaultReturns("Error", httperrors.HTTPErrorResponse{}).
+		Deprecate())
+
+	ws.Route(ws.DELETE("/free/{id}").
 		To(editor(r.freeNetwork)).
 		Operation("freeNetwork").
 		Doc("free a network").

diff --git a/spec/metal-api.json b/spec/metal-api.json
@@ -5579,7 +5579,7 @@
       }
     },
     "/v1/ip/free/{id}": {
-      "post": {
+      "delete": {
         "consumes": [
           "application/json"
         ],
@@ -5614,6 +5614,44 @@
         "tags": [
           "ip"
         ]
+      },
+      "post": {
+        "consumes": [
+          "*/*",
+          "application/json"
+        ],
+        "deprecated": true,
+        "operationId": "freeIPDeprecated",
+        "parameters": [
+          {
+            "description": "identifier of the ip",
+            "in": "path",
+            "name": "id",
+            "required": true,
+            "type": "string"
+          }
+        ],
+        "produces": [
+          "application/json"
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "schema": {
+              "$ref": "#/definitions/v1.IPResponse"
+            }
+          },
+          "default": {
+            "description": "Error",
+            "schema": {
+              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
+            }
+          }
+        },
+        "summary": "frees an ip",
+        "tags": [
+          "ip"
+        ]
       }
     },
     "/v1/ip/{id}": {
@@ -7078,7 +7116,7 @@
       }
     },
     "/v1/network/free/{id}": {
-      "post": {
+      "delete": {
         "consumes": [
           "application/json"
         ],
@@ -7119,6 +7157,50 @@
         "tags": [
           "network"
         ]
+      },
+      "post": {
+        "consumes": [
+          "*/*",
+          "application/json"
+        ],
+        "deprecated": true,
+        "operationId": "freeNetworkDeprecated",
+        "parameters": [
+          {
+            "description": "identifier of the network",
+            "in": "path",
+            "name": "id",
+            "required": true,
+            "type": "string"
+          }
+        ],
+        "produces": [
+          "application/json"
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "schema": {
+              "$ref": "#/definitions/v1.NetworkResponse"
+            }
+          },
+          "409": {
+            "description": "Conflict",
+            "schema": {
+              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
+            }
+          },
+          "default": {
+            "description": "Error",
+            "schema": {
+              "$ref": "#/definitions/httperrors.HTTPErrorResponse"
+            }
+          }
+        },
+        "summary": "free a network",
+        "tags": [
+          "network"
+        ]
       }
     },
     "/v1/network/{id}": {