Merge pull request #495 from guardian/dblatcher/display-hint-put-endp…

…oint

display hint put endpoint

app/controllers/Api.scala

@@ -165,6 +165,18 @@ class Api(
     )}
   }
 
+  def putStubDisplayHint(stubId: Long) = {
+    def getDisplayHintOpt(input: String): Option[String] = if(input.length > 0) Some(input) else None
+    APIAuthAction.async { request =>
+      ApiResponseFt[Long](for {
+        json <- readJsonFromRequestResponse(request.body)
+        displayHint <- extractDataResponse[String](json)
+        displayHintOpt = getDisplayHintOpt(displayHint)
+        id <- stubsApi.putStubDisplayHint(stubId, displayHintOpt)
+      } yield id
+    )}
+  }
+
   def putStubStatus(stubId: Long) = {
     APIAuthAction.async { request =>
       ApiResponseFt[Long](for {

common-lib/src/main/scala/com/gu/workflow/api/StubAPI.scala

@@ -95,6 +95,13 @@ class StubAPI(
       item <- extractDataResponse[Long](json)
     } yield item
 
+  def putStubDisplayHint(id: Long, displayHint: Option[String]): ApiResponseFt[Long] =
+    for {
+      res <- ApiResponseFt.Async.Right(putRequest(s"stubs/$id/displayHint", displayHint.asJson))
+      json <- parseBody(res.body)
+      item <- extractDataResponse[Long](json)
+    } yield item
+
   def putStubTrashed(id: Long, trashed: Boolean): ApiResponseFt[Long] =
     for {
       res <- ApiResponseFt.Async.Right(putRequest(s"stubs/$id/updateTrashed", trashed.asJson))

conf/routes

@@ -33,6 +33,7 @@ POST           /api/stubs                                  controllers.Api.creat
 PUT            /api/stubs/:stubId                          controllers.Api.putStub(stubId: Long)
 PUT            /api/stubs/:stubId/assignee                 controllers.Api.putStubAssignee(stubId: Long)
 PUT            /api/stubs/:stubId/assigneeEmail            controllers.Api.putStubAssigneeEmail(stubId: Long)
+PUT            /api/stubs/:stubId/displayHint              controllers.Api.putStubDisplayHint(stubId: Long)
 PUT            /api/stubs/:stubId/dueDate                  controllers.Api.putStubDueDate(stubId: Long)
 PUT            /api/stubs/:stubId/note                     controllers.Api.putStubNote(stubId: Long)
 PUT            /api/stubs/:stubId/needsLegal               controllers.Api.putStubLegalStatus(stubId: Long)

public/components/content-list-item/content-list-item.js

@@ -126,6 +126,7 @@ function wfContentItemParser(config, wfFormatDateTime, statusLabels, sections) {
 
             this.contentType = item.contentType;
             this.contentTypeTitle = toTitleCase(item.contentType);
+            this.displayHintDescription = item.displayHint ?? 'No Display Hint';
             this.office = item.prodOffice;
             this.officeTitle = getFullOfficeString(item.prodOffice);
 

public/components/content-list-item/templates/content-type.html

@@ -1,3 +1,3 @@
-<td class="content-list-item__field--content-type" title="{{ contentItem.contentTypeTitle }}">
+<td class="content-list-item__field--content-type" title="{{ contentItem.contentTypeTitle }}" data-display-hint="{{ contentItem.displayHintDescription }}">
     <i class="content-list-item__icon--content-type" wf-icon="{{ contentItem.contentType }}"/>
 </td>