Docs: update API example of O-Cloud and resourcePool

Issue-ID: INF-387
Signed-off-by: Zhang Rong(Jon) <rong.zhang@windriver.com>
Change-Id: If241c481a593a93a1d1fd00aaba7b17ad4ccc0e7
(cherry picked from commit 78c1042379421afb07863f0459ab76bf7edf934b)

diff --git a/docs/swagger.json b/docs/swagger.json
index b00c4e4..d72a757 100644 (file)
--- a/docs/swagger.json
+++ b/docs/swagger.json
@@ -11,7 +11,7 @@
                 },
                 "operationId": "Get Inventory Version",
                 "tags": [
-                    "O2IMS_Inventory"
+                    "O2IMS-InfrastructureInventory"
                 ]
             }
         },
@@ -56,7 +56,7 @@
                 },
                 "operationId": "Get Ocloud Information",
                 "tags": [
-                    "O2IMS_Inventory"
+                    "O2IMS-InfrastructureInventory"
                 ]
             }
         },
@@ -101,7 +101,7 @@
                 },
                 "operationId": "Get Ocloud Information",
                 "tags": [
-                    "O2IMS_Inventory"
+                    "O2IMS-InfrastructureInventory"
                 ]
             }
         },
@@ -114,7 +114,7 @@
                 },
                 "operationId": "Get Inventory API version",
                 "tags": [
-                    "O2IMS_Inventory"
+                    "O2IMS-InfrastructureInventory"
                 ]
             }
         },
@@ -172,7 +172,7 @@
                 },
                 "operationId": "Get Deployment Manager List",
                 "tags": [
-                    "O2IMS_Inventory"
+                    "O2IMS-InfrastructureInventory"
                 ]
             }
         },
@@ -230,7 +230,7 @@
                 },
                 "operationId": "Get Deployment Manager Information",
                 "tags": [
-                    "O2IMS_Inventory"
+                    "O2IMS-InfrastructureInventory"
                 ]
             }
         },
@@ -288,7 +288,7 @@
                 },
                 "operationId": "Get Resource Pool List",
                 "tags": [
-                    "O2IMS_Inventory"
+                    "O2IMS-InfrastructureInventory"
                 ]
             }
         },
@@ -340,7 +340,7 @@
                 },
                 "operationId": "Get Resource Pool Information",
                 "tags": [
-                    "O2IMS_Inventory"
+                    "O2IMS-InfrastructureInventory"
                 ]
             }
         },
@@ -408,7 +408,7 @@
                 },
                 "operationId": "Get Resource List",
                 "tags": [
-                    "O2IMS_Inventory"
+                    "O2IMS-InfrastructureInventory"
                 ]
             }
         },
@@ -467,7 +467,7 @@
                 },
                 "operationId": "Get Resource Information",
                 "tags": [
-                    "O2IMS_Inventory"
+                    "O2IMS-InfrastructureInventory"
                 ]
             }
         },
@@ -525,7 +525,7 @@
                 },
                 "operationId": "Get Resource Type List",
                 "tags": [
-                    "O2IMS_Inventory"
+                    "O2IMS-InfrastructureInventory"
                 ]
             }
         },
@@ -577,11 +577,35 @@
                 },
                 "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": {
@@ -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"
                 ]
             }
         },
@@ -673,20 +673,6 @@
                     "type": "string"
                 }
             ],
-            "delete": {
-                "responses": {
-                    "404": {
-                        "description": "Subscription not found"
-                    },
-                    "200": {
-                        "description": "Subscription deleted"
-                    }
-                },
-                "operationId": "Delete a Subscription",
-                "tags": [
-                    "O2IMS_Inventory"
-                ]
-            },
             "get": {
                 "responses": {
                     "404": {
@@ -727,7 +713,21 @@
                     }
                 ],
                 "tags": [
-                    "O2IMS_Inventory"
+                    "O2IMS-InfrastructureInventory"
+                ]
+            },
+            "delete": {
+                "responses": {
+                    "404": {
+                        "description": "Subscription not found"
+                    },
+                    "200": {
+                        "description": "Subscription deleted"
+                    }
+                },
+                "operationId": "Delete a Subscription",
+                "tags": [
+                    "O2IMS-InfrastructureInventory"
                 ]
             }
         },
@@ -740,11 +740,35 @@
                 },
                 "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": {
@@ -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"
                 ]
             }
         },
@@ -836,20 +836,6 @@
                     "type": "string"
                 }
             ],
-            "delete": {
-                "responses": {
-                    "404": {
-                        "description": "Alarm Subscription not found"
-                    },
-                    "200": {
-                        "description": "Subscription deleted"
-                    }
-                },
-                "operationId": "Delete an Alarm Subscription",
-                "tags": [
-                    "O2IMS_InfrastructureMonitoring"
-                ]
-            },
             "get": {
                 "responses": {
                     "404": {
@@ -890,7 +876,21 @@
                     }
                 ],
                 "tags": [
-                    "O2IMS_InfrastructureMonitoring"
+                    "O2IMS-InfrastructureMonitoring"
+                ]
+            },
+            "delete": {
+                "responses": {
+                    "404": {
+                        "description": "Alarm Subscription not found"
+                    },
+                    "200": {
+                        "description": "Subscription deleted"
+                    }
+                },
+                "operationId": "Delete an Alarm Subscription",
+                "tags": [
+                    "O2IMS-InfrastructureMonitoring"
                 ]
             }
         },
@@ -948,7 +948,7 @@
                 },
                 "operationId": "Get Alarm Event Record List",
                 "tags": [
-                    "O2IMS_InfrastructureMonitoring"
+                    "O2IMS-InfrastructureMonitoring"
                 ]
             }
         },
@@ -1000,7 +1000,7 @@
                 },
                 "operationId": "Get Alarm Event Record Information",
                 "tags": [
-                    "O2IMS_InfrastructureMonitoring"
+                    "O2IMS-InfrastructureMonitoring"
                 ]
             }
         },
@@ -1013,7 +1013,7 @@
                 },
                 "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"

diff --git a/docs/swagger.yaml b/docs/swagger.yaml
index 278fb91..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,7 +18,7 @@ paths:
   /o2ims-infrastructureInventory/api_versions:
     get:
       tags:
-      - O2IMS_Inventory
+      - O2IMS-InfrastructureInventory
       operationId: Get Inventory Version
       parameters: []
       responses:
@@ -27,7 +27,7 @@ paths:
   /o2ims-infrastructureInventory/v1:
     get:
       tags:
-      - O2IMS_Inventory
+      - O2IMS-InfrastructureInventory
       operationId: Get Ocloud Information
       parameters:
       - name: exclude_default
@@ -60,7 +60,7 @@ paths:
   /o2ims-infrastructureInventory/v1/:
     get:
       tags:
-      - O2IMS_Inventory
+      - O2IMS-InfrastructureInventory
       operationId: Get Ocloud Information
       parameters:
       - name: exclude_default
@@ -93,7 +93,7 @@ paths:
   /o2ims-infrastructureInventory/v1/api_versions:
     get:
       tags:
-      - O2IMS_Inventory
+      - O2IMS-InfrastructureInventory
       operationId: Get Inventory API version
       parameters: []
       responses:
@@ -102,7 +102,7 @@ paths:
   /o2ims-infrastructureInventory/v1/deploymentManagers:
     get:
       tags:
-      - O2IMS_Inventory
+      - O2IMS-InfrastructureInventory
       operationId: Get Deployment Manager List
       parameters:
       - name: filter
@@ -146,7 +146,7 @@ paths:
   /o2ims-infrastructureInventory/v1/deploymentManagers/{deploymentManagerID}:
     get:
       tags:
-      - O2IMS_Inventory
+      - O2IMS-InfrastructureInventory
       operationId: Get Deployment Manager Information
       parameters:
       - name: exclude_default
@@ -189,7 +189,7 @@ paths:
   /o2ims-infrastructureInventory/v1/resourcePools:
     get:
       tags:
-      - O2IMS_Inventory
+      - O2IMS-InfrastructureInventory
       operationId: Get Resource Pool List
       parameters:
       - name: filter
@@ -233,7 +233,7 @@ paths:
   /o2ims-infrastructureInventory/v1/resourcePools/{resourcePoolID}:
     get:
       tags:
-      - O2IMS_Inventory
+      - O2IMS-InfrastructureInventory
       operationId: Get Resource Pool Information
       parameters:
       - name: exclude_default
@@ -271,7 +271,7 @@ paths:
   /o2ims-infrastructureInventory/v1/resourcePools/{resourcePoolID}/resources:
     get:
       tags:
-      - O2IMS_Inventory
+      - O2IMS-InfrastructureInventory
       operationId: Get Resource List
       parameters:
       - name: filter
@@ -322,7 +322,7 @@ paths:
   /o2ims-infrastructureInventory/v1/resourcePools/{resourcePoolID}/resources/{resourceID}:
     get:
       tags:
-      - O2IMS_Inventory
+      - O2IMS-InfrastructureInventory
       operationId: Get Resource Information
       parameters:
       - name: exclude_default
@@ -365,7 +365,7 @@ paths:
   /o2ims-infrastructureInventory/v1/resourceTypes:
     get:
       tags:
-      - O2IMS_Inventory
+      - O2IMS-InfrastructureInventory
       operationId: Get Resource Type List
       parameters:
       - name: filter
@@ -409,7 +409,7 @@ paths:
   /o2ims-infrastructureInventory/v1/resourceTypes/{resourceTypeID}:
     get:
       tags:
-      - O2IMS_Inventory
+      - O2IMS-InfrastructureInventory
       operationId: Get Resource Type Information
       parameters:
       - name: exclude_default
@@ -447,7 +447,7 @@ paths:
   /o2ims-infrastructureInventory/v1/subscriptions:
     get:
       tags:
-      - O2IMS_Inventory
+      - O2IMS-InfrastructureInventory
       operationId: Get Subscription List
       parameters:
       - name: filter
@@ -490,7 +490,7 @@ paths:
               $ref: '#/definitions/SubscriptionGetDto'
     post:
       tags:
-      - O2IMS_Inventory
+      - O2IMS-InfrastructureInventory
       operationId: Create a Subscription
       parameters:
       - in: body
@@ -506,7 +506,7 @@ paths:
   /o2ims-infrastructureInventory/v1/subscriptions/{subscriptionID}:
     get:
       tags:
-      - O2IMS_Inventory
+      - O2IMS-InfrastructureInventory
       operationId: Get Subscription Information
       parameters:
       - name: subscriptionID
@@ -543,7 +543,7 @@ paths:
           description: Subscription not found
     delete:
       tags:
-      - O2IMS_Inventory
+      - O2IMS-InfrastructureInventory
       operationId: Delete a Subscription
       parameters:
       - name: subscriptionID
@@ -559,7 +559,7 @@ paths:
   /o2ims-infrastructureMonitoring/api_versions:
     get:
       tags:
-      - O2IMS_InfrastructureMonitoring
+      - O2IMS-InfrastructureMonitoring
       operationId: Get Monitoring Version
       parameters: []
       responses:
@@ -568,7 +568,7 @@ paths:
   /o2ims-infrastructureMonitoring/v1/alarmSubscriptions:
     get:
       tags:
-      - O2IMS_InfrastructureMonitoring
+      - O2IMS-InfrastructureMonitoring
       operationId: Get Alarm Subscription List
       parameters:
       - name: filter
@@ -611,7 +611,7 @@ paths:
               $ref: '#/definitions/AlarmSubscriptionGetDto'
     post:
       tags:
-      - O2IMS_InfrastructureMonitoring
+      - O2IMS-InfrastructureMonitoring
       operationId: Create a Alarm Subscription
       parameters:
       - in: body
@@ -627,7 +627,7 @@ paths:
   /o2ims-infrastructureMonitoring/v1/alarmSubscriptions/{alarmSubscriptionID}:
     get:
       tags:
-      - O2IMS_InfrastructureMonitoring
+      - O2IMS-InfrastructureMonitoring
       operationId: Get Alarm Subscription Information
       parameters:
       - name: alarmSubscriptionID
@@ -664,7 +664,7 @@ paths:
           description: Alarm Subscription not found
     delete:
       tags:
-      - O2IMS_InfrastructureMonitoring
+      - O2IMS-InfrastructureMonitoring
       operationId: Delete an Alarm Subscription
       parameters:
       - name: alarmSubscriptionID
@@ -680,7 +680,7 @@ paths:
   /o2ims-infrastructureMonitoring/v1/alarms:
     get:
       tags:
-      - O2IMS_InfrastructureMonitoring
+      - O2IMS-InfrastructureMonitoring
       operationId: Get Alarm Event Record List
       parameters:
       - name: filter
@@ -724,7 +724,7 @@ paths:
   /o2ims-infrastructureMonitoring/v1/alarms/{alarmEventRecordId}:
     get:
       tags:
-      - O2IMS_InfrastructureMonitoring
+      - O2IMS-InfrastructureMonitoring
       operationId: Get Alarm Event Record Information
       parameters:
       - name: exclude_default
@@ -762,7 +762,7 @@ paths:
   /o2ims-infrastructureMonitoring/v1/api_versions:
     get:
       tags:
-      - O2IMS_InfrastructureMonitoring
+      - O2IMS-InfrastructureMonitoring
       operationId: Get Monitoring API version
       parameters: []
       responses:
@@ -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

diff --git a/o2ims/views/alarm_dto.py b/o2ims/views/alarm_dto.py
index 5d0bca5..f4aac49 100644 (file)
--- a/o2ims/views/alarm_dto.py
+++ b/o2ims/views/alarm_dto.py
@@ -25,6 +25,7 @@ class AlarmDTO:
         {
             'alarmEventRecordId': fields.String(
                 required=True,
+                example='f078a1d3-56df-46c2-88a2-dd659aa3f6bd',
                 description='Alarm Event Record ID'),
             'resourceTypeId': fields.String,
             'resourceTypeID': fields.String(attribute='resourceTypeId'),

diff --git a/o2ims/views/api_ns.py b/o2ims/views/api_ns.py
index e1fad44..b52c3e9 100644 (file)
--- a/o2ims/views/api_ns.py
+++ b/o2ims/views/api_ns.py
@@ -19,15 +19,15 @@ from o2common.views.route import O2Namespace
 
 
 api_ims_inventory = O2Namespace(
-    "O2IMS_Inventory",
-    description='IMS Inventory related operations.')
+    "O2IMS-InfrastructureInventory",
+    description='O2 IMS Inventory related operations.')
 
 api_provision_v1 = O2Namespace(
     "PROVISION",
     description='Provision related operations.')
 
 api_ims_monitoring = O2Namespace(
-    "O2IMS_InfrastructureMonitoring",
+    "O2IMS-InfrastructureMonitoring",
     description='O2 IMS Monitoring related operations.')
 
 

diff --git a/o2ims/views/ocloud_dto.py b/o2ims/views/ocloud_dto.py
index 078064b..26f9d10 100644 (file)
--- a/o2ims/views/ocloud_dto.py
+++ b/o2ims/views/ocloud_dto.py
@@ -23,12 +23,30 @@ class OcloudDTO:
     ocloud = api_ims_inventory_v1.model(
         "OcloudDto",
         {
-            'oCloudId': fields.String(required=True),
-            'globalCloudId': fields.String,
-            'globalcloudId': fields.String(attribute='globalCloudId'),
-            'name': fields.String,
-            'description': fields.String,
-            'serviceUri': fields.String(attribute='serviceUri'),
+            'oCloudId': fields.String(
+                required=True,
+                example='f078a1d3-56df-46c2-88a2-dd659aa3f6bd',
+                description='Identifier for the containing O-Cloud.'),
+            'globalCloudId': fields.String(
+                example='10a07219-4201-4b3e-a52d-81ab6a755d8a',
+                description='Identifier of the O-Cloud instance. ' +
+                'Globally unique across O-Cloud instances.'),
+            'globalcloudId': fields.String(
+                attribute='globalCloudId',
+                example='10a07219-4201-4b3e-a52d-81ab6a755d8a',
+                description='Identifier of the O-Cloud instance. ' +
+                'Globally unique across O-Cloud instances.(Specification)'),
+            'name': fields.String(
+                example='95b818b8-b315-4d9f-af37-b82c492101f1',
+                description='Human readable name of the O-Cloud.'),
+            'description': fields.String(
+                example='An ocloud',
+                description='Human readable description of the O-Cloud.'),
+            'serviceUri': fields.String(
+                attribute='serviceUri',
+                example='https://128.224.115.51:30205',
+                description='The fully qualified URI root to all ' +
+                'services provided by the O2ims interface'),
             # 'infrastructureManagementServiceEndpoint': fields.String(
             # attribute='serviceUri'),
             # 'infrastructureMangementServiceEndPoint': fields.String(
@@ -37,7 +55,11 @@ class OcloudDTO:
             # 'resourcePools': fields.String,
             # 'deploymentManagers': fields.String,
             # 'smoRegistrationService': fields.String
-            'extensions': fields.String
+            'extensions': fields.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.'),
         },
         mask='{oCloudId,globalCloudId,globalcloudId,name,description,' +\
         'serviceUri}'
@@ -101,15 +123,35 @@ class ResourcePoolDTO:
     resource_pool_get = api_ims_inventory_v1.model(
         "ResourcePoolGetDto",
         {
-            'resourcePoolId': fields.String(required=True,
-                                            description='Resource pool ID'),
-            'globalLocationId': fields.String,
-            'name': fields.String,
-            'description': fields.String,
-            'oCloudId': fields.String,
-            'location': fields.String,
+            'resourcePoolId': fields.String(
+                required=True,
+                example='f078a1d3-56df-46c2-88a2-dd659aa3f6bd',
+                description='Identifier for the Resource Pool in the ' +
+                'O-Cloud instance.'),
+            'globalLocationId': fields.String(
+                example='',
+                description='This identifier is copied from the O-Cloud ' +
+                'Id assigned by the SMO during the O-Cloud deployment.'),
+            'name': fields.String(
+                example='RegionOne',
+                description='Human readable name of the resource pool.'),
+            'description': fields.String(
+                example='A Resource Pool',
+                description='Human readable description of the ' +
+                'resource pool.'),
+            'oCloudId': fields.String(
+                example='f078a1d3-56df-46c2-88a2-dd659aa3f6bd',
+                description='Identifier for the containing O-Cloud.'),
+            'location': fields.String(
+                example='',
+                description='Information about the geographical ' +
+                'location of the resource pool as detected by the O-Cloud.'),
             # 'resources': fields.String,
-            'extensions': fields.String
+            'extensions': fields.String(
+                example='',
+                description='List of metadata key-value pairs ' +\
+                'used to associate meaningful metadata to ' +\
+                'the related resource pool.')
         },
         mask='{resourcePoolId,oCloudId,globalLocationId,name,description}'
     )