Create list-node elements (part2): CPS REST layer 99/121099/2
authorRuslan Kashapov <ruslan.kashapov@pantheon.tech>
Wed, 5 May 2021 10:11:50 +0000 (13:11 +0300)
committerRuslan Kashapov <ruslan.kashapov@pantheon.tech>
Tue, 11 May 2021 07:20:48 +0000 (10:20 +0300)
Issue-ID: CPS-360
Change-Id: Iaca8baff085e1659453c06ce0dee0203aa007b4a
Signed-off-by: Ruslan Kashapov <ruslan.kashapov@pantheon.tech>
cps-rest/docs/api/swagger/components.yml
cps-rest/docs/api/swagger/cpsData.yml
cps-rest/docs/api/swagger/openapi.yml
cps-rest/src/main/java/org/onap/cps/rest/controller/DataRestController.java
cps-rest/src/test/groovy/org/onap/cps/rest/controller/DataRestControllerSpec.groovy

index bb1f120..5a21a73 100755 (executable)
@@ -75,6 +75,13 @@ components:
       schema:
         type: string
         default: /
+    requiredXpathInQuery:
+      name: xpath
+      in: query
+      description: xpath
+      required: true
+      schema:
+        type: string
     cpsPathInQuery:
       name: cps-path
       in: query
index 54c8966..c0cd85b 100755 (executable)
@@ -23,6 +23,33 @@ nodeByDataspaceAndAnchor:
         $ref: 'components.yml#/components/responses/NotFound'
     x-codegen-request-body-name: xpath
 
+listNodeByDataspaceAndAnchor:
+  post:
+    description: Add list-node child elements to existing node for a given anchor and dataspace
+    tags:
+      - cps-data
+    summary: Add list-node child element(s) under existing parent node
+    operationId: addListNodeElements
+    parameters:
+      - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
+      - $ref: 'components.yml#/components/parameters/anchorNameInPath'
+      - $ref: 'components.yml#/components/parameters/requiredXpathInQuery'
+    requestBody:
+      required: true
+      content:
+        application/json:
+          schema:
+            type: string
+    responses:
+      '201':
+        $ref: 'components.yml#/components/responses/Created'
+      '400':
+        $ref: 'components.yml#/components/responses/BadRequest'
+      '401':
+        $ref: 'components.yml#/components/responses/Unauthorized'
+      '403':
+        $ref: 'components.yml#/components/responses/Forbidden'
+
 nodesByDataspaceAndAnchor:
   post:
     description: Create a node for a given anchor and dataspace
index 38fbebe..3c0cc09 100755 (executable)
@@ -48,6 +48,9 @@ paths:
   /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes:
     $ref: 'cpsData.yml#/nodesByDataspaceAndAnchor'
 
+  /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-node:
+    $ref: 'cpsData.yml#/listNodeByDataspaceAndAnchor'
+
   /v1/dataspaces/{dataspace-name}/nodes:
     $ref: 'cpsData.yml#/nodesByDataspace'
 
index c8b7412..3d16539 100755 (executable)
@@ -51,6 +51,13 @@ public class DataRestController implements CpsDataApi {
         return new ResponseEntity<>(HttpStatus.CREATED);
     }
 
+    @Override
+    public ResponseEntity<String> addListNodeElements(final String jsonData, final String parentNodeXpath,
+        final String dataspaceName, final String anchorName) {
+        cpsDataService.saveListNodeData(dataspaceName, anchorName, parentNodeXpath, jsonData);
+        return new ResponseEntity<>(HttpStatus.CREATED);
+    }
+
     @Override
     public ResponseEntity<Object> getNodesByDataspace(final String dataspaceName) {
         return null;
@@ -62,7 +69,7 @@ public class DataRestController implements CpsDataApi {
         final FetchDescendantsOption fetchDescendantsOption = Boolean.TRUE.equals(includeDescendants)
             ? FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS : FetchDescendantsOption.OMIT_DESCENDANTS;
         final var dataNode = cpsDataService.getDataNode(dataspaceName, anchorName, xpath,
-                fetchDescendantsOption);
+            fetchDescendantsOption);
         return new ResponseEntity<>(DataMapUtils.toDataMap(dataNode), HttpStatus.OK);
     }
 
index b64b561..18d20a8 100755 (executable)
@@ -33,10 +33,6 @@ import org.onap.cps.api.CpsAdminService
 import org.onap.cps.api.CpsDataService
 import org.onap.cps.api.CpsModuleService
 import org.onap.cps.api.CpsQueryService
-import org.onap.cps.spi.exceptions.AlreadyDefinedException
-import org.onap.cps.spi.exceptions.AnchorNotFoundException
-import org.onap.cps.spi.exceptions.DataNodeNotFoundException
-import org.onap.cps.spi.exceptions.DataspaceNotFoundException
 import org.onap.cps.spi.model.DataNode
 import org.onap.cps.spi.model.DataNodeBuilder
 import org.spockframework.spring.SpringBean
@@ -131,6 +127,24 @@ class DataRestControllerSpec extends Specification {
             1 * mockCpsDataService.saveData(dataspaceName, anchorName, parentNodeXpath, json)
     }
 
+    def 'Create list node child elements.'() {
+        given: 'parent node xpath and json data inputs'
+            def parentNodeXpath = 'parent node xpath'
+            def jsonData = 'json data'
+        when: 'post is invoked list-node endpoint'
+            def response = mvc.perform(
+                    post("$dataNodeBaseEndpoint/anchors/$anchorName/list-node")
+                            .contentType(MediaType.APPLICATION_JSON)
+                            .param('xpath', parentNodeXpath)
+                            .content(jsonData)
+            ).andReturn().response
+        then: 'a created response is returned'
+            response.status == HttpStatus.CREATED.value()
+        then: 'the java API was called with the correct parameters'
+            1 * mockCpsDataService.saveListNodeData(dataspaceName, anchorName, parentNodeXpath, jsonData)
+
+    }
+
     def 'Get data node with leaves'() {
         given: 'the service returns data node leaves'
             def xpath = 'some xPath'