summaryrefslogtreecommitdiffstats
path: root/cps-ncmp-rest/docs/openapi/ncmp-inventory.yml
blob: 0a408c2413d5b405e8a03784fbf9550cf9f4cfd0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
#  ============LICENSE_START=======================================================
#  Copyright (C) 2021 Bell Canada
#  Modifications Copyright (C) 2021-2022 Nordix Foundation
#  ================================================================================
#  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:
      200:
        $ref: 'components.yaml#/components/responses/NoContent'
      400:
        $ref: 'components.yaml#/components/responses/BadRequest'
      401:
        $ref: 'components.yaml#/components/responses/Unauthorized'
      403:
        $ref: 'components.yaml#/components/responses/Forbidden'
      500:
        description: Partial or Complete failure. The error details are provided in the response body and all supported error codes are documented in the example.
        content:
          application/json:
            schema:
              $ref: 'components.yaml#/components/schemas/DmiPluginRegistrationErrorResponse'
            example:
              failedCreatedCmHandles: [
                {
                  "cmHandle": "my-cm-handle-01",
                  "errorCode": "00",
                  "errorText": "Unknown error. <error-details>"
                },
                {
                  "cmHandle": "my-cm-handle-02",
                  "errorCode": "01",
                  "errorText": "cm-handle already exists"
                },
                {
                  "cmHandle": "my-cm-handle-03",
                  "errorCode": "03",
                  "errorText": "cm-handle has an invalid character(s) in id"
                }
              ]
              failedUpdatedCmHandles: [
                {
                  "cmHandle": "my-cm-handle-01",
                  "errorCode": "00",
                  "errorText": "Unknown error. <error-details>"
                },
                {
                  "cmHandle": "my-cm-handle-02",
                  "errorCode": "02",
                  "errorText": "cm-handle does not exist"
                },
                {
                  "cmHandle": "my-cm-handle-03",
                  "errorCode": "03",
                  "errorText": "cm-handle has an invalid character(s) in id"
                }
              ]
              failedRemovedCmHandles: [
                {
                  "cmHandle": "my-cm-handle-01",
                  "errorCode": "00",
                  "errorText": "Unknown error. <error-details>"
                },
                {
                  "cmHandle": "my-cm-handle-02",
                  "errorCode": "02",
                  "errorText": "cm-handle does not exists"
                },
                {
                  "cmHandle": "my-cm-handle-03",
                  "errorCode": "03",
                  "errorText": "cm-handle has an invalid character(s) in id"
                }
              ]