Gitiles
Code Review Sign In
gerrit.nordix.org / onap / cps / e557338803286d8aaa0f877aa25d52d18735f309 / . / docs / api / swagger / ncmp / openapi-inventory.yaml
blob: 154a4411da7bdddade5fe34d155c2764c996cefd [file] [log] [blame]
niamhcorec1904c12021-10-11 16:38:53 +0100[diff] [blame]1openapi: 3.0.1
2info:
3 title: NCMP Inventory API
4 description: NCMP Inventory API
5 version: "1.0"
6servers:
DylanB95EST63132ce2021-12-14 16:34:38 +0000[diff] [blame]7- url: /ncmpInventory
niamhcorec1904c12021-10-11 16:38:53 +0100[diff] [blame]8paths:
9 /v1/ch:
10 post:
11 tags:
DylanB95EST63132ce2021-12-14 16:34:38 +0000[diff] [blame]12 - network-cm-proxy-inventory
niamhcorec1904c12021-10-11 16:38:53 +0100[diff] [blame]13 summary: DMI notifies NCMP of new CM Handles
14 description: "Register a DMI Plugin with any new, updated or removed CM Handles."
15 operationId: updateDmiPluginRegistration
16 requestBody:
17 content:
18 application/json:
19 schema:
20 $ref: '#/components/schemas/RestDmiPluginRegistration'
21 required: true
22 responses:
mpriyank80dee972022-02-23 15:17:23 +0530[diff] [blame]23 "204":
24 description: No Content
niamhcorec1904c12021-10-11 16:38:53 +0100[diff] [blame]25 content: {}
26 "400":
27 description: Bad Request
28 content:
29 application/json:
30 schema:
31 $ref: '#/components/schemas/ErrorMessage'
DylanB95EST63132ce2021-12-14 16:34:38 +0000[diff] [blame]32 example:
33 status: 400 BAD_REQUEST
34 message: Bad request error message
35 details: Bad request error details
niamhcorec1904c12021-10-11 16:38:53 +0100[diff] [blame]36 "401":
37 description: Unauthorized
38 content:
39 application/json:
40 schema:
41 $ref: '#/components/schemas/ErrorMessage'
DylanB95EST63132ce2021-12-14 16:34:38 +0000[diff] [blame]42 example:
43 status: 401
44 message: Unauthorized error message
45 details: Unauthorized error details
niamhcorec1904c12021-10-11 16:38:53 +0100[diff] [blame]46 "403":
47 description: Forbidden
48 content:
49 application/json:
50 schema:
51 $ref: '#/components/schemas/ErrorMessage'
DylanB95EST63132ce2021-12-14 16:34:38 +0000[diff] [blame]52 example:
53 status: 403
54 message: Forbidden error message
55 details: Forbidden error details
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame^]56 "500":
57 description: Internal Server Error
58 content:
59 application/json:
60 schema:
61 $ref: '#/components/schemas/ErrorMessage'
62 example:
63 status: 500
64 message: Internal Server Error
65 details: Internal Server Error occurred
niamhcorec1904c12021-10-11 16:38:53 +0100[diff] [blame]66components:
67 schemas:
68 RestDmiPluginRegistration:
69 type: object
70 properties:
71 dmiPlugin:
72 type: string
DylanB95EST63132ce2021-12-14 16:34:38 +0000[diff] [blame]73 example: my-dmi-plugin
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame^]74 default: ""
DylanB95EST63132ce2021-12-14 16:34:38 +0000[diff] [blame]75 dmiDataPlugin:
76 type: string
77 example: my-dmi-data-plugin
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame^]78 default: ""
DylanB95EST63132ce2021-12-14 16:34:38 +0000[diff] [blame]79 dmiModelPlugin:
80 type: string
81 example: my-dmi-model-plugin
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame^]82 default: ""
niamhcorec1904c12021-10-11 16:38:53 +0100[diff] [blame]83 createdCmHandles:
84 type: array
85 items:
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame^]86 $ref: '#/components/schemas/RestInputCmHandle'
niamhcorec1904c12021-10-11 16:38:53 +0100[diff] [blame]87 updatedCmHandles:
88 type: array
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame^]89 example:
90 cmHandle: my-cm-handle
91 cmHandleProperties:
92 add-my-property: add-property
93 update-my-property: updated-property
94 delete-my-property: ~
95 publicCmHandleProperties:
96 add-my-property: add-property
97 update-my-property: updated-property
98 delete-my-property: ~
niamhcorec1904c12021-10-11 16:38:53 +0100[diff] [blame]99 items:
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame^]100 $ref: '#/components/schemas/RestInputCmHandle'
niamhcorec1904c12021-10-11 16:38:53 +0100[diff] [blame]101 removedCmHandles:
102 type: array
103 items:
104 type: string
DylanB95EST63132ce2021-12-14 16:34:38 +0000[diff] [blame]105 example: "[\"my-cm-handle1\",\"my-cm-handle2\",\"my-cm-handle3\"]"
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame^]106 RestInputCmHandle:
niamhcorec1904c12021-10-11 16:38:53 +0100[diff] [blame]107 required:
DylanB95EST63132ce2021-12-14 16:34:38 +0000[diff] [blame]108 - cmHandle
niamhcorec1904c12021-10-11 16:38:53 +0100[diff] [blame]109 type: object
110 properties:
111 cmHandle:
112 type: string
DylanB95EST63132ce2021-12-14 16:34:38 +0000[diff] [blame]113 example: my-cm-handle
niamhcorec1904c12021-10-11 16:38:53 +0100[diff] [blame]114 cmHandleProperties:
DylanB95EST63132ce2021-12-14 16:34:38 +0000[diff] [blame]115 $ref: '#/components/schemas/RestCmHandleProperties'
116 publicCmHandleProperties:
117 $ref: '#/components/schemas/RestCmHandleProperties'
118 RestCmHandleProperties:
niamhcorec1904c12021-10-11 16:38:53 +0100[diff] [blame]119 type: object
120 additionalProperties:
121 type: string
DylanB95EST63132ce2021-12-14 16:34:38 +0000[diff] [blame]122 example: my-property
niamhcorec1904c12021-10-11 16:38:53 +0100[diff] [blame]123 ErrorMessage:
124 title: Error
125 type: object
126 properties:
127 status:
128 type: string
129 message:
130 type: string
131 details:
132 type: string