Added Location header to run creation

Fix for #699 Signed-off-by: Nicolas Kijak <nick.kijak@pngaming.com>
MarquezProject · Jan 14, 2020 · b1d3352 · b1d3352
1 parent 11842d8
commit b1d3352
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 3 deletions.
diff --git a/src/main/java/marquez/api/JobResource.java b/src/main/java/marquez/api/JobResource.java
@@ -16,11 +16,11 @@
 package marquez.api;
 
 import static javax.ws.rs.core.MediaType.APPLICATION_JSON;
-import static javax.ws.rs.core.Response.Status.CREATED;
 
 import com.codahale.metrics.annotation.ExceptionMetered;
 import com.codahale.metrics.annotation.ResponseMetered;
 import com.codahale.metrics.annotation.Timed;
+import java.net.URI;
 import java.util.List;
 import java.util.UUID;
 import javax.validation.Valid;
@@ -33,7 +33,9 @@
 import javax.ws.rs.PathParam;
 import javax.ws.rs.Produces;
 import javax.ws.rs.QueryParam;
+import javax.ws.rs.core.Context;
 import javax.ws.rs.core.Response;
+import javax.ws.rs.core.UriInfo;
 import lombok.NonNull;
 import lombok.extern.slf4j.Slf4j;
 import marquez.api.exceptions.JobNotFoundException;
@@ -146,7 +148,8 @@ public Response list(
   public Response createRun(
       @PathParam("namespace") String namespaceString,
       @PathParam("job") String jobString,
-      @Valid RunRequest request)
+      @Valid RunRequest request,
+      @Context UriInfo uriInfo)
       throws MarquezServiceException {
     log.debug("Request: {}", request);
     final NamespaceName namespaceName = NamespaceName.of(namespaceString);
@@ -158,7 +161,15 @@ public Response createRun(
     final Run run = jobService.createRun(namespaceName, jobName, runMeta);
     final RunResponse response = Mapper.toRunResponse(run);
     log.debug("Response: {}", response);
-    return Response.status(CREATED).entity(response).build();
+    final URI runLocation =
+        uriInfo
+            .getBaseUriBuilder()
+            .clone()
+            .path(this.getClass())
+            .path(this.getClass(), "getRun")
+            .build(run.getId());
+
+    return Response.created(runLocation).entity(response).build();
   }
 
   @Timed

diff --git a/src/main/java/marquez/service/models/Run.java b/src/main/java/marquez/service/models/Run.java
@@ -33,6 +33,10 @@ public class Run {
   @NonNull Run.State state;
   @Nullable Map<String, String> args;
 
+  public UUID getId() {
+    return id;
+  }
+
   public Optional<Instant> getNominalStartTime() {
     return Optional.ofNullable(nominalStartTime);
   }

diff --git a/src/test/java/marquez/MarquezAppIntegrationTest.java b/src/test/java/marquez/MarquezAppIntegrationTest.java
@@ -293,6 +293,8 @@ public void testApp_createRunAndMarkAsComplete() {
     final Map<String, Object> run = response0.readEntity(Map.class);
     final String runId = (String) run.get("runId");
 
+    assertThat(response0.getHeaderString("Location")).isEqualTo(baseUri + "/jobs/runs/" + runId);
+
     final Response response1 =
         APP.client()
             .target(baseUri + "/jobs/runs/{id}/start")