Gitiles
Code Review Sign In
gerrit.nordix.org / onap / cps / ebfa4077b2e462237301e93566fed6ef2f56674c / . / docs / api / swagger / ncmp / openapi-inventory.yaml
blob: 67eae41c468d25fd7deaa3f91595f33ae7d4026c [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:
23 "201":
24 description: Created
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
niamhcorec1904c12021-10-11 16:38:53 +0100[diff] [blame]56components:
57 schemas:
58 RestDmiPluginRegistration:
59 type: object
60 properties:
61 dmiPlugin:
62 type: string
DylanB95EST63132ce2021-12-14 16:34:38 +0000[diff] [blame]63 example: my-dmi-plugin
64 dmiDataPlugin:
65 type: string
66 example: my-dmi-data-plugin
67 dmiModelPlugin:
68 type: string
69 example: my-dmi-model-plugin
niamhcorec1904c12021-10-11 16:38:53 +0100[diff] [blame]70 createdCmHandles:
71 type: array
72 items:
73 $ref: '#/components/schemas/RestCmHandle'
74 updatedCmHandles:
75 type: array
76 items:
77 $ref: '#/components/schemas/RestCmHandle'
78 removedCmHandles:
79 type: array
80 items:
81 type: string
DylanB95EST63132ce2021-12-14 16:34:38 +0000[diff] [blame]82 example: "[\"my-cm-handle1\",\"my-cm-handle2\",\"my-cm-handle3\"]"
niamhcorec1904c12021-10-11 16:38:53 +0100[diff] [blame]83 RestCmHandle:
84 required:
DylanB95EST63132ce2021-12-14 16:34:38 +0000[diff] [blame]85 - cmHandle
niamhcorec1904c12021-10-11 16:38:53 +0100[diff] [blame]86 type: object
87 properties:
88 cmHandle:
89 type: string
DylanB95EST63132ce2021-12-14 16:34:38 +0000[diff] [blame]90 example: my-cm-handle
niamhcorec1904c12021-10-11 16:38:53 +0100[diff] [blame]91 cmHandleProperties:
DylanB95EST63132ce2021-12-14 16:34:38 +0000[diff] [blame]92 $ref: '#/components/schemas/RestCmHandleProperties'
93 publicCmHandleProperties:
94 $ref: '#/components/schemas/RestCmHandleProperties'
95 RestCmHandleProperties:
niamhcorec1904c12021-10-11 16:38:53 +0100[diff] [blame]96 type: object
97 additionalProperties:
98 type: string
DylanB95EST63132ce2021-12-14 16:34:38 +0000[diff] [blame]99 example: my-property
niamhcorec1904c12021-10-11 16:38:53 +0100[diff] [blame]100 ErrorMessage:
101 title: Error
102 type: object
103 properties:
104 status:
105 type: string
106 message:
107 type: string
108 details:
109 type: string