Code Review
/
cps.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
review
|
tree
raw
|
inline
| side by side
Support 'public' Cm Handle Properties
[cps.git]
/
docs
/
api
/
swagger
/
ncmp
/
openapi-inventory.yaml
diff --git
a/docs/api/swagger/ncmp/openapi-inventory.yaml
b/docs/api/swagger/ncmp/openapi-inventory.yaml
index
c4b6f4b
..
67eae41
100644
(file)
--- a/
docs/api/swagger/ncmp/openapi-inventory.yaml
+++ b/
docs/api/swagger/ncmp/openapi-inventory.yaml
@@
-4,12
+4,12
@@
info:
description: NCMP Inventory API
version: "1.0"
servers:
description: NCMP Inventory API
version: "1.0"
servers:
-
- url: /ncmpInventory
+- url: /ncmpInventory
paths:
/v1/ch:
post:
tags:
paths:
/v1/ch:
post:
tags:
-
- network-cm-proxy-inventory
+ - network-cm-proxy-inventory
summary: DMI notifies NCMP of new CM Handles
description: "Register a DMI Plugin with any new, updated or removed CM Handles."
operationId: updateDmiPluginRegistration
summary: DMI notifies NCMP of new CM Handles
description: "Register a DMI Plugin with any new, updated or removed CM Handles."
operationId: updateDmiPluginRegistration
@@
-29,18
+29,30
@@
paths:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
+ example:
+ status: 400 BAD_REQUEST
+ message: Bad request error message
+ details: Bad request error details
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
+ example:
+ status: 401
+ message: Unauthorized error message
+ details: Unauthorized error details
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
+ example:
+ status: 403
+ message: Forbidden error message
+ details: Forbidden error details
components:
schemas:
RestDmiPluginRegistration:
components:
schemas:
RestDmiPluginRegistration:
@@
-48,7
+60,13
@@
components:
properties:
dmiPlugin:
type: string
properties:
dmiPlugin:
type: string
- example: onap-dmi-plugin
+ example: my-dmi-plugin
+ dmiDataPlugin:
+ type: string
+ example: my-dmi-data-plugin
+ dmiModelPlugin:
+ type: string
+ example: my-dmi-model-plugin
createdCmHandles:
type: array
items:
createdCmHandles:
type: array
items:
@@
-61,21
+79,24
@@
components:
type: array
items:
type: string
type: array
items:
type: string
+ example: "[\"my-cm-handle1\",\"my-cm-handle2\",\"my-cm-handle3\"]"
RestCmHandle:
required:
RestCmHandle:
required:
-
- cmHandle
+ - cmHandle
type: object
properties:
cmHandle:
type: string
type: object
properties:
cmHandle:
type: string
- example:
cmHandle123
+ example:
my-cm-handle
cmHandleProperties:
cmHandleProperties:
- $ref: '#/components/schemas/RestCmHandleAdditionalProperties'
- RestCmHandleAdditionalProperties:
+ $ref: '#/components/schemas/RestCmHandleProperties'
+ publicCmHandleProperties:
+ $ref: '#/components/schemas/RestCmHandleProperties'
+ RestCmHandleProperties:
type: object
additionalProperties:
type: string
type: object
additionalProperties:
type: string
- example:
system-001
+ example:
my-property
ErrorMessage:
title: Error
type: object
ErrorMessage:
title: Error
type: object