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

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