Docs: update API example of O-Cloud and resourcePool

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

diff --git a/docs/swagger.yaml b/docs/swagger.yaml
index fa0e624..b6529c5 100755 (executable)
--- a/docs/swagger.yaml
+++ b/docs/swagger.yaml
@@ -6,9 +6,9 @@ info:
   title: INF O2 Services API
 basePath: /
 tags:
-- name: O2IMS_Inventory
-  description: IMS Inventory related operations.
-- name: O2IMS_InfrastructureMonitoring
+- name: O2IMS-InfrastructureInventory
+  description: O2 IMS Inventory related operations.
+- name: O2IMS-InfrastructureMonitoring
   description: O2 IMS Monitoring related operations.
 consumes:
 - application/json
@@ -18,8 +18,8 @@ paths:
   /o2ims-infrastructureInventory/api_versions:
     get:
       tags:
-      - O2IMS_Inventory
-      operationId: get_inventory_version
+      - O2IMS-InfrastructureInventory
+      operationId: Get Inventory Version
       parameters: []
       responses:
         "200":
@@ -27,8 +27,8 @@ paths:
   /o2ims-infrastructureInventory/v1:
     get:
       tags:
-      - O2IMS_Inventory
-      operationId: get_oclouds_list_router
+      - O2IMS-InfrastructureInventory
+      operationId: Get Ocloud Information
       parameters:
       - name: exclude_default
         in: query
@@ -60,8 +60,8 @@ paths:
   /o2ims-infrastructureInventory/v1/:
     get:
       tags:
-      - O2IMS_Inventory
-      operationId: get_oclouds_list_router
+      - O2IMS-InfrastructureInventory
+      operationId: Get Ocloud Information
       parameters:
       - name: exclude_default
         in: query
@@ -93,8 +93,8 @@ paths:
   /o2ims-infrastructureInventory/v1/api_versions:
     get:
       tags:
-      - O2IMS_Inventory
-      operationId: get_version_router
+      - O2IMS-InfrastructureInventory
+      operationId: Get Inventory API version
       parameters: []
       responses:
         "200":
@@ -102,8 +102,8 @@ paths:
   /o2ims-infrastructureInventory/v1/deploymentManagers:
     get:
       tags:
-      - O2IMS_Inventory
-      operationId: get_deployment_managers_list_router
+      - O2IMS-InfrastructureInventory
+      operationId: Get Deployment Manager List
       parameters:
       - name: filter
         in: query
@@ -146,8 +146,8 @@ paths:
   /o2ims-infrastructureInventory/v1/deploymentManagers/{deploymentManagerID}:
     get:
       tags:
-      - O2IMS_Inventory
-      operationId: Get deployment manager
+      - O2IMS-InfrastructureInventory
+      operationId: Get Deployment Manager Information
       parameters:
       - name: exclude_default
         in: query
@@ -189,8 +189,8 @@ paths:
   /o2ims-infrastructureInventory/v1/resourcePools:
     get:
       tags:
-      - O2IMS_Inventory
-      operationId: get_resource_pools_list_router
+      - O2IMS-InfrastructureInventory
+      operationId: Get Resource Pool List
       parameters:
       - name: filter
         in: query
@@ -233,8 +233,8 @@ paths:
   /o2ims-infrastructureInventory/v1/resourcePools/{resourcePoolID}:
     get:
       tags:
-      - O2IMS_Inventory
-      operationId: Get resource pool
+      - O2IMS-InfrastructureInventory
+      operationId: Get Resource Pool Information
       parameters:
       - name: exclude_default
         in: query
@@ -271,8 +271,8 @@ paths:
   /o2ims-infrastructureInventory/v1/resourcePools/{resourcePoolID}/resources:
     get:
       tags:
-      - O2IMS_Inventory
-      operationId: get_resources_list_router
+      - O2IMS-InfrastructureInventory
+      operationId: Get Resource List
       parameters:
       - name: filter
         in: query
@@ -322,8 +322,8 @@ paths:
   /o2ims-infrastructureInventory/v1/resourcePools/{resourcePoolID}/resources/{resourceID}:
     get:
       tags:
-      - O2IMS_Inventory
-      operationId: Get resource
+      - O2IMS-InfrastructureInventory
+      operationId: Get Resource Information
       parameters:
       - name: exclude_default
         in: query
@@ -365,8 +365,8 @@ paths:
   /o2ims-infrastructureInventory/v1/resourceTypes:
     get:
       tags:
-      - O2IMS_Inventory
-      operationId: get_resource_types_list_router
+      - O2IMS-InfrastructureInventory
+      operationId: Get Resource Type List
       parameters:
       - name: filter
         in: query
@@ -409,8 +409,8 @@ paths:
   /o2ims-infrastructureInventory/v1/resourceTypes/{resourceTypeID}:
     get:
       tags:
-      - O2IMS_Inventory
-      operationId: Get resource type
+      - O2IMS-InfrastructureInventory
+      operationId: Get Resource Type Information
       parameters:
       - name: exclude_default
         in: query
@@ -447,8 +447,8 @@ paths:
   /o2ims-infrastructureInventory/v1/subscriptions:
     get:
       tags:
-      - O2IMS_Inventory
-      operationId: List subscriptions
+      - O2IMS-InfrastructureInventory
+      operationId: Get Subscription List
       parameters:
       - name: filter
         in: query
@@ -490,8 +490,8 @@ paths:
               $ref: '#/definitions/SubscriptionGetDto'
     post:
       tags:
-      - O2IMS_Inventory
-      operationId: Create a subscription
+      - O2IMS-InfrastructureInventory
+      operationId: Create a Subscription
       parameters:
       - in: body
         name: payload
@@ -506,8 +506,8 @@ paths:
   /o2ims-infrastructureInventory/v1/subscriptions/{subscriptionID}:
     get:
       tags:
-      - O2IMS_Inventory
-      operationId: Get subscription by ID
+      - O2IMS-InfrastructureInventory
+      operationId: Get Subscription Information
       parameters:
       - name: subscriptionID
         in: path
@@ -543,8 +543,8 @@ paths:
           description: Subscription not found
     delete:
       tags:
-      - O2IMS_Inventory
-      operationId: Delete subscription by ID
+      - O2IMS-InfrastructureInventory
+      operationId: Delete a Subscription
       parameters:
       - name: subscriptionID
         in: path
@@ -559,8 +559,8 @@ paths:
   /o2ims-infrastructureMonitoring/api_versions:
     get:
       tags:
-      - O2IMS_InfrastructureMonitoring
-      operationId: get_monitoring_version
+      - O2IMS-InfrastructureMonitoring
+      operationId: Get Monitoring Version
       parameters: []
       responses:
         "200":
@@ -568,8 +568,8 @@ paths:
   /o2ims-infrastructureMonitoring/v1/alarmSubscriptions:
     get:
       tags:
-      - O2IMS_InfrastructureMonitoring
-      operationId: List alarm subscriptions
+      - O2IMS-InfrastructureMonitoring
+      operationId: Get Alarm Subscription List
       parameters:
       - name: filter
         in: query
@@ -611,8 +611,8 @@ paths:
               $ref: '#/definitions/AlarmSubscriptionGetDto'
     post:
       tags:
-      - O2IMS_InfrastructureMonitoring
-      operationId: Create a alarm subscription
+      - O2IMS-InfrastructureMonitoring
+      operationId: Create a Alarm Subscription
       parameters:
       - in: body
         name: payload
@@ -627,8 +627,8 @@ paths:
   /o2ims-infrastructureMonitoring/v1/alarmSubscriptions/{alarmSubscriptionID}:
     get:
       tags:
-      - O2IMS_InfrastructureMonitoring
-      operationId: Get Alarm Subscription by ID
+      - O2IMS-InfrastructureMonitoring
+      operationId: Get Alarm Subscription Information
       parameters:
       - name: alarmSubscriptionID
         in: path
@@ -664,8 +664,8 @@ paths:
           description: Alarm Subscription not found
     delete:
       tags:
-      - O2IMS_InfrastructureMonitoring
-      operationId: Delete subscription by ID
+      - O2IMS-InfrastructureMonitoring
+      operationId: Delete an Alarm Subscription
       parameters:
       - name: alarmSubscriptionID
         in: path
@@ -680,8 +680,8 @@ paths:
   /o2ims-infrastructureMonitoring/v1/alarms:
     get:
       tags:
-      - O2IMS_InfrastructureMonitoring
-      operationId: get_alarm_list_router
+      - O2IMS-InfrastructureMonitoring
+      operationId: Get Alarm Event Record List
       parameters:
       - name: filter
         in: query
@@ -724,8 +724,8 @@ paths:
   /o2ims-infrastructureMonitoring/v1/alarms/{alarmEventRecordId}:
     get:
       tags:
-      - O2IMS_InfrastructureMonitoring
-      operationId: Get AlarmEventRecord
+      - O2IMS-InfrastructureMonitoring
+      operationId: Get Alarm Event Record Information
       parameters:
       - name: exclude_default
         in: query
@@ -762,8 +762,8 @@ paths:
   /o2ims-infrastructureMonitoring/v1/api_versions:
     get:
       tags:
-      - O2IMS_InfrastructureMonitoring
-      operationId: get_version_router
+      - O2IMS-InfrastructureMonitoring
+      operationId: Get Monitoring API version
       parameters: []
       responses:
         "200":
@@ -776,18 +776,32 @@ definitions:
     properties:
       oCloudId:
         type: string
+        example: f078a1d3-56df-46c2-88a2-dd659aa3f6bd
+        description: Identifier for the containing O-Cloud.
       globalCloudId:
         type: string
+        example: 10a07219-4201-4b3e-a52d-81ab6a755d8a
+        description: Identifier of the O-Cloud instance. Globally unique across O-Cloud instances.
       globalcloudId:
         type: string
+        example: 10a07219-4201-4b3e-a52d-81ab6a755d8a
+        description: Identifier of the O-Cloud instance. Globally unique across O-Cloud instances.(Specification)
       name:
         type: string
+        example: 95b818b8-b315-4d9f-af37-b82c492101f1
+        description: Human readable name of the O-Cloud.
       description:
         type: string
+        example: An ocloud
+        description: Human readable description of the O-Cloud.
       serviceUri:
         type: string
+        example: https://128.224.115.51:30205
+        description: The fully qualified URI root to all services provided by the O2ims interface
       extensions:
         type: string
+        example: ""
+        description: These are unspecified (not standardized) properties (keys) which are tailored by the vendor to extend the information provided about the O-Cloud.
     x-mask: "{oCloudId,globalCloudId,globalcloudId,name,description,serviceUri}"
   ResourceTypeGetDto:
     type: object
@@ -863,19 +877,32 @@ definitions:
     properties:
       resourcePoolId:
         type: string
-        description: Resource pool ID
+        example: f078a1d3-56df-46c2-88a2-dd659aa3f6bd
+        description: Identifier for the Resource Pool in the O-Cloud instance.
       globalLocationId:
         type: string
+        example: ""
+        description: This identifier is copied from the O-Cloud Id assigned by the SMO during the O-Cloud deployment.
       name:
         type: string
+        example: RegionOne
+        description: Human readable name of the resource pool.
       description:
         type: string
+        example: A Resource Pool
+        description: Human readable description of the resource pool.
       oCloudId:
         type: string
+        example: f078a1d3-56df-46c2-88a2-dd659aa3f6bd
+        description: Identifier for the containing O-Cloud.
       location:
         type: string
+        example: ""
+        description: Information about the geographical location of the resource pool as detected by the O-Cloud.
       extensions:
         type: string
+        example: ""
+        description: List of metadata key-value pairs used to associate meaningful metadata to the related resource pool.
     x-mask: "{resourcePoolId,oCloudId,globalLocationId,name,description}"
   ResourceListDto:
     type: object
@@ -1078,6 +1105,7 @@ definitions:
     properties:
       alarmEventRecordId:
         type: string
+        example: f078a1d3-56df-46c2-88a2-dd659aa3f6bd
         description: Alarm Event Record ID
       resourceTypeId:
         type: string