Skip to content

Commit

Permalink
Add PATCH API for inventory monitoring
Browse files Browse the repository at this point in the history 
Update the API document for the inventory monitoring PATCH method

Change-Id: I928519e02f72f05b2f35751238848dfba2c45050
Signed-off-by: Zhang Rong(Jon) <[email protected]>
  • Loading branch information
@jonrzhang
jonrzhang committed Aug 29, 2024
1 parent cac8f42 commit 76669a5
Show file tree
Hide file tree
Showing 3 changed files with 228 additions and 76 deletions.
Empty file modified docs/api-docs.rst
100755 → 100644
View file
Empty file.
151 changes: 113 additions & 38 deletions docs/swagger.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -399,6 +399,9 @@
],
"get": {
"responses": {
"404": {
"description": "Resource pool not found"
},
"200": {
"description": "Success",
"schema": {
Expand All @@ -407,9 +410,6 @@
"$ref": "#/definitions/ResourceListDto"
}
}
},
"404": {
"description": "Resource pool not found"
}
},
"operationId": "Get Resource List",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -724,11 +724,11 @@
},
"delete": {
"responses": {
"200": {
"description": "Subscription deleted"
},
"404": {
"description": "Subscription not found"
},
"200": {
"description": "Subscription deleted"
}
},
"operationId": "Delete a Subscription",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -890,11 +890,11 @@
},
"delete": {
"responses": {
"200": {
"description": "Subscription deleted"
},
"404": {
"description": "Alarm Subscription not found"
},
"200": {
"description": "Subscription deleted"
}
},
"operationId": "Delete an Alarm Subscription",
Expand Down Expand Up @@ -995,16 +995,43 @@
"type": "string"
}
],
"get": {
"patch": {
"responses": {
"404": {
"description": "Alarm Event Record not found"
},
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/AlarmGetDto"
"$ref": "#/definitions/AlarmPatchDto"
}
},
}
},
"operationId": "Patch Alarm Event Record Information",
"parameters": [
{
"name": "payload",
"required": true,
"in": "body",
"schema": {
"$ref": "#/definitions/AlarmPatchDto"
}
}
],
"tags": [
"O2IMS-InfrastructureMonitoring"
]
},
"get": {
"responses": {
"404": {
"description": "Alarm Event Record not found"
},
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/AlarmGetDto"
}
}
},
"operationId": "Get Alarm Event Record Information",
Expand Down Expand Up @@ -1583,9 +1610,15 @@
"description": "The fully qualified URI to a Deployment Management server for O2dms.",
"example": "https://128.224.115.51:6443"
},
"supportedLocations": {
"type": "string"
},
"capabilities": {
"$ref": "#/definitions/DeploymentManagerCapabilities"
},
"capacity": {
"$ref": "#/definitions/DeploymentManagerCapacity"
},
"profileSupportList": {
"type": "array",
"description": "Profile support list, use default for the return endpoint",
Expand All @@ -1602,7 +1635,7 @@
"example": ""
}
},
"x-mask": "{deploymentManagerId,name,description,oCloudId,serviceUri,profileSupportList}",
"x-mask": "{deploymentManagerId,name,description,oCloudId,serviceUri,supportedLocations,capabilities,capacity,profileSupportList}",
"type": "object"
},
"DeploymentManagerCapabilities": {
Expand All @@ -1615,6 +1648,26 @@
},
"type": "object"
},
"DeploymentManagerCapacity": {
"properties": {
"cpu": {
"type": "string",
"description": "Show the cpu capacity of the Deployment Manager",
"example": "32"
},
"hugepages-2Mi": {
"type": "string",
"description": "Show the 2Mi hugepages capacity of the Deployment Manager",
"example": "2048"
},
"hugepages-1Gi": {
"type": "string",
"description": "Show the 1Gi hugepages capacity of the Deployment Manager",
"example": "2048"
}
},
"type": "object"
},
"DeploymentManagerGetDto": {
"required": [
"deploymentManagerId"
Expand Down Expand Up @@ -1645,14 +1698,20 @@
"description": "The fully qualified URI to a Deployment Management server for O2dms.",
"example": "https://128.224.115.51:6443"
},
"supportedLocations": {
"type": "string"
},
"capabilities": {
"$ref": "#/definitions/DeploymentManagerCapabilities"
},
"capacity": {
"$ref": "#/definitions/DeploymentManagerCapacity"
},
"extensions": {
"$ref": "#/definitions/DeploymentManagerExtensions"
}
},
"x-mask": "{deploymentManagerId,name,description,oCloudId,serviceUri,extensions{profileName,profileData}}",
"x-mask": "{deploymentManagerId,name,description,oCloudId,serviceUri,supportedLocations,capabilities,capacity,extensions{profileName,profileData}}",
"type": "object"
},
"DeploymentManagerExtensions": {
Expand Down Expand Up @@ -1931,6 +1990,22 @@
},
"type": "object"
},
"AlarmPatchDto": {
"properties": {
"alarmAcknowledged": {
"type": "boolean",
"description": "Boolean value indication of a management system has acknowledged the alarm.",
"example": true
},
"perceivedSeverity": {
"type": "string",
"description": "indicate that the alarm record is requested to be cleared. Only the value \"5\" for \"CLEARED\" is permitted in a request message content. ",
"example": "5"
}
},
"x-mask": "{alarmAcknowledged}",
"type": "object"
},
"AlarmSubscriptionCreateDto": {
"required": [
"callback"
Expand Down
Loading

0 comments on commit 76669a5

Please sign in to comment.