aboutsummaryrefslogtreecommitdiffstats
path: root/cps-rest/docs
AgeCommit message (Collapse)AuthorFilesLines
2023-11-14CPS Delta API 1: Delta between 2 anchorsArpit Singh3-0/+62
- 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-10-17[BUG] Fix for Swagger UI generationegernug1-2/+1
Issue-ID: CPS-1913 Signed-off-by: egernug <gerard.nugent@est.tech> Change-Id: Ib8a1b5fddc9957bd371fbb4dc54d018b25af3679
2023-08-03Merge "Support pagination in query across all anchors(ep4)"Luke Gleeson2-1/+19
2023-08-02Support pagination in query across all anchors(ep4)rajesh.kumar2-1/+19
Add pagination query parameters in query across all anchors API pagination parameters (pageIndex and pageSize) are optional default is to query all fragments each pageSize represents number of records(number of anchors) TotalRecords is returned in response header to find number of pages. - If pagination option is provided in request then query number of anchors equal to pageSize. pageIndex is used for setting offset. - return number of records(one anchor per record) as per pagesize and pageSize Issue-ID: CPS-1605 Change-ID: I73f97f986a817d423f93a8d922dcd9647b2504bc Signed-off-by: rajesh.kumar <rk00747546@techmahindra.com>
2023-07-28Add 'direct' keyword to descendants option to query direct children (ep1)Rudrangi Anupriya1-1/+1
-added 'direct' keyword also to Fetch Descendants Option along with 'all' and 'none' to Query direct child. -added unit tests to test direct keyword Issue-ID:CPS-1784 Change-Id: Iab7f59fbeebb03703626132c6d5c2afde0e5ab4d Signed-off-by: Rudrangi Anupriya <ra00745022@techmahindra.com>
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-04-20Correct documentation for GET node APIemaclee1-2/+2
- Add new section on documentation to describe XPath - Correct doc description on GET node API Issue-ID: CPS-1607 Signed-off-by: emaclee <lee.anjella.macabuhay@est.tech> Change-Id: I23e4ccd1185a2d93fbb0b9e02e9daab949c0f952
2023-03-21Query data nodes across all anchors under one dataspacerajesh.kumar3-0/+54
Issue-ID: CPS-1396 Change-ID: I73f97f986a817d423f93a8d922dcd9647b1412ab Signed-off-by: rajesh.kumar <rk00747546@techmahindra.com>
2023-03-20CPS-1526 Fix response message for PATCH operationarpitsingh1-1/+2
- Fixed the Response code and message when trying to update multiple data trees at once - Response code changed to 400 - Since the patch operation across multiple data trees is not supported when xpath is set to root node xpath, appropriate message is returned in response - Existing functionality of updating one data node with root node xpath remains as it is. - Updated API documentation and release notes Issue-ID: CPS-1526 Signed-off-by: arpitsingh <as00745003@techmahindra.com> Change-Id: I5d25a06bb5d407316ccfb2f85877cbe56a9f6f31
2023-02-17CPS-1401 Implement V2 of GET Data Node APIarpitsingh1-1/+1
- Modified the GET Data Node API so it returns all the data nodes when xpath set to root "/" - Fragment Repository now returns a collection of Fragment Entities - Instead of returning only the first Fragment Entity now all fragment entities are returned when xpath is set to root - The Fragemnt Entities are further processed to a Collection of Data Nodes. As opposed to singular Data Node in current implementation. - Finally the DataRestController also returns a Collection of Data Nodes when xpath is set to root and valid data is present - Response body changed from JSON object to JSON Array. - Exception handling for invalid xpath and non-existing xpath is now done separately at persistence layer. - Refactored code against CPS-1422 - Deprecated getDataNode method from Service and Persistence layer - Modified V1 of Get Data Node API to use the getDataNodes method and get the first data node from the collection returned. - Modified NCMP to use getDataNodes method - NCMP still does not support multiple data nodes. It retrieves the first data node from the collection returned by getDataNodes Signed-off-by: arpitsingh <as00745003@techmahindra.com> Change-Id: I494a5740a53f65376d135fcb9f1e2e8900a2803e
2023-02-03Descendants description changed in openApirajesh.kumar1-1/+1
Issue-ID: CPS-1381 Change-ID: I73f97f986a817d423f93a8d922dcd9647b0203aa Signed-off-by: rajesh.kumar <rk00747546@techmahindra.com>
2023-01-23Added depth parameter in query nodes API.rajesh.kumar7-43/+156
Issue-ID: CPS-1381 Change-ID: I73f97f986a817d423f93a8d922dcd9647b1206bb Signed-off-by: rajesh.kumar <rk00747546@techmahindra.com>
2022-12-22XML content on create anchors node supportMichal Jagiello2-1/+32
Add XML content type support on anchor node creation. Issue-ID: CPS-1257 Change-Id: I7e7a9a1961b6e81de93a4e32e842b47f8a163a09 Signed-off-by: Michal Jagiello <michal.jagiello@t-mobile.pl> Signed-off-by: Lee Anjella Macabuhay <lee.anjella.macabuhay@est.tech>
2022-12-16API versioning supported and added different versions for POST APIsrajesh.kumar8-102/+294
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.kumar2-1/+26
Issue-ID: CPS-1187 Change-ID: I73f97f986a817d423f93a8d922dcd9647b0914aa Signed-off-by: rajesh.kumar <rk00747546@techmahindra.com>
2022-11-18Added get APIs for dataspace.rajesh.kumar3-1/+68
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
2022-03-30Additional validation for names/identifiersDylanB95EST1-0/+2
Implementing additional regex validation for names/identifiers in CPS - Introduces a CpsValidator - Applies to relevent java public API's - Tests have been updated where necessary Issue-ID: CPS-322 Change-Id: I29ab8820bb1fe0eee247e425d6bb018bcd38f28e Signed-off-by: DylanB95EST <dylan.byrne@est.tech>
2022-03-10Replacing ModelMapper with MapStructlukegleeson1-0/+2
- Removed Model Mapper from pom files - Replaced ModelMapper with MapStruct - Added Tests for MapStruct - Changed mapstruct annotations for individual variables to be null safe rather than all variables - Excluded generated code from code coverage - Set ModuleReferences input to required for SchemaSet so that ModuleReferences list set to empty list rather than null Issue-ID: CPS-127 Signed-off-by: lukegleeson <luke.gleeson@est.tech> Change-Id: I43f874aea79f58dda5526c6fdead27d8474d90af
2022-02-28Updated openapi.yaml to match to changes in get data node APIputhuparambil.aditya3-29/+19
1. updated the pom version to 3.0.0-SNAPSHOT 2. modified the examples for get data node api to match the post api. Issue-ID: CPS-865 Signed-off-by: puthuparambil.aditya <aditya.puthuparambil@bell.ca> Change-Id: Icf03522e9ba7fb9c245fd9f09b3eb8bb6f3ee60d
2022-01-31[TECHDEBT] Align CPS Core REST API Specification and ImplementationJosephKeenan4-24/+59
Issue-ID: CPS-822 Signed-off-by: JosephKeenan <joseph.keenan@est.tech> Change-Id: Idde7525628f7e1425602069e0d75506ac621113e
2021-12-02Adding examples in openapi for cps-coreputhuparambil.aditya3-24/+111
1. Added examples for all parameters, request body and response body 2. Changed the response/request type to Object from String for all json objects 3. Passed json format data in all tests 4. PUT and PATCH operations at present return empty response, hence examples are changed to be in sync Issue-ID: CPS-780 Signed-off-by: puthuparambil.aditya <aditya.puthuparambil@bell.ca> Change-Id: If6dd5bb48df4e1bbf1026eaadf315df8f972e282
2021-11-23CPS-314: Delete Dataspaceniamhcore1-0/+20
Issue-ID: CPS-314 Change-Id: I778e2b784c7b1ff3fecc1036425708dc4ec73227 Signed-off-by: niamhcore <niamh.core@est.tech>
2021-11-02Delete DataNode (xpath) for a given AnchorDylanB95EST1-0/+23
Delete Datanode within CPS. Deprecates delete functionality of /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-nodes. New api is backwards compatible with this API Issue-ID: CPS-313 Change-Id: I110c4ab1446e8a1399a0d9bf89c0be614a9104df Signed-off-by: DylanB95EST <dylan.byrne@est.tech>
2021-11-02Clean Up Code around List NodesDylanB95EST2-12/+12
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 Kumari5-0/+740
- 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)JosephKeenan5-743/+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 guidelineslukegleeson2-2/+5
Issue-ID: CPS-489 Signed-off-by: lukegleeson <luke.gleeson@est.tech> Change-Id: I415534515b3d8325f41d5dc1d02c6e0ae70c6cf1
2021-06-18Merge "Missing licence info added in pom file"Bruno Sakoto5-0/+82
2021-06-18Missing licence info added in pom fileshivasubedi5-0/+82
- 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-06-15[OpenAPI] Implemented example as per example wiki page for getting anchors ↵JosephKeenan2-4/+62
based on dataspace -moved components from cpsAdmin.yml to components.yml -refactored variable for anchor details list in AdminRestController.java -reintrocuded paramter for anchorsByDataspace -refactored variables in AdminRestController.java getAnchors() to be more intuitive -refactored AdminRestController.java to use modelmapper and removed extra conversion code. Also modified AdminRestControllerSpec.groovy to use ModelMapper as Spy rather than a Mock -added responses for getAnchor & getSchemaSet -added javadoc for AdminRestController.java public methods -refactored schemaDetils pararmeter from dataSpasceName to name for CSOT tests & added some code review comments Issue-ID: CPS-429 Change-Id: I01d4113313c9a23d9a7e0e96e46b90f9ac767f24 Signed-off-by: JosephKeenan <joseph.keenan@est.tech>
2021-05-26Aligning differing openAPI paths (cps-rest & ncmp-rest)JosephKeenan5-0/+0
Issue-ID: CPS-427 Change-Id: I1d6853419923994feed4d9c38482818f17202e36 Signed-off-by: JosephKeenan <joseph.keenan@est.tech>
2021-05-25Replace list-node content (part 2): CPS REST layerRuslan Kashapov1-0/+26
Issue-ID: CPS-362 Change-Id: I46dc9b48758fa10a47a648aa4e6a63775466234b Signed-off-by: Ruslan Kashapov <ruslan.kashapov@pantheon.tech>
2021-05-11Create list-node elements (part2): CPS REST layerRuslan Kashapov3-0/+37
Issue-ID: CPS-360 Change-Id: Iaca8baff085e1659453c06ce0dee0203aa007b4a Signed-off-by: Ruslan Kashapov <ruslan.kashapov@pantheon.tech>
2021-04-20Create child data node (part 1): CPS service + RESTRuslan Kashapov1-0/+1
Issue-ID: CPS-337 Change-Id: I9c5c62d144b5301ac80e2b82a5cc66a980dad011 Signed-off-by: Ruslan Kashapov <ruslan.kashapov@pantheon.tech>
2021-04-07Delete anchor part 2: cps restRuslan Kashapov1-3/+1
Issue-ID: CPS-312 Change-Id: I08f92dfff3188bd96a69ec2ae01e0d0891b81d87 Signed-off-by: Ruslan Kashapov <ruslan.kashapov@pantheon.tech>
2021-03-02CPS-265 - updating cps path to support include-descendants option.niamhcore1-0/+1
Issue-ID: CPS-265 Signed-off-by: niamhcore <niamh.core@est.tech> Change-Id: I9e9b84760dbc8b5eb4b31ab972fdb2d186c6bb48
2021-02-22Rest & Java API layer - Query Datanodes using cpsPath that contains contains ↵niamhcore3-0/+34
a leaf name and a leaf value Issue-ID: CPS-231 Signed-off-by: niamhcore <niamh.core@est.tech> Change-Id: I3bf2a9946746ad06ddb4bc832206a36b78ff2175
2021-01-27Correct URL for Get a node using anchor and dataspaceRishi.Chail3-3/+7
Issue-ID: CPS-252 Signed-off-by: Rishi.Chail <rishi.chail@est.tech> Change-Id: I26bf4e30f49d1b47c38826360cd046ff41081aa8
2021-02-18Data fragment update by xpath #3 - rest and service layersRuslan Kashapov2-2/+55
Issue-ID: CPS-58 Change-Id: Ie224da95b07748b63648226df6484cebae91cdec Signed-off-by: Ruslan Kashapov <ruslan.kashapov@pantheon.tech>
2021-01-26Ensure CPS REST API Specs conform to ONAP standardsRishi.Chail4-156/+177
Issue-ID: CPS-25 Signed-off-by: Rishi.Chail <rishi.chail@est.tech> Change-Id: I17fec852cf2dcb824dfc0ab7f00ebe4cfd9e09b5
2021-01-25Ensure CPS REST API Specs conform to ONAP standardsRishi.Chail1-3/+15
Issue-ID: CPS-25 Signed-off-by: Rishi.Chail <rishi.chail@est.tech> Change-Id: I289248b0f67949a2b9515932628edd4a7bd77a58
2021-02-04Fetching data node by xpath - rest and service layersRuslan Kashapov2-2/+20
IssueID: CPS-71 Change-Id: I54801fc12a8aa700d85e774780c9990b7f19c747 Signed-off-by: Ruslan Kashapov <ruslan.kashapov@pantheon.tech>
2021-02-01Merge "Retrieve an Anchor for a given dataspace by anchor name - REST layer"Toine Siebelink1-1/+1
2021-02-01Attach a (JSON) data instance for a container with children to a given Anchorniamhcore1-21/+22
Issue-ID: CPS-26 Signed-off-by: niamhcore <niamh.core@est.tech> Change-Id: I38fc1b1a6ccf84e64eff3218372b40c8fa2491ba
2021-01-23Retrieve an Anchor for a given dataspace by anchor name - REST layerRishi.Chail1-1/+1
Issue-ID: CPS-186 Signed-off-by: Rishi.Chail <rishi.chail@est.tech> Change-Id: I2dceb582c6277e56400dfbc46340c70d814603ee
2021-01-19Delete schema set - REST and service layersRuslan Kashapov2-0/+25
Issue-ID: CPS-121 Change-Id: I0fe885c79f98c994a8ac25a59b77b99eee4b3076 Signed-off-by: Ruslan Kashapov <ruslan.kashapov@pantheon.tech>
2021-01-15Split OpenAPI yaml fileputhuparambil.aditya4-392/+352
1. components like schema, parameters, responses, requestBodies all moved to components.yml (https://swagger.io/docs/specification/components/) 2. CpAdmin.yml includes the configuration details for cpsAdmin APIs 3. CpsData.yml includes the API configuration details for cpsData Issue-ID: CPS-155 Signed-off-by: puthuparambil.aditya <aditya.puthuparambil@bell.ca> Change-Id: I18fb9b8a2be85d180d4625657aca399dbf60b7bc
2021-01-11Rework CpsModulePersistenceServiceClaudio David Gasparini1-0/+35
- remove getModuleReferences - provide service returning YangTextSchemaSourceSet Issue-ID: CPS-21 Signed-off-by: Claudio David Gasparini <claudio.gasparini@pantheon.tech> Change-Id: I61cf6450c8ed8a5154990ea19467e016dc1155b4
2021-01-06Create dataspaceRuslan Kashapov1-0/+29
Issue-ID: CPS-134 Change-Id: Ie7f00f9c322a12a6c2a71c1407f6970a7dd24d2d Signed-off-by: Ruslan Kashapov <ruslan.kashapov@pantheon.tech>