X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fswagger.json;h=d72a7573b06542efad44bc3a86c62b198687e574;hb=78c1042379421afb07863f0459ab76bf7edf934b;hp=bbdefbb74f3620015f2232d8c14b405c5334ac01;hpb=48e72104985c9af63c778e79afb72e1b42a2e4de;p=pti%2Fo2.git diff --git a/docs/swagger.json b/docs/swagger.json index bbdefbb..d72a757 100644 --- a/docs/swagger.json +++ b/docs/swagger.json @@ -9,9 +9,9 @@ "description": "Success" } }, - "operationId": "get_inventory_version", + "operationId": "Get Inventory Version", "tags": [ - "O2IMS_Inventory" + "O2IMS-InfrastructureInventory" ] } }, @@ -54,9 +54,9 @@ } } }, - "operationId": "get_oclouds_list_router", + "operationId": "Get Ocloud Information", "tags": [ - "O2IMS_Inventory" + "O2IMS-InfrastructureInventory" ] } }, @@ -99,9 +99,9 @@ } } }, - "operationId": "get_oclouds_list_router", + "operationId": "Get Ocloud Information", "tags": [ - "O2IMS_Inventory" + "O2IMS-InfrastructureInventory" ] } }, @@ -112,9 +112,9 @@ "description": "Success" } }, - "operationId": "get_version_router", + "operationId": "Get Inventory API version", "tags": [ - "O2IMS_Inventory" + "O2IMS-InfrastructureInventory" ] } }, @@ -170,9 +170,9 @@ } } }, - "operationId": "get_deployment_managers_list_router", + "operationId": "Get Deployment Manager List", "tags": [ - "O2IMS_Inventory" + "O2IMS-InfrastructureInventory" ] } }, @@ -228,9 +228,9 @@ } } }, - "operationId": "Get deployment manager", + "operationId": "Get Deployment Manager Information", "tags": [ - "O2IMS_Inventory" + "O2IMS-InfrastructureInventory" ] } }, @@ -286,9 +286,9 @@ } } }, - "operationId": "get_resource_pools_list_router", + "operationId": "Get Resource Pool List", "tags": [ - "O2IMS_Inventory" + "O2IMS-InfrastructureInventory" ] } }, @@ -338,9 +338,9 @@ } } }, - "operationId": "Get resource pool", + "operationId": "Get Resource Pool Information", "tags": [ - "O2IMS_Inventory" + "O2IMS-InfrastructureInventory" ] } }, @@ -406,9 +406,9 @@ } } }, - "operationId": "get_resources_list_router", + "operationId": "Get Resource List", "tags": [ - "O2IMS_Inventory" + "O2IMS-InfrastructureInventory" ] } }, @@ -465,9 +465,9 @@ } } }, - "operationId": "Get resource", + "operationId": "Get Resource Information", "tags": [ - "O2IMS_Inventory" + "O2IMS-InfrastructureInventory" ] } }, @@ -523,9 +523,9 @@ } } }, - "operationId": "get_resource_types_list_router", + "operationId": "Get Resource Type List", "tags": [ - "O2IMS_Inventory" + "O2IMS-InfrastructureInventory" ] } }, @@ -575,13 +575,37 @@ } } }, - "operationId": "Get resource type", + "operationId": "Get Resource Type Information", "tags": [ - "O2IMS_Inventory" + "O2IMS-InfrastructureInventory" ] } }, "/o2ims-infrastructureInventory/v1/subscriptions": { + "post": { + "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SubscriptionGetDto" + } + } + }, + "operationId": "Create a Subscription", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/SubscriptionCreateDto" + } + } + ], + "tags": [ + "O2IMS-InfrastructureInventory" + ] + }, "get": { "responses": { "200": { @@ -594,7 +618,7 @@ } } }, - "operationId": "List subscriptions", + "operationId": "Get Subscription List", "parameters": [ { "in": "query", @@ -635,31 +659,7 @@ } ], "tags": [ - "O2IMS_Inventory" - ] - }, - "post": { - "responses": { - "201": { - "description": "Success", - "schema": { - "$ref": "#/definitions/SubscriptionGetDto" - } - } - }, - "operationId": "Create a subscription", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/SubscriptionCreateDto" - } - } - ], - "tags": [ - "O2IMS_Inventory" + "O2IMS-InfrastructureInventory" ] } }, @@ -685,7 +685,7 @@ } } }, - "operationId": "Get subscription by ID", + "operationId": "Get Subscription Information", "parameters": [ { "in": "query", @@ -713,7 +713,7 @@ } ], "tags": [ - "O2IMS_Inventory" + "O2IMS-InfrastructureInventory" ] }, "delete": { @@ -725,9 +725,9 @@ "description": "Subscription deleted" } }, - "operationId": "Delete subscription by ID", + "operationId": "Delete a Subscription", "tags": [ - "O2IMS_Inventory" + "O2IMS-InfrastructureInventory" ] } }, @@ -738,13 +738,37 @@ "description": "Success" } }, - "operationId": "get_monitoring_version", + "operationId": "Get Monitoring Version", "tags": [ - "O2IMS_InfrastructureMonitoring" + "O2IMS-InfrastructureMonitoring" ] } }, "/o2ims-infrastructureMonitoring/v1/alarmSubscriptions": { + "post": { + "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AlarmSubscriptionGetDto" + } + } + }, + "operationId": "Create a Alarm Subscription", + "parameters": [ + { + "name": "payload", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/AlarmSubscriptionCreateDto" + } + } + ], + "tags": [ + "O2IMS-InfrastructureMonitoring" + ] + }, "get": { "responses": { "200": { @@ -757,7 +781,7 @@ } } }, - "operationId": "List alarm subscriptions", + "operationId": "Get Alarm Subscription List", "parameters": [ { "in": "query", @@ -798,31 +822,7 @@ } ], "tags": [ - "O2IMS_InfrastructureMonitoring" - ] - }, - "post": { - "responses": { - "201": { - "description": "Success", - "schema": { - "$ref": "#/definitions/AlarmSubscriptionGetDto" - } - } - }, - "operationId": "Create a alarm subscription", - "parameters": [ - { - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/AlarmSubscriptionCreateDto" - } - } - ], - "tags": [ - "O2IMS_InfrastructureMonitoring" + "O2IMS-InfrastructureMonitoring" ] } }, @@ -848,7 +848,7 @@ } } }, - "operationId": "Get Alarm Subscription by ID", + "operationId": "Get Alarm Subscription Information", "parameters": [ { "in": "query", @@ -876,7 +876,7 @@ } ], "tags": [ - "O2IMS_InfrastructureMonitoring" + "O2IMS-InfrastructureMonitoring" ] }, "delete": { @@ -888,9 +888,9 @@ "description": "Subscription deleted" } }, - "operationId": "Delete subscription by ID", + "operationId": "Delete an Alarm Subscription", "tags": [ - "O2IMS_InfrastructureMonitoring" + "O2IMS-InfrastructureMonitoring" ] } }, @@ -946,9 +946,9 @@ } } }, - "operationId": "get_alarm_list_router", + "operationId": "Get Alarm Event Record List", "tags": [ - "O2IMS_InfrastructureMonitoring" + "O2IMS-InfrastructureMonitoring" ] } }, @@ -998,9 +998,9 @@ } } }, - "operationId": "Get AlarmEventRecord", + "operationId": "Get Alarm Event Record Information", "tags": [ - "O2IMS_InfrastructureMonitoring" + "O2IMS-InfrastructureMonitoring" ] } }, @@ -1011,9 +1011,9 @@ "description": "Success" } }, - "operationId": "get_version_router", + "operationId": "Get Monitoring API version", "tags": [ - "O2IMS_InfrastructureMonitoring" + "O2IMS-InfrastructureMonitoring" ] } } @@ -1031,11 +1031,11 @@ ], "tags": [ { - "name": "O2IMS_Inventory", - "description": "IMS Inventory related operations." + "name": "O2IMS-InfrastructureInventory", + "description": "O2 IMS Inventory related operations." }, { - "name": "O2IMS_InfrastructureMonitoring", + "name": "O2IMS-InfrastructureMonitoring", "description": "O2 IMS Monitoring related operations." } ], @@ -1046,25 +1046,39 @@ ], "properties": { "oCloudId": { - "type": "string" + "type": "string", + "description": "Identifier for the containing O-Cloud.", + "example": "f078a1d3-56df-46c2-88a2-dd659aa3f6bd" }, "globalCloudId": { - "type": "string" + "type": "string", + "description": "Identifier of the O-Cloud instance. Globally unique across O-Cloud instances.", + "example": "10a07219-4201-4b3e-a52d-81ab6a755d8a" }, "globalcloudId": { - "type": "string" + "type": "string", + "description": "Identifier of the O-Cloud instance. Globally unique across O-Cloud instances.(Specification)", + "example": "10a07219-4201-4b3e-a52d-81ab6a755d8a" }, "name": { - "type": "string" + "type": "string", + "description": "Human readable name of the O-Cloud.", + "example": "95b818b8-b315-4d9f-af37-b82c492101f1" }, "description": { - "type": "string" + "type": "string", + "description": "Human readable description of the O-Cloud.", + "example": "An ocloud" }, "serviceUri": { - "type": "string" + "type": "string", + "description": "The fully qualified URI root to all services provided by the O2ims interface", + "example": "https://128.224.115.51:30205" }, "extensions": { - "type": "string" + "type": "string", + "description": "These are unspecified (not standardized) properties (keys) which are tailored by the vendor to extend the information provided about the O-Cloud.", + "example": "" } }, "x-mask": "{oCloudId,globalCloudId,globalcloudId,name,description,serviceUri}", @@ -1178,25 +1192,38 @@ "properties": { "resourcePoolId": { "type": "string", - "description": "Resource pool ID" + "description": "Identifier for the Resource Pool in the O-Cloud instance.", + "example": "f078a1d3-56df-46c2-88a2-dd659aa3f6bd" }, "globalLocationId": { - "type": "string" + "type": "string", + "description": "This identifier is copied from the O-Cloud Id assigned by the SMO during the O-Cloud deployment.", + "example": "" }, "name": { - "type": "string" + "type": "string", + "description": "Human readable name of the resource pool.", + "example": "RegionOne" }, "description": { - "type": "string" + "type": "string", + "description": "Human readable description of the resource pool.", + "example": "A Resource Pool" }, "oCloudId": { - "type": "string" + "type": "string", + "description": "Identifier for the containing O-Cloud.", + "example": "f078a1d3-56df-46c2-88a2-dd659aa3f6bd" }, "location": { - "type": "string" + "type": "string", + "description": "Information about the geographical location of the resource pool as detected by the O-Cloud.", + "example": "" }, "extensions": { - "type": "string" + "type": "string", + "description": "List of metadata key-value pairs used to associate meaningful metadata to the related resource pool.", + "example": "" } }, "x-mask": "{resourcePoolId,oCloudId,globalLocationId,name,description}", @@ -1491,7 +1518,8 @@ "properties": { "alarmEventRecordId": { "type": "string", - "description": "Alarm Event Record ID" + "description": "Alarm Event Record ID", + "example": "f078a1d3-56df-46c2-88a2-dd659aa3f6bd" }, "resourceTypeId": { "type": "string" @@ -1608,4 +1636,4 @@ "description": "Return a custom message and 500 status code" } } -} \ No newline at end of file +}