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         description: Partial or Complete failure. The error details are provided in the response body and all supported error codes are documented in the example.
  44         content:
  45           application/json:
  46             schema:
  47               $ref: 'components.yaml#/components/schemas/DmiPluginRegistrationErrorResponse'
  48             example:
  49               failedCreatedCmHandles: [
  50                 {
  51                   "cmHandle": "my-cm-handle-01",
  52                   "errorCode": "00",
  53                   "errorText": "Unknown error. <error-details>"
  54                 },
  55                 {
  56                   "cmHandle": "my-cm-handle-02",
  57                   "errorCode": "01",
  58                   "errorText": "cm-handle already exists"
  59                 },
  60                 {
  61                   "cmHandle": "my-cm-handle-03",
  62                   "errorCode": "03",
  63                   "errorText": "cm-handle has an invalid character(s) in id"
  64                 }
  65               ]
  66               failedUpdatedCmHandles: [
  67                 {
  68                   "cmHandle": "my-cm-handle-01",
  69                   "errorCode": "00",
  70                   "errorText": "Unknown error. <error-details>"
  71                 },
  72                 {
  73                   "cmHandle": "my-cm-handle-02",
  74                   "errorCode": "02",
  75                   "errorText": "cm-handle does not exist"
  76                 },
  77                 {
  78                   "cmHandle": "my-cm-handle-03",
  79                   "errorCode": "03",
  80                   "errorText": "cm-handle has an invalid character(s) in id"
  81                 }
  82               ]
  83               failedRemovedCmHandles: [
  84                 {
  85                   "cmHandle": "my-cm-handle-01",
  86                   "errorCode": "00",
  87                   "errorText": "Unknown error. <error-details>"
  88                 },
  89                 {
  90                   "cmHandle": "my-cm-handle-02",
  91                   "errorCode": "02",
  92                   "errorText": "cm-handle does not exists"
  93                 },
  94                 {
  95                   "cmHandle": "my-cm-handle-03",
  96                   "errorCode": "03",
  97                   "errorText": "cm-handle has an invalid character(s) in id"
  98                 }
  99               ]