aboutsummaryrefslogtreecommitdiffstats
path: root/cps-ncmp-rest/docs/openapi/ncmp-inventory.yml
diff options
context:
space:
mode:
authorRenu Kumari <renu.kumari@bell.ca>2021-10-04 20:59:18 -0400
committerRenu Kumari <renu.kumari@bell.ca>2021-10-07 14:05:22 -0400
commit139e8221933f4d72149601900b421921263e2ba3 (patch)
tree8080bab2ab0d0317a8b050c7f40cb066cf251ead /cps-ncmp-rest/docs/openapi/ncmp-inventory.yml
parentabdff1bf331cc582d017cce9888828fa2e8f6260 (diff)
Separate ncmp south-bound endpoints in openapi specs
- existing ncmp-cps swagger ui shows only northbound endpoints - added cps-ncmp-internal for southbound endpoints Issue-ID: CPS-722 Signed-off-by: Renu Kumari <renu.kumari@bell.ca> Change-Id: I6917a9c1cf6d033f7ed76f2172113d5e43ac84a7
Diffstat (limited to 'cps-ncmp-rest/docs/openapi/ncmp-inventory.yml')
-rwxr-xr-xcps-ncmp-rest/docs/openapi/ncmp-inventory.yml40
1 files changed, 40 insertions, 0 deletions
diff --git a/cps-ncmp-rest/docs/openapi/ncmp-inventory.yml b/cps-ncmp-rest/docs/openapi/ncmp-inventory.yml
new file mode 100755
index 000000000..b0a50aa83
--- /dev/null
+++ b/cps-ncmp-rest/docs/openapi/ncmp-inventory.yml
@@ -0,0 +1,40 @@
+# ============LICENSE_START=======================================================
+# Copyright (C) 2021 Bell Canada
+# ================================================================================
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# ============LICENSE_END=========================================================
+
+updateDmiRegistration:
+ post:
+ description: Register a DMI Plugin with any new, updated or removed CM Handles.
+ tags:
+ - network-cm-proxy-inventory
+ summary: DMI notifies NCMP of new CM Handles
+ operationId: updateDmiPluginRegistration
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: 'components.yaml#/components/schemas/RestDmiPluginRegistration'
+ responses:
+ 201:
+ $ref: 'components.yaml#/components/responses/Created'
+ 400:
+ $ref: 'components.yaml#/components/responses/BadRequest'
+ 401:
+ $ref: 'components.yaml#/components/responses/Unauthorized'
+ 403:
+ $ref: 'components.yaml#/components/responses/Forbidden'