X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=cps-ncmp-rest%2Fdocs%2Fopenapi%2Fcomponents.yaml;h=9b5a1fd0ba48c45171dc15a17e3d937003a7104c;hb=f41dd3b24da2cc956c3d6e27fc14e409f11c65c0;hp=14fd4d24d34417e528401ea9bef6d46ef2c1aa7d;hpb=7a75eea4e388a04d8b67610ef53ed16db75489e6;p=cps.git diff --git a/cps-ncmp-rest/docs/openapi/components.yaml b/cps-ncmp-rest/docs/openapi/components.yaml index 14fd4d24d..9b5a1fd0b 100644 --- a/cps-ncmp-rest/docs/openapi/components.yaml +++ b/cps-ncmp-rest/docs/openapi/components.yaml @@ -1,5 +1,5 @@ # ============LICENSE_START======================================================= -# Copyright (C) 2021-2022 Nordix Foundation +# Copyright (C) 2021-2023 Nordix Foundation # Modifications Copyright (C) 2021 Pantheon.tech # Modifications Copyright (C) 2022 Bell Canada # ================================================================================ @@ -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: @@ -86,7 +86,9 @@ components: type: array items: type: string - example: [my-cm-handle1, my-cm-handle2, my-cm-handle3] + example: [ my-cm-handle1, my-cm-handle2, my-cm-handle3 ] + upgradedCmHandles: + $ref: '#/components/schemas/UpgradedCmHandles' DmiPluginRegistrationErrorResponse: type: object properties: @@ -102,6 +104,10 @@ components: type: array items: $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse' + failedUpgradeCmHandles: + type: array + items: + $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse' CmHandlerRegistrationErrorResponse: type: object properties: @@ -124,14 +130,35 @@ components: type: string example: my-cm-handle cmHandleProperties: - $ref: '#/components/schemas/RestCmHandleProperties' + $ref: '#/components/schemas/RestCmHandleProperties' publicCmHandleProperties: - $ref: '#/components/schemas/RestCmHandleProperties' + $ref: '#/components/schemas/RestCmHandleProperties' + moduleSetTag: + type: string + example: "my-module-set-tag" + trustLevel: + type: string + enum: [COMPLETE, NONE] + example: "COMPLETE" RestCmHandleProperties: - type: object - additionalProperties: + type: object + additionalProperties: + type: string + example: my-property + #Module upgrade schema + UpgradedCmHandles: + required: + - cmHandles + type: object + properties: + cmHandles: + type: array + items: type: string - example: my-property + example: [ my-cm-handle1, my-cm-handle2, my-cm-handle3 ] + moduleSetTag: + type: string + example: 'my-module-set-tag' #Response Schemas RestModuleReference: @@ -160,15 +187,14 @@ 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'; } } - CmHandleQueryParameters: type: object title: Cm Handle query parameters for executing cm handle search @@ -176,13 +202,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 @@ -204,7 +228,6 @@ components: conditionParameters: type: array items: - type: object $ref: '#/components/schemas/ModuleNameAsJsonObject' ModuleNameAsJsonObject: properties: @@ -223,13 +246,15 @@ components: $ref: '#/components/schemas/CmHandlePublicProperties' state: $ref: '#/components/schemas/CmHandleCompositeState' + trustLevel: + $ref: '#/components/schemas/CmHandleTrustLevel' CmHandlePublicProperties: - type: array + type: object items: type: object additionalProperties: type: string - example: Book Type + example: 'Book Type' CmHandleCompositeState: type: object properties: @@ -246,6 +271,10 @@ components: example: false dataSyncState: $ref: '#/components/schemas/dataStores' + CmHandleTrustLevel: + type: string + description: Current trust level of the relevant CM handle ID. + example: COMPLETE lock-reason: type: object @@ -286,24 +315,60 @@ 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: - summary: Sample request - description: Sample request body - value: - test:bookstore: - bookstore-name: Chapters - categories: - - code: '01' - name: SciFi - books: + summary: Sample request + description: Sample request body + value: + test:bookstore: + bookstore-name: Chapters + categories: + - code: '01' + name: SciFi + books: - authors: - Iain M. Banks - Ursula K. Le Guin - - code: '02' - name: kids - books: + - code: '02' + name: kids + books: - authors: - Philip Pullman @@ -352,22 +417,22 @@ components: - Philip Pullman dataSampleResponse: - summary: Sample response - description: Sample response for selecting 'sample 1'. - value: - bookstore: - categories: - - code: '01' - books: - - authors: - - Iain M. Banks - - Ursula K. Le Guin - name: SciFi - - code: '02' - books: - - authors: - - Philip Pullman - name: kids + summary: Sample response + description: Sample response for selecting 'sample 1'. + value: + bookstore: + categories: + - code: '01' + books: + - authors: + - Iain M. Banks + - Ursula K. Le Guin + name: SciFi + - code: '02' + books: + - authors: + - Philip Pullman + name: kids allCmHandleQueryParameters: value: @@ -423,6 +488,14 @@ components: schema: type: string example: my-cm-handle + dataSyncEnabled: + name: dataSyncEnabled + in: query + description: Is used to enable or disable the data synchronization flag + required: true + schema: + type: boolean + example: true xpathInQuery: name: xpath in: query @@ -441,7 +514,7 @@ components: includeDescendantsOptionInQuery: name: include-descendants in: query - description: include-descendants + description: Determines if descendants are included in response required: false schema: type: boolean @@ -449,11 +522,24 @@ components: cpsPathInQuery: name: cps-path in: query - description: cps-path + description: For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html required: false schema: type: string default: / + examples: + container cps path: + value: //bookstore + list attributes cps path: + value: //categories[@code=1] + dmiPluginIdentifierInQuery: + name: dmi-plugin-identifier + in: query + description: dmi-plugin-identifier + required: true + schema: + type: string + example: my-dmi-plugin resourceIdentifierInQuery: name: resourceIdentifier in: query @@ -502,6 +588,18 @@ components: sample 1: value: topic: my-topic-name + requiredTopicParamInQuery: + name: topic + in: query + description: mandatory topic parameter in query. + required: true + schema: + type: string + allowReserved: true + examples: + sample 1: + value: + topic: my-topic-name contentParamInHeader: name: Content-Type in: header @@ -511,6 +609,14 @@ components: type: string default: application/json example: application/yang-data+json + datastoreName: + name: datastore-name + in: path + description: The type of the requested data + required: true + schema: + type: string + example: ncmp-datastore:running responses: NotFound: @@ -540,9 +646,9 @@ components: schema: $ref: '#/components/schemas/ErrorMessage' example: - status: 403 - message: Forbidden error message - details: Forbidden error details + status: 403 + message: Forbidden error message + details: Forbidden error details BadRequest: description: Bad Request content: @@ -550,9 +656,9 @@ components: schema: $ref: '#/components/schemas/ErrorMessage' example: - status: 400 BAD_REQUEST - message: Bad request error message - details: Bad request error details + status: 400 BAD_REQUEST + message: Bad request error message + details: Bad request error details Conflict: description: Conflict content: @@ -560,9 +666,9 @@ components: schema: $ref: '#/components/schemas/ErrorMessage' example: - status: 409 CONFLICT - message: Conflict error message - details: Conflict error details + status: 409 CONFLICT + message: Conflict error message + details: Conflict error details NotImplemented: description: The given path has not been implemented content: @@ -570,9 +676,9 @@ components: schema: $ref: '#/components/schemas/ErrorMessage' example: - status: 501 - message: Not implemented error message - details: Not implemented error details + status: 501 + message: Not implemented error message + details: Not implemented error details Ok: description: OK content: @@ -581,10 +687,10 @@ components: type: object Created: description: Created - content: {} + content: { } NoContent: description: No Content - content: {} + content: { } InternalServerError: description: Internal Server Error content: