[OpenAPI] Implemented example as per example wiki page for getting anchors based...

-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>

diff --git a/cps-rest/docs/openapi/components.yml b/cps-rest/docs/openapi/components.yml
index 5a21a73..a337a24 100644 (file)
--- a/cps-rest/docs/openapi/components.yml
+++ b/cps-rest/docs/openapi/components.yml
@@ -1,5 +1,20 @@
 components:
   schemas:
+
+    AnchorDetails:
+      type: object
+      title: Anchor details by anchor Name
+      properties:
+        name:
+          type: string
+          example: my_anchor
+        dataspaceName:
+          type: string
+          example: my_dataspace
+        schemaSetName:
+          type: string
+          example: my_schema_set
+
     ErrorMessage:
       type: object
       title: Error
@@ -24,6 +39,35 @@ components:
           format: binary
           example: http://example.com/examples/example.yang
 
+    ModuleReferences:
+      type: object
+      title: Module reference object
+      properties:
+        name:
+          type: string
+          example: module_reference_name
+        namespace:
+          type: string
+          example: module_reference_namespace
+        revision:
+          type: string
+          example: module_reference_revision
+
+    SchemaSetDetails:
+      type: object
+      title: Schema set details by dataspace and schemasetName
+      properties:
+        dataspaceName:
+          type: string
+          example: my_dataspace
+        moduleReferences:
+          type: array
+          items:
+            $ref: '#/components/schemas/ModuleReferences'
+        name:
+          type: string
+          example: my_schema_set
+
   parameters:
     dataspaceNameInQuery:
       name: dataspace-name

diff --git a/cps-rest/docs/openapi/cpsAdmin.yml b/cps-rest/docs/openapi/cpsAdmin.yml
index cf26299..1a2e65f 100644 (file)
--- a/cps-rest/docs/openapi/cpsAdmin.yml
+++ b/cps-rest/docs/openapi/cpsAdmin.yml
@@ -78,7 +78,11 @@ schemaSetBySchemaSetName:
       - $ref: 'components.yml#/components/parameters/schemaSetNameInPath'
     responses:
       '200':
-        $ref: 'components.yml#/components/responses/Ok'
+        description: OK
+        content:
+          application/json:
+            schema:
+              $ref: 'components.yml#/components/schemas/SchemaSetDetails'
       '400':
         $ref: 'components.yml#/components/responses/BadRequest'
       '401':
@@ -120,7 +124,13 @@ anchorsByDataspace:
       - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
     responses:
       '200':
-        $ref: 'components.yml#/components/responses/Ok'
+        description: OK
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                $ref: 'components.yml#/components/schemas/AnchorDetails'
       '400':
         $ref: 'components.yml#/components/responses/BadRequest'
       '401':
@@ -162,7 +172,11 @@ anchorByDataspaceAndAnchorName:
       - $ref: 'components.yml#/components/parameters/anchorNameInPath'
     responses:
       '200':
-        $ref: 'components.yml#/components/responses/Ok'
+        description: OK
+        content:
+          application/json:
+            schema:
+              $ref: 'components.yml#/components/schemas/AnchorDetails'
       '400':
         $ref: 'components.yml#/components/responses/BadRequest'
       '401':
@@ -189,4 +203,4 @@ anchorByDataspaceAndAnchorName:
       '401':
         $ref: 'components.yml#/components/responses/Unauthorized'
       '403':
-        $ref: 'components.yml#/components/responses/Forbidden'
+        $ref: 'components.yml#/components/responses/Forbidden'
\ No newline at end of file

diff --git a/cps-rest/src/main/java/org/onap/cps/rest/controller/AdminRestController.java b/cps-rest/src/main/java/org/onap/cps/rest/controller/AdminRestController.java
index 74b1a41..57b6771 100755 (executable)
--- a/cps-rest/src/main/java/org/onap/cps/rest/controller/AdminRestController.java
+++ b/cps-rest/src/main/java/org/onap/cps/rest/controller/AdminRestController.java
@@ -25,11 +25,16 @@ import static org.onap.cps.rest.utils.MultipartFileUtil.extractYangResourcesMap;
 import static org.onap.cps.spi.CascadeDeleteAllowed.CASCADE_DELETE_PROHIBITED;
 
 import java.util.Collection;
+import java.util.List;
+import java.util.stream.Collectors;
 import org.modelmapper.ModelMapper;
 import org.onap.cps.api.CpsAdminService;
 import org.onap.cps.api.CpsModuleService;
 import org.onap.cps.rest.api.CpsAdminApi;
+import org.onap.cps.rest.model.AnchorDetails;
+import org.onap.cps.rest.model.SchemaSetDetails;
 import org.onap.cps.spi.model.Anchor;
+import org.onap.cps.spi.model.SchemaSet;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
@@ -50,17 +55,37 @@ public class AdminRestController implements CpsAdminApi {
     @Autowired
     private ModelMapper modelMapper;
 
+    /**
+     * Create a dataspace.
+     *
+     * @param dataspaceName dataspace name
+     * @return a {@Link ResponseEntity} of created dataspace name & {@link HttpStatus} CREATED
+     */
     @Override
     public ResponseEntity<String> createDataspace(final String dataspaceName) {
         cpsAdminService.createDataspace(dataspaceName);
         return new ResponseEntity<>(dataspaceName, HttpStatus.CREATED);
     }
 
+    /**
+     * Delete a dataspace based on a given name.
+     *
+     * @param dataspaceName dataspace name
+     * @return a {@Link ResponseEntity} of {@link HttpStatus} NOT_IMPLEMENTED
+     */
     @Override
     public ResponseEntity<Object> deleteDataspace(final String dataspaceName) {
         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
     }
 
+    /**
+     * Create a {@link SchemaSet}.
+     *
+     * @param multipartFile multipart file
+     * @param schemaSetName schemaset name
+     * @param dataspaceName dataspace name
+     * @return a {@Link ResponseEntity} of created schemaset name & {@link HttpStatus} CREATED
+     */
     @Override
     public ResponseEntity<String> createSchemaSet(final MultipartFile multipartFile,
         final String schemaSetName, final String dataspaceName) {
@@ -68,12 +93,27 @@ public class AdminRestController implements CpsAdminApi {
         return new ResponseEntity<>(schemaSetName, HttpStatus.CREATED);
     }
 
+    /**
+     * Get {@link SchemaSetDetails} based on dataspace name & {@link SchemaSet} name.
+     *
+     * @param dataspaceName dataspace name
+     * @param schemaSetName schemaset name
+     * @return a {@Link ResponseEntity} of {@Link SchemaSetDetails} & {@link HttpStatus} OK
+     */
     @Override
-    public ResponseEntity<Object> getSchemaSet(final String dataspaceName, final String schemaSetName) {
+    public ResponseEntity<SchemaSetDetails> getSchemaSet(final String dataspaceName, final String schemaSetName) {
         final var schemaSet = cpsModuleService.getSchemaSet(dataspaceName, schemaSetName);
-        return new ResponseEntity<>(schemaSet, HttpStatus.OK);
+        final SchemaSetDetails schemaSetDetails = modelMapper.map(schemaSet, SchemaSetDetails.class);
+        return new ResponseEntity<>(schemaSetDetails, HttpStatus.OK);
     }
 
+    /**
+     * Delete a {@link SchemaSet} based on given dataspace name & schemaset name.
+     *
+     * @param dataspaceName dataspace name
+     * @param schemaSetName schemaset name
+     * @return a {@Link ResponseEntity} of {@link HttpStatus} NO_CONTENT
+     */
     @Override
     public ResponseEntity<Void> deleteSchemaSet(final String dataspaceName, final String schemaSetName) {
         cpsModuleService.deleteSchemaSet(dataspaceName, schemaSetName, CASCADE_DELETE_PROHIBITED);
@@ -86,7 +126,7 @@ public class AdminRestController implements CpsAdminApi {
      * @param dataspaceName dataspace name
      * @param schemaSetName schema set name
      * @param anchorName    anchorName
-     * @return a ResponseEntity with the anchor name.
+     * @return a ResponseEntity with the anchor name & {@link HttpStatus} CREATED
      */
     @Override
     public ResponseEntity<String> createAnchor(final String dataspaceName, final String schemaSetName,
@@ -95,21 +135,44 @@ public class AdminRestController implements CpsAdminApi {
         return new ResponseEntity<>(anchorName, HttpStatus.CREATED);
     }
 
+    /**
+     * Delete an {@link Anchor} based on given dataspace name & anchor name.
+     *
+     * @param dataspaceName dataspace name
+     * @param anchorName anchor name
+     * @return a {@Link ResponseEntity} of {@link HttpStatus} NO_CONTENT
+     */
     @Override
     public ResponseEntity<Void> deleteAnchor(final String dataspaceName, final String anchorName) {
         cpsAdminService.deleteAnchor(dataspaceName, anchorName);
         return new ResponseEntity<>(HttpStatus.NO_CONTENT);
     }
 
+    /**
+     * Get an {@link Anchor} based on given dataspace name & anchor name.
+     *
+     * @param dataspaceName dataspace name
+     * @param anchorName anchor name
+     * @return a {@Link ResponseEntity} of an {@Link AnchorDetails} & {@link HttpStatus} OK
+     */
     @Override
-    public ResponseEntity<Object> getAnchor(final String dataspaceName, final String anchorName) {
+    public ResponseEntity<AnchorDetails> getAnchor(final String dataspaceName, final String anchorName) {
         final var anchor = cpsAdminService.getAnchor(dataspaceName, anchorName);
-        return new ResponseEntity<>(anchor, HttpStatus.OK);
+        final AnchorDetails anchorDetails = modelMapper.map(anchor, AnchorDetails.class);
+        return new ResponseEntity<>(anchorDetails, HttpStatus.OK);
     }
 
+    /**
+     *  Get all {@link Anchor} based on given dataspace name.
+     *
+     * @param dataspaceName dataspace name
+     * @return a {@Link ResponseEntity} of all {@Link AnchorDetails} & {@link HttpStatus} OK
+     */
     @Override
-    public ResponseEntity<Object> getAnchors(final String dataspaceName) {
-        final Collection<Anchor> anchorDetails = cpsAdminService.getAnchors(dataspaceName);
+    public ResponseEntity<List<AnchorDetails>> getAnchors(final String dataspaceName) {
+        final Collection<Anchor> anchors = cpsAdminService.getAnchors(dataspaceName);
+        final List<AnchorDetails> anchorDetails = anchors.stream().map(anchor ->
+            modelMapper.map(anchor, AnchorDetails.class)).collect(Collectors.toList());
         return new ResponseEntity<>(anchorDetails, HttpStatus.OK);
     }
 }

diff --git a/cps-rest/src/test/groovy/org/onap/cps/rest/controller/AdminRestControllerSpec.groovy b/cps-rest/src/test/groovy/org/onap/cps/rest/controller/AdminRestControllerSpec.groovy
index e158ebd..9ce7f73 100755 (executable)
--- a/cps-rest/src/test/groovy/org/onap/cps/rest/controller/AdminRestControllerSpec.groovy
+++ b/cps-rest/src/test/groovy/org/onap/cps/rest/controller/AdminRestControllerSpec.groovy
@@ -64,7 +64,7 @@ class AdminRestControllerSpec extends Specification {
     CpsQueryService mockCpsQueryService = Mock()
 
     @SpringBean
-    ModelMapper modelMapper = Mock()
+    ModelMapper modelMapper = Spy()
 
     @Autowired
     MockMvc mvc