X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=cps-ncmp-rest%2Fdocs%2Fopenapi%2Fcomponents.yaml;h=be5164375c7c0c32c11638a4affe9465d208dea6;hb=a01f8861a84931f4bdf2d69fa05a793afabc22e0;hp=7fc1063a1273f9ba2b5534d029bf9c6dfa8c3169;hpb=a4cfede5bac589107ab81968f1d3a88c11a464d2;p=cps.git diff --git a/cps-ncmp-rest/docs/openapi/components.yaml b/cps-ncmp-rest/docs/openapi/components.yaml index 7fc1063a1..be5164375 100644 --- a/cps-ncmp-rest/docs/openapi/components.yaml +++ b/cps-ncmp-rest/docs/openapi/components.yaml @@ -38,7 +38,7 @@ components: properties: message: type: string - example: "Bad Gateway Error Message NCMP" + example: 'Bad Gateway Error Message NCMP' dmi-response: type: object properties: @@ -127,6 +127,9 @@ components: $ref: '#/components/schemas/RestCmHandleProperties' publicCmHandleProperties: $ref: '#/components/schemas/RestCmHandleProperties' + moduleSetTag: + type: string + example: "my-module-set-tag" RestCmHandleProperties: type: object additionalProperties: @@ -160,11 +163,11 @@ components: example: | module stores { yang-version 1.1; - namespace "org:onap:ccsdk:sample"; + namespace 'org:onap:ccsdk:sample'; prefix book-store; - revision "2020-09-15" { + revision '2020-09-15' { description - "Sample Model"; + 'Sample Model'; } } @@ -175,13 +178,11 @@ components: cmHandleQueryParameters: type: array items: - type: object $ref: '#/components/schemas/ConditionProperties' conditions: deprecated: true type: array items: - type: object $ref: '#/components/schemas/OldConditionProperties' description: not necessary, it is just for backward compatibility @@ -203,7 +204,6 @@ components: conditionParameters: type: array items: - type: object $ref: '#/components/schemas/ModuleNameAsJsonObject' ModuleNameAsJsonObject: properties: @@ -223,12 +223,12 @@ components: state: $ref: '#/components/schemas/CmHandleCompositeState' CmHandlePublicProperties: - type: array + type: object items: - type: object - additionalProperties: - type: string - example: Book Type + type: object + additionalProperties: + type: string + example: 'Book Type' CmHandleCompositeState: type: object properties: @@ -285,6 +285,42 @@ components: properties: state: $ref: '#/components/schemas/CmHandleCompositeState' + # Data Operation Request Schemas + DataOperationRequest: + type: object + title: execute data operation for given array of operations + properties: + operations: + type: array + items: + $ref: '#/components/schemas/DataOperationDefinition' + description: contains group of data operation requests + DataOperationDefinition: + required: + - operation + - datastore + - operationId + properties: + operation: + type: string + example: 'read' + operationId: + type: string + example: '12' + datastore: + type: string + example: 'ncmp-datastore:passthrough-operational' + options: + type: string + example: '(fields=schemas/schema)' + resourceIdentifier: + type: string + example: 'parent/child' + targetIds: + type: array + items: + type: string + example: [ "da310eecdb8d44c2acc0ddaae01174b1","c748c58f8e0b438f9fd1f28370b17d47" ] examples: dataSampleRequest: