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

Signed-off-by: Zhang Rong(Jon) <rong.zhang@windriver.com>
Change-Id: I5400dffcc308a9b4523d5332281d712d555d250b

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 4dcd037..a138025 100644 (file)
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -1,13 +1,13 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. SPDX-License-Identifier: CC-BY-4.0
-.. Copyright (C) 2021-2022 Wind River Systems, Inc.
+.. Copyright (C) 2021-2023 Wind River Systems, Inc.
 
 
 Release-notes
 =============
 
 
-This document provides the release notes for 2.0.1 of INF O2 service.
+This document provides the release notes for 2.0.2 of INF O2 service.
 
 .. contents::
    :depth: 3
@@ -20,6 +20,8 @@ Version History
 +------------+----------+----------------------------------------------+-------------+
 | **Date**   | **Ver.** | **Author**                                   | **Comment** |
 +------------+----------+----------------------------------------------+-------------+
+| 2023-06-15 | 2.0.2    | Jon Zhang, Jackie Huang                      | H Release   |
++------------+----------+----------------------------------------------+-------------+
 | 2022-12-15 | 2.0.1    | Bin Yang, Jon Zhang, Jackie Huang, David Liu | G Release   |
 +------------+----------+----------------------------------------------+-------------+
 | 2022-06-15 | 1.0.1    | Bin Yang, Jon Zhang                          | F Release   |
@@ -27,6 +29,29 @@ Version History
 | 2021-12-15 | 1.0.0    | Bin Yang, Jon Zhang                          | E Release   |
 +------------+----------+----------------------------------------------+-------------+
 
+Version 2.0.2, 2023-06-15
+-------------------------
+
+-  Upgrade Inventory API
+
+   -  Support capabilities attribute of the DMS query to support the
+      PlugFest with SMO integration
+
+-  Update the Subscription and Notification part
+
+   -  Adding the oAuth2 configuration for the O2 service query the SMO
+   -  Registration and notification to SMO support oAuth2 verification
+   -  Rewrite the subscription filter part
+
+-  Specification compliance
+
+   -  Compliance to "O-RAN.WG6.O2IMS-INTERFACE-R003-v04.00"
+   -  Adding InfrastructureInventoryObject abstract class
+
+-  Other updates
+
+   -  Bugs fixed
+
 Version 2.0.1, 2022-12-15
 -------------------------
 
@@ -59,8 +84,8 @@ Version 2.0.1, 2022-12-15
 
    -  Add configuration file load at application starts
    -  Fix bugs
-   -  Replace POC O2DMS APIs with Kubernetes Native API Profile 
-      for Containerized NFs
+   -  Replace POC O2DMS APIs with Kubernetes Native API Profile for
+      Containerized NFs
 
 Version 1.0.1, 2022-06-15
 -------------------------
@@ -72,8 +97,10 @@ Version 1.0.1, 2022-06-15
 
 -  Add O2 DMS profiles
 
-   -  Support native_k8sapi profile that can get native Kubernetes API information
-   -  Support SOL018 specification, it includes native Kubernetes API profile and Helm CLI profile, "sol018", and "sol018_helmcli"
+   -  Support native_k8sapi profile that can get native Kubernetes API
+      information
+   -  Support SOL018 specification, it includes native Kubernetes API
+      profile and Helm CLI profile, "sol018", and "sol018_helmcli"
 
 Version 1.0.0, 2021-12-15
 -------------------------

diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
index 28c9f92..b57111a 100644 (file)
--- a/docs/requirements-docs.txt
+++ b/docs/requirements-docs.txt
@@ -8,4 +8,5 @@ sphinxcontrib-swaggerdoc
 sphinx_bootstrap_theme
 sphinx_rtd_theme
 recommonmark
-lfdocs-conf
\ No newline at end of file
+lfdocs-conf
+urllib3~=1.26.15
\ No newline at end of file

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

diff --git a/docs/swagger.yaml b/docs/swagger.yaml
index 485b6c4..4804c89 100755 (executable)
--- a/docs/swagger.yaml
+++ b/docs/swagger.yaml
@@ -1188,7 +1188,9 @@ definitions:
       serviceUri:
         type: string
         example: https://128.224.115.51:6443
-        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.
+      capabilities:
+        $ref: '#/definitions/DeploymentManagerCapabilities'
       profileSupportList:
         type: array
         example:
@@ -1201,6 +1203,13 @@ definitions:
         example: ""
         description: List of metadata key-value pairs used to associate meaningful metadata to the related Deployment Manager
     x-mask: "{deploymentManagerId,name,description,oCloudId,serviceUri,profileSupportList}"
+  DeploymentManagerCapabilities:
+    type: object
+    properties:
+      OS:
+        type: string
+        example: low_latency
+        description: Show the OS capablities of the Deployment Manager
   DeploymentManagerGetDto:
     type: object
     required:
@@ -1225,10 +1234,12 @@ definitions:
       serviceUri:
         type: string
         example: https://128.224.115.51:6443
-        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.
+      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}}"
   DeploymentManagerExtensions:
     type: object
     properties:

diff --git a/tox.ini b/tox.ini
index 1b6cb1c..5be820d 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -56,7 +56,7 @@ commands =
 
     echo "Generated docs available in {toxinidir}/docs/_build/html"
 
-whitelist_externals = echo
+allowlist_externals = echo
 
 [testenv:docs-linkcheck]
 basepython = python3