diff options
author | 2025-02-28 15:58:04 +0000 | |
---|---|---|
committer | 2025-03-03 11:35:58 +0000 | |
commit | 4b6efbbe9fa905a3ee4bc6e7ae5ced2ddd079fb8 (patch) | |
tree | 5778fa096ef75f3c4cec5bddcf23730ba4cbeddc /docs/schemas/ncmp/async-m2m/data-operation-event-schema-1.0.0.json | |
parent | b0269d5b66bc668f3e4b10f181bd290ddbac680f (diff) |
RTD update related to event schemas
- moving the event schemas file to corresponding folder in the docs
folder as it is in the cps-ncmp-events
- the files are updated as per the new event data schemas
Issue-ID: CPS-2645
Change-Id: Ibcc9b504c6db8a3556773eeaadebcf02f1a3bb96
Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
Diffstat (limited to 'docs/schemas/ncmp/async-m2m/data-operation-event-schema-1.0.0.json')
-rw-r--r-- | docs/schemas/ncmp/async-m2m/data-operation-event-schema-1.0.0.json | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/docs/schemas/ncmp/async-m2m/data-operation-event-schema-1.0.0.json b/docs/schemas/ncmp/async-m2m/data-operation-event-schema-1.0.0.json new file mode 100644 index 0000000000..c2915187c7 --- /dev/null +++ b/docs/schemas/ncmp/async-m2m/data-operation-event-schema-1.0.0.json @@ -0,0 +1,77 @@ +{ + "$schema": "https://json-schema.org/draft/2019-09/schema", + "$id": "urn:cps:org.onap.cps.ncmp.events.async:data-operation-event-schema:1.0.0", + "$ref": "#/definitions/DataOperationEvent", + "definitions": { + "DataOperationEvent": { + "description": "The payload of data operation event.", + "type": "object", + "javaType" : "org.onap.cps.ncmp.events.async1_0_0.DataOperationEvent", + "properties": { + "data": { + "description": "The payload content of the requested data.", + "type": "object", + "properties": { + "responses": { + "description": "An array of batch responses which contains both success and failure", + "type": "array", + "items": { + "type": "object", + "properties": { + "operationId": { + "description": "Used to distinguish multiple operations using same handle ids", + "type": "string" + }, + "ids": { + "description": "Id's of the cmhandles", + "type": "array", + "items": { + "type": "string" + } + }, + "resourceIdentifier": { + "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.", + "type": "string" + }, + "options": { + "description": "It is mandatory to add as key(s)=value(s)'. The format of options parameter depend on the associated DMI Plugin implementation.", + "type": "string" + }, + "statusCode": { + "description": "which says success or failure (0-99) are for success and (100-199) are for failure", + "type": "string" + }, + "statusMessage": { + "description": "Human readable message, Which says what the response has", + "type": "string" + }, + "result": { + "description": "Contains the requested data response.", + "type": "object", + "existingJavaType": "java.lang.Object", + "additionalProperties": false + } + }, + "required": [ + "operationId", + "ids", + "statusCode", + "statusMessage" + ], + "additionalProperties": false + } + } + }, + "required": [ + "responses" + ], + "additionalProperties": false + } + }, + "required": [ + "data" + ], + "additionalProperties": false + } + } +}
\ No newline at end of file |