Docs: update the h-release notes and the API docs

[pti/o2.git] / docs / swagger.json

diff --git a/docs/swagger.json b/docs/swagger.json
index 0330644..6fe17d5 100644 (file)
--- a/docs/swagger.json
+++ b/docs/swagger.json
@@ -47,14 +47,14 @@
             ],
             "get": {
                 "responses": {
-                    "404": {
-                        "description": "oCloud not found"
-                    },
                     "200": {
                         "description": "Success",
                         "schema": {
                             "$ref": "#/definitions/OcloudDto"
                         }
+                    },
+                    "404": {
+                        "description": "oCloud not found"
                     }
                 },
                 "operationId": "Get Ocloud Information",
@@ -92,14 +92,14 @@
             ],
             "get": {
                 "responses": {
-                    "404": {
-                        "description": "oCloud not found"
-                    },
                     "200": {
                         "description": "Success",
                         "schema": {
                             "$ref": "#/definitions/OcloudDto"
                         }
+                    },
+                    "404": {
+                        "description": "oCloud not found"
                     }
                 },
                 "operationId": "Get Ocloud Information",
@@ -224,14 +224,14 @@
             ],
             "get": {
                 "responses": {
-                    "404": {
-                        "description": "Deployment manager not found"
-                    },
                     "200": {
                         "description": "Success",
                         "schema": {
                             "$ref": "#/definitions/DeploymentManagerGetDto"
                         }
+                    },
+                    "404": {
+                        "description": "Deployment manager not found"
                     }
                 },
                 "operationId": "Get Deployment Manager Information",
@@ -334,14 +334,14 @@
             ],
             "get": {
                 "responses": {
-                    "404": {
-                        "description": "Resource pool not found"
-                    },
                     "200": {
                         "description": "Success",
                         "schema": {
                             "$ref": "#/definitions/ResourcePoolGetDto"
                         }
+                    },
+                    "404": {
+                        "description": "Resource pool not found"
                     }
                 },
                 "operationId": "Get Resource Pool Information",
@@ -399,9 +399,6 @@
             ],
             "get": {
                 "responses": {
-                    "404": {
-                        "description": "Resource pool not found"
-                    },
                     "200": {
                         "description": "Success",
                         "schema": {
@@ -410,6 +407,9 @@
                                 "$ref": "#/definitions/ResourceListDto"
                             }
                         }
+                    },
+                    "404": {
+                        "description": "Resource pool not found"
                     }
                 },
                 "operationId": "Get Resource List",
@@ -461,14 +461,14 @@
             ],
             "get": {
                 "responses": {
-                    "404": {
-                        "description": "Resource not found"
-                    },
                     "200": {
                         "description": "Success",
                         "schema": {
                             "$ref": "#/definitions/ResourceGetDto2"
                         }
+                    },
+                    "404": {
+                        "description": "Resource not found"
                     }
                 },
                 "operationId": "Get Resource Information",
@@ -571,14 +571,14 @@
             ],
             "get": {
                 "responses": {
-                    "404": {
-                        "description": "Resource type not found"
-                    },
                     "200": {
                         "description": "Success",
                         "schema": {
                             "$ref": "#/definitions/ResourceTypeGetDto"
                         }
+                    },
+                    "404": {
+                        "description": "Resource type not found"
                     }
                 },
                 "operationId": "Get Resource Type Information",
@@ -681,14 +681,14 @@
             ],
             "get": {
                 "responses": {
-                    "404": {
-                        "description": "Subscription not found"
-                    },
                     "200": {
                         "description": "Success",
                         "schema": {
                             "$ref": "#/definitions/SubscriptionGetDto"
                         }
+                    },
+                    "404": {
+                        "description": "Subscription not found"
                     }
                 },
                 "operationId": "Get Subscription Information",
@@ -724,11 +724,11 @@
             },
             "delete": {
                 "responses": {
-                    "404": {
-                        "description": "Subscription not found"
-                    },
                     "200": {
                         "description": "Subscription deleted"
+                    },
+                    "404": {
+                        "description": "Subscription not found"
                     }
                 },
                 "operationId": "Delete a Subscription",
@@ -847,14 +847,14 @@
             ],
             "get": {
                 "responses": {
-                    "404": {
-                        "description": "Alarm Subscription not found"
-                    },
                     "200": {
                         "description": "Success",
                         "schema": {
                             "$ref": "#/definitions/AlarmSubscriptionGetDto"
                         }
+                    },
+                    "404": {
+                        "description": "Alarm Subscription not found"
                     }
                 },
                 "operationId": "Get Alarm Subscription Information",
@@ -890,11 +890,11 @@
             },
             "delete": {
                 "responses": {
-                    "404": {
-                        "description": "Alarm Subscription not found"
-                    },
                     "200": {
                         "description": "Subscription deleted"
+                    },
+                    "404": {
+                        "description": "Alarm Subscription not found"
                     }
                 },
                 "operationId": "Delete an Alarm Subscription",
@@ -997,14 +997,14 @@
             ],
             "get": {
                 "responses": {
-                    "404": {
-                        "description": "Alarm Event Record not found"
-                    },
                     "200": {
                         "description": "Success",
                         "schema": {
                             "$ref": "#/definitions/AlarmGetDto"
                         }
+                    },
+                    "404": {
+                        "description": "Alarm Event Record not found"
                     }
                 },
                 "operationId": "Get Alarm Event Record Information",
@@ -1580,9 +1580,12 @@
                 },
                 "serviceUri": {
                     "type": "string",
-                    "description": "The fully qualified URI to a Deployment Management server for O2dms services.",
+                    "description": "The fully qualified URI to a Deployment Management server for O2dms.",
                     "example": "https://128.224.115.51:6443"
                 },
+                "capabilities": {
+                    "$ref": "#/definitions/DeploymentManagerCapabilities"
+                },
                 "profileSupportList": {
                     "type": "array",
                     "description": "Profile support list, use default for the return endpoint",
@@ -1602,6 +1605,16 @@
             "x-mask": "{deploymentManagerId,name,description,oCloudId,serviceUri,profileSupportList}",
             "type": "object"
         },
+        "DeploymentManagerCapabilities": {
+            "properties": {
+                "OS": {
+                    "type": "string",
+                    "description": "Show the OS capablities of the Deployment Manager",
+                    "example": "low_latency"
+                }
+            },
+            "type": "object"
+        },
         "DeploymentManagerGetDto": {
             "required": [
                 "deploymentManagerId"
@@ -1629,14 +1642,17 @@
                 },
                 "serviceUri": {
                     "type": "string",
-                    "description": "The fully qualified URI to a Deployment Management server for O2dms services.",
+                    "description": "The fully qualified URI to a Deployment Management server for O2dms.",
                     "example": "https://128.224.115.51:6443"
                 },
+                "capabilities": {
+                    "$ref": "#/definitions/DeploymentManagerCapabilities"
+                },
                 "extensions": {
                     "$ref": "#/definitions/DeploymentManagerExtensions"
                 }
             },
-            "x-mask": "{deploymentManagerId,name,description,oCloudId,serviceUri,extensions,profileName,profileData}",
+            "x-mask": "{deploymentManagerId,name,description,oCloudId,serviceUri,extensions{profileName,profileData}}",
             "type": "object"
         },
         "DeploymentManagerExtensions": {
@@ -1997,4 +2013,4 @@
             "description": "Return a custom message and 500 status code"
         }
     }
-}
+}
\ No newline at end of file