schema:
example: my-cm-handle
type: string
- - allowReserved: true
- description: The format of resource identifier depend on the associated DMI
+ - description: The format of resource identifier depend on the associated DMI
Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
it can really be anything.
examples:
content:
application/json:
example:
- status: 400 BAD_REQUEST
+ status: 400
message: Bad request error message
details: Bad request error details
schema:
schema:
example: my-cm-handle
type: string
- - allowReserved: true
- description: The format of resource identifier depend on the associated DMI
+ - description: The format of resource identifier depend on the associated DMI
Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
it can really be anything.
examples:
required: true
schema:
type: string
- - allowReserved: true
- description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
+ - description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
\ in parenthesis'()'. The format of options parameter depend on the associated\
\ DMI Plugin implementation."
examples:
required: false
schema:
type: string
- - allowReserved: true
- description: topic parameter in query.
+ - description: topic parameter in query.
examples:
sample 1:
value:
content:
application/json:
example:
- status: 400 BAD_REQUEST
+ status: 400
message: Bad request error message
details: Bad request error details
schema:
schema:
example: my-cm-handle
type: string
- - allowReserved: true
- description: The format of resource identifier depend on the associated DMI
+ - description: The format of resource identifier depend on the associated DMI
Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
it can really be anything.
examples:
content:
application/json:
example:
- status: 400 BAD_REQUEST
+ status: 400
message: Bad request error message
details: Bad request error details
schema:
schema:
example: my-cm-handle
type: string
- - allowReserved: true
- description: The format of resource identifier depend on the associated DMI
+ - description: The format of resource identifier depend on the associated DMI
Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
it can really be anything.
examples:
content:
application/json:
example:
- status: 400 BAD_REQUEST
+ status: 400
message: Bad request error message
details: Bad request error details
schema:
schema:
example: my-cm-handle
type: string
- - allowReserved: true
- description: The format of resource identifier depend on the associated DMI
+ - description: The format of resource identifier depend on the associated DMI
Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
it can really be anything.
examples:
content:
application/json:
example:
- status: 400 BAD_REQUEST
+ status: 400
message: Bad request error message
details: Bad request error details
schema:
post:
description: This request will be handled asynchronously using messaging to
the supplied topic. The rest response will be an acknowledge with a requestId
- to identify the relevant messages.
+ to identify the relevant messages. A maximum of 50 cm handles per operation
+ is supported.
operationId: executeDataOperationForCmHandles
parameters:
- - allowReserved: true
- description: mandatory topic parameter in query.
+ - description: mandatory topic parameter in query.
examples:
sample 1:
value:
content:
application/json:
example:
- status: 400 BAD_REQUEST
+ status: 400
message: Bad request error message
details: Bad request error details
schema:
schema:
$ref: '#/components/schemas/ErrorMessage'
description: Forbidden
+ "413":
+ content:
+ application/json:
+ example:
+ status: 413
+ message: Payload Too Large error message
+ details: Payload Too Large error details
+ schema:
+ $ref: '#/components/schemas/ErrorMessage'
+ description: The request is larger than the server is willing or able to
+ process
"500":
content:
application/json:
schema:
default: /
type: string
- - allowReserved: true
- description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
+ - description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
\ in parenthesis'()'. The format of options parameter depend on the associated\
\ DMI Plugin implementation."
examples:
required: false
schema:
type: string
- - allowReserved: true
- description: topic parameter in query.
+ - description: topic parameter in query.
examples:
sample 1:
value:
content:
application/json:
example:
- status: 400 BAD_REQUEST
+ status: 400
message: Bad request error message
details: Bad request error details
schema:
content:
application/json:
example:
- status: 400 BAD_REQUEST
+ status: 400
message: Bad request error message
details: Bad request error details
schema:
content:
application/json:
example:
- status: 400 BAD_REQUEST
+ status: 400
message: Bad request error message
details: Bad request error details
schema:
content:
application/json:
example:
- status: 400 BAD_REQUEST
+ status: 400
message: Bad request error message
details: Bad request error details
schema:
content:
application/json:
example:
- status: 400 BAD_REQUEST
+ status: 400
message: Bad request error message
details: Bad request error details
schema:
content:
application/json:
example:
- status: 400 BAD_REQUEST
+ status: 400
message: Bad request error message
details: Bad request error details
schema:
content:
application/json:
example:
- status: 400 BAD_REQUEST
+ status: 400
message: Bad request error message
details: Bad request error details
schema:
content:
application/json:
example:
- status: 400 BAD_REQUEST
+ status: 400
message: Bad request error message
details: Bad request error details
schema:
example: my-cm-handle
type: string
resourceIdentifierInQuery:
- allowReserved: true
description: The format of resource identifier depend on the associated DMI
Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but it
can really be anything.
schema:
type: string
optionsParamInQuery:
- allowReserved: true
description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
\ in parenthesis'()'. The format of options parameter depend on the associated\
\ DMI Plugin implementation."
schema:
type: string
topicParamInQuery:
- allowReserved: true
description: topic parameter in query.
examples:
sample 1:
example: application/yang-data+json
type: string
requiredTopicParamInQuery:
- allowReserved: true
description: mandatory topic parameter in query.
examples:
sample 1:
content:
application/json:
example:
- status: 400 BAD_REQUEST
+ status: 400
message: Bad request error message
details: Bad request error details
schema:
schema:
$ref: '#/components/schemas/ErrorMessage'
description: The specified resource was not found
+ PayloadTooLarge:
+ content:
+ application/json:
+ example:
+ status: 413
+ message: Payload Too Large error message
+ details: Payload Too Large error details
+ schema:
+ $ref: '#/components/schemas/ErrorMessage'
+ description: The request is larger than the server is willing or able to process
schemas:
ErrorMessage:
properties:
type: string
targetIds:
items:
+ description: "targeted cm handles, maximum of 50 supported. If this limit\
+ \ is exceeded the request wil be refused."
example: "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\
]"
type: string
RestOutputCmHandle:
example:
cmHandle: my-cm-handle1
+ alternateId: my-alternate-id
+ dataProducerIdentifier: my-data-producer-identifier
publicCmHandleProperties:
- key: Book Type
- key: Book Type
details: locked due to failure in module sync
lastUpdateTime: 2022-12-31T20:30:40.000+0000
trustLevel: COMPLETE
+ moduleSetTag: my-module-set-tag
properties:
cmHandle:
example: my-cm-handle1
description: Current trust level of the relevant CM handle ID.
example: COMPLETE
type: string
+ moduleSetTag:
+ example: my-module-set-tag
+ type: string
+ alternateId:
+ example: my-alternate-id
+ type: string
+ dataProducerIdentifier:
+ example: my-data-producer-identifier
+ type: string
title: CM handle Details
type: object
CmHandlePublicProperties: