ST5AS-55 Add OpenAPI spec for relationship direction

Author: ivan-gomes

app/controllers/RelationshipController.java

@@ -16,10 +16,7 @@
 import services.RelationshipService;
 
 import javax.inject.Inject;
-import java.util.List;
-import java.util.Optional;
-import java.util.Set;
-import java.util.UUID;
+import java.util.*;
 import java.util.stream.Collectors;
 
 /**
@@ -59,17 +56,13 @@ public Result create(Http.Request request) {
     }
 
     public Result getRelationshipsByProjectIdCommitIdRelatedElementId(UUID projectId, UUID commitId, UUID elementId, Optional<String> direction, Http.Request request) {
-        RelationshipDirection relDirection = RelationshipDirection.BOTH;
-        if(direction.isPresent()) {
-            if(direction.get().equalsIgnoreCase(RelationshipDirection.IN.toString()))
-                relDirection = RelationshipDirection.IN;
-            else if(direction.get().equalsIgnoreCase(RelationshipDirection.OUT.toString()))
-                relDirection = RelationshipDirection.OUT;
-            else
-                relDirection = RelationshipDirection.BOTH;
-        }
+        RelationshipDirection relDirection = direction
+                .flatMap(d -> Arrays.stream(RelationshipDirection.values())
+                        .filter(rd -> rd.toString().equalsIgnoreCase(d))
+                        .findAny())
+                .orElse(RelationshipDirection.BOTH);
 
-        Set<Relationship> relationships = relationshipService.getRelationshipsByProjectCommitRelatedElement(projectId, commitId, elementId, Optional.of(relDirection));
+        Set<Relationship> relationships = relationshipService.getRelationshipsByProjectCommitRelatedElement(projectId, commitId, elementId, relDirection);
         boolean respondWithJsonLd = ElementController.respondWithJsonLd(request);
         return ok(JacksonHelper.collectionValueToTree(Set.class,
                 respondWithJsonLd ? JsonLdMofObjectAdornment.class : metamodelProvider.getImplementationClass(Relationship.class),

app/services/RelationshipService.java

@@ -41,17 +41,23 @@ public Optional<Relationship> create(Relationship relationship) {
         return relationship.getIdentifier() != null ? relationshipDao.update(relationship) : relationshipDao.persist(relationship);
     }
 
-    public Set<Relationship> getRelationshipsByProjectCommitRelatedElement(UUID projectId, UUID commitId, UUID relatedElementId, Optional<RelationshipDirection> direction) {
+    public Set<Relationship> getRelationshipsByProjectCommitRelatedElement(UUID projectId, UUID commitId, UUID relatedElementId, RelationshipDirection direction) {
         Commit commit = projectDao.findById(projectId).flatMap(project -> commitDao.findByProjectAndId(project, commitId)).orElseThrow(() -> new IllegalArgumentException("Commit " + commitId + " not found."));
         Element relatedElement = elementDao.findByCommitAndId(commit, relatedElementId).orElseThrow(() -> new IllegalArgumentException("Element " + relatedElementId + " not found."));
         Set<Relationship> allRelationships = relationshipDao.findAllByCommitRelatedElement(commit, relatedElement);
         Set<Relationship> results = allRelationships;
-        if (direction.isPresent()) {
-            if (direction.get().equals(RelationshipDirection.OUT)) {
-                results = allRelationships.stream().filter(r -> r.getSource().stream().anyMatch(e -> e.getIdentifier().equals(relatedElementId))).collect(Collectors.toSet());
-            } else if (direction.get().equals(RelationshipDirection.IN)) {
-                results = allRelationships.stream().filter(r -> r.getTarget().stream().anyMatch(e -> e.getIdentifier().equals(relatedElementId))).collect(Collectors.toSet());
-            }
+        if (RelationshipDirection.OUT.equals(direction)) {
+            results = allRelationships.stream()
+                    .filter(r -> r.getSource().stream()
+                            .anyMatch(e -> Objects.equals(e.getIdentifier(), relatedElementId))
+                    )
+                    .collect(Collectors.toSet());
+        } else if (RelationshipDirection.IN.equals(direction)) {
+            results = allRelationships.stream()
+                    .filter(r -> r.getTarget().stream()
+                            .anyMatch(e -> Objects.equals(e.getIdentifier(), relatedElementId))
+                    )
+                    .collect(Collectors.toSet());
         }
 
         return results;

build.sbt

@@ -33,5 +33,3 @@ javacOptions in Compile ++= Seq("-s", "generated")
 
 sources in(Compile, doc) := Seq.empty
 publishArtifact in(Compile, packageDoc) := false
-
-//routesImport += “org.omg.sysml.utils.RelationshipDirection”

public/swagger/openapi.yaml

@@ -337,6 +337,16 @@ paths:
         type: string
         format: uuid
         required: true
+      - name: direction
+        in: query
+        description: Filter for relationships that are incoming (in), outgoing (out), or both relative to the related element
+        type: string
+        enum:
+          - 'in'
+          - 'out'
+          - 'both'
+        default: 'both'
+        required: false
     get:
       tags:
         - Relationship