cps-ncmp-rest/docs/openapi/ncmp-inventory.yml

   1 #  ============LICENSE_START=======================================================
   2 #  Copyright (C) 2021 Bell Canada
   3 #  ================================================================================
   4 #  Licensed under the Apache License, Version 2.0 (the "License");
   5 #  you may not use this file except in compliance with the License.
   6 #  You may obtain a copy of the License at
   7 #
   8 #        http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 #  Unless required by applicable law or agreed to in writing, software
  11 #  distributed under the License is distributed on an "AS IS" BASIS,
  12 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 #  See the License for the specific language governing permissions and
  14 #  limitations under the License.
  15 #
  16 #  SPDX-License-Identifier: Apache-2.0
  17 #  ============LICENSE_END=========================================================
  18
  19 updateDmiRegistration:
  20   post:
  21     description: Register a DMI Plugin with any new, updated or removed CM Handles.
  22     tags:
  23       - network-cm-proxy-inventory
  24     summary: DMI notifies NCMP of new CM Handles
  25     operationId: updateDmiPluginRegistration
  26     requestBody:
  27       required: true
  28       content:
  29         application/json:
  30           schema:
  31             $ref: 'components.yaml#/components/schemas/RestDmiPluginRegistration'
  32     responses:
  33       201:
  34         $ref: 'components.yaml#/components/responses/Created'
  35       400:
  36         $ref: 'components.yaml#/components/responses/BadRequest'
  37       401:
  38         $ref: 'components.yaml#/components/responses/Unauthorized'
  39       403:
  40         $ref: 'components.yaml#/components/responses/Forbidden'