summaryrefslogtreecommitdiffstats
path: root/cps-rest/docs/openapi/openapi.yml
AgeCommit message (Collapse)AuthorFilesLines
2024-10-17Release notes and documentation updates for 3.5.4danielhanrahan1-2/+2
- Release notes update - Update openapi info.version to 3.5.4 - Update scheduled-tasks docs to reflect changes in retry mechanism - Update deployment docs to update configurable timer parameters - Remove unused locked-module-sync.sleep-time-ms Issue-ID: CPS-2457 Signed-off-by: danielhanrahan <daniel.hanrahan@est.tech> Change-Id: Ieb559bbfe348848c4b8669410861edfeeb6c9bf3
2024-10-04Revert "[1/2] Move Swagger API to docs folder"Lee Anjella Macabuhay1-0/+116
This reverts commit b76392e2d1629d4eb67b10c450cdd954ef678966. Reason for revert: Release blocker Change-Id: Ic477dbaaad34992c8f440981d92f12b977cdf96e Signed-off-by: emaclee <lee.anjella.macabuhay@est.tech>
2024-09-18[1/2] Move Swagger API to docs folderegernug1-116/+0
Code generation moved to docs folder for cps-core Issue-ID: CPS-2332 Change-Id: I9a8c5007a3039e0f46114c589de0756d6de91127 Signed-off-by: egernug <gerard.nugent@est.tech>
2024-08-21Update openapi for 3.5.2danielhanrahan1-1/+1
- update info.version to 3.5.2 for openapi yamls - update read-the-docs copies of openapi docs Issue-ID: CPS-2374 Signed-off-by: danielhanrahan <daniel.hanrahan@est.tech> Change-Id: I7f726f610fe8eff43e281edfe2fc6d9b08f5fc15
2024-08-07Refactoring of CPS Delta APIsArpit Singh1-5/+2
Refactoring of CPS delta APIs from two separate endpoints to a single endpoint. - GET: /v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/deltaAnchors - POST: /v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/deltaByPayload To new endpoint can perform two operatios as follows: - GET: /v2/dataspaces/{dataspace-name}/anchors/{source-anchor-name}/delta - POST: /v2/dataspaces/{dataspace-name}/anchors/{source-anchor-name}/delta Note: this patch only addresses the issue around refactoring of Delta endpoint to a singular well defined endpoint. A separate patch will be created to refactor the entire Delta feature out of CPS Data, into a separate interface namely CPS Delta Issue-ID: CPS-2310 Change-Id: Ic62c8308cf368b4378235597a11c476809a150b8 Signed-off-by: Arpit Singh <as00745003@techmahindra.com>
2024-08-01Openapi specs updatempriyank1-5/+1
- Correcting the openapi info section for CPS-Core, NCMP and NCMP Inventory APIs to reflect the correct released version of the APIs - Also correcting the specs for dataOperationForCmHandle which now handles 200 cmhandle operations instead of 50. Issue-ID: CPS-2333 Change-Id: I8b0e055a8ee77ed86cee6cbfac3123634f7007ed Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2024-06-06CPS Delta API 2: Delta between anchor and payloadArpit Singh1-2/+5
- Second API to get Delta between an anchor and JSON payload - added new API getDeltaByDataspaceAnchorAndPayload - added controller and service layer methods getDeltaByDataspaceAnchorAndPayload - Core Delta algorithm remains same as the first API. getDeltaByDataspaceAnchorAndPayload will call getDeltaBetweenDataNodes Issue-ID: CPS-1836 Signed-off-by: Arpit Singh <as00745003@techmahindra.com> Change-Id: Id74cd930ce48e5cb414aa62c5381b79675788a37
2023-11-14CPS Delta API 1: Delta between 2 anchorsArpit Singh1-0/+3
- CPS Delta Feature Part 1: To find delta between two anchors - created new endpoint deltaByDataspaceAndAnchors - endpoint to take dataspaceName, source anchor, target anchor, xpath, descendants as input - added new service CpsDeltaService - added method to find delta between DataNodes: getDeltaReport - added method to find removed data nodes: getRemovedDeltaReports - added method to get Added DataNodes: getAddedDeltaReports - added method to get Map of xpath to DataNode: convertToXPathToDataNodesMap - added a POJO for delta report - Added new JSON data for delta feature testing - Added groovy test files CpsDeltaServiceImplSpec and DeltaReportBuilderSpec - code related to update operation, will be added in separate commit Issue-ID: CPS-1824 Signed-off-by: Arpit Singh <as00745003@techmahindra.com> Change-Id: I313f0f71d04b03878be7643f709d8af1aa6df6ba
2023-06-26Chsnge to OpenApi 3.0egernug1-2/+2
In preparation for the Java 17 and Springboot 3 migrations Swagger Codegen has to upgrade to OpenApi 3.0 This effects cps-rest and cps-ncmp-rest Issue-Id: CPS-1745 Signed-off-by: egernug <gerard.nugent@est.tech> Change-Id: I18b8e9ca26d0123009702c2474efbfbeec6d4c44
2023-03-21Query data nodes across all anchors under one dataspacerajesh.kumar1-0/+3
Issue-ID: CPS-1396 Change-ID: I73f97f986a817d423f93a8d922dcd9647b1412ab Signed-off-by: rajesh.kumar <rk00747546@techmahindra.com>
2023-01-23Added depth parameter in query nodes API.rajesh.kumar1-5/+11
Issue-ID: CPS-1381 Change-ID: I73f97f986a817d423f93a8d922dcd9647b1206bb Signed-off-by: rajesh.kumar <rk00747546@techmahindra.com>
2022-12-16API versioning supported and added different versions for POST APIsrajesh.kumar1-7/+28
Issue-ID: CPS-1189 Change-ID: I73f97f986a817d423f92f8d922dcd9647b1214aa Signed-off-by: rajesh.kumar <rk00747546@techmahindra.com>
2022-12-09Added API to get all schema sets for a given dataspace.rajesh.kumar1-1/+1
Issue-ID: CPS-1187 Change-ID: I73f97f986a817d423f93a8d922dcd9647b0914aa Signed-off-by: rajesh.kumar <rk00747546@techmahindra.com>
2022-11-18Added get APIs for dataspace.rajesh.kumar1-0/+7
Issue-ID: CPS-1186 Change-ID: I73f97f986a817d423f93a8d922dcd9647b0829aa Signed-off-by: rajesh.kumar <rk00747546@techmahindra.com>
2022-10-24[NCMP] Add Basic Auth to OpenAPI DefinitionsJosephKeenan1-0/+8
-Adding basic auth to OpenAPI definitions Issue-ID: CPS-1350 Signed-off-by: JosephKeenan <joseph.keenan@est.tech> Change-Id: Iab677f2abc07eed8c3e2910191b15ba27028ee88
2021-11-02Clean Up Code around List NodesDylanB95EST1-1/+1
Make sure code refers clearly to List (whole) nodes or List elements incl. method names, parameter names, test descriptions etc. Issue-ID: CPS-756 Change-Id: Ic9dae6565c0e84c1ba4c2d6e891d3ea307f589da Signed-off-by: DylanB95EST <dylan.byrne@est.tech>
2021-09-01Add ncmp endpoints to swagger-uiRenu Kumari1-0/+72
- added ncmp-enpoints to swagger-ui - removed springfox dependencies - removed Docket configuration as we are loading ui from openapi.yml - removed endpoints which are not implemented - Fixed ncmp basepath as per CPS-616 Issue-ID: CPS-601 Issue-ID: CPS-616 Signed-off-by: Renu Kumari <renu.kumari@bell.ca> Change-Id: I03c7789f48a12d3ffd5fcb934d7ba6347d4044e4
2021-07-16CPS-401 Update Open API YAML with data types and example for output (cpsData)JosephKeenan1-77/+0
-added response for get data nodes based on dataspace and anchor -modified modelmapper jn DataRestControllerSpec to be Spy not Mock -when openapi.yaml is entered into https://editor.swagger.io/ it displays however locally it does not, This may be due to file segmentation but this is still unclear. -moved files from docs/openapi to src/main/resources/static as required for new swagger sprindoc Issue-ID: CPS-401 Change-Id: I45286530d9a9ca85b56c0a656a44675398a003f4 Signed-off-by: JosephKeenan <joseph.keenan@est.tech>
2021-07-13Editing of Nordix Licenses to ONAP guidelineslukegleeson1-1/+3
Issue-ID: CPS-489 Signed-off-by: lukegleeson <luke.gleeson@est.tech> Change-Id: I415534515b3d8325f41d5dc1d02c6e0ae70c6cf1
2021-06-18Missing licence info added in pom fileshivasubedi1-0/+17
- Added licence info to files that were missing it - Fixed licence info to match with the creator of the file Issue-ID: CPS-467 Signed-off-by: shivasubedi <shiva.subedi@est.tech> Change-Id: I1c0eaedb2c87743a61a1cd58f33b0d0d04b3a977
2021-05-26Aligning differing openAPI paths (cps-rest & ncmp-rest)JosephKeenan1-0/+58
Issue-ID: CPS-427 Change-Id: I1d6853419923994feed4d9c38482818f17202e36 Signed-off-by: JosephKeenan <joseph.keenan@est.tech>