Merge pull request #44 from Financial-Times/fix/uppsf-859-remove-resp…

…onse-body Remove response body from POST, DELETE, PATCH endpoints
Financial-Times · Nov 4, 2019 · 461aaa5 · 461aaa5
2 parents bbc057f + 1137dc2
commit 461aaa5
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 122 deletions.
diff --git a/README.md b/README.md
@@ -127,27 +127,7 @@ curl http://localhost:8080/drafts/content/{content-uuid}/annotations -X POST --d
 
 A POST request on this endpoint adds an annotation to the editorially curated published annotations for a specific piece of content. To retrieve these annotations it calls [UPP Public Annotations API](https://github.com/Financial-Times/public-annotations-api) using the "lifecycle" parameter.
 The new list of draft annotations will override any unpublished draft annotations for this piece of content.
-If the operation is successful, the application returns the canonicalized input body with an HTTP 200 response code.
-
-This is an example response body:
-```
-{
-      "annotations":[
-      {
-        "predicate": "http://www.ft.com/ontology/annotation/hasContributor",
-        "id": "http://www.ft.com/thing/5bd49568-6d7c-3c10-a5b0-2f3fd5974a6b",
-      },
-      {
-        "predicate": "http://www.ft.com/ontology/annotation/about",
-        "id": "http://www.ft.com/thing/d7de27f8-1633-3fcc-b308-c95a2ad7d1cd",
-      },
-      {
-        "predicate": "http://www.ft.com/ontology/annotation/hasDisplayTag",
-        "id": "http://www.ft.com/thing/d7de27f8-1633-3fcc-b308-c95a2ad7d1cd",
-      }
-    ]
-}
-```
+If the operation is successful, the application returns an HTTP 200 response code.
 
 ### PUT - Writing draft annotations to PAC
 
@@ -216,27 +196,7 @@ curl http://localhost:8080/drafts/content/{content-uuid}/annotations/{concept-uu
 ```
 
 A DELETE request on this endpoint deletes all the annotations for a single concept from the editorially curated published annotations for a specific piece of content. To retrieve these specific annotations it calls [UPP Public Annotations API](https://github.com/Financial-Times/public-annotations-api) using the "lifecycle" parameter.
-If the operation is successful, the application returns the canonicalized input body with an HTTP 200 response code.
-
-This is an example response body:
-```
-{
-      "annotations":[
-      {
-        "predicate": "http://www.ft.com/ontology/annotation/hasContributor",
-        "id": "http://www.ft.com/thing/5bd49568-6d7c-3c10-a5b0-2f3fd5974a6b",
-      },
-      {
-        "predicate": "http://www.ft.com/ontology/annotation/about",
-        "id": "http://www.ft.com/thing/d7de27f8-1633-3fcc-b308-c95a2ad7d1cd",
-      },
-      {
-        "predicate": "http://www.ft.com/ontology/annotation/hasDisplayTag",
-        "id": "http://www.ft.com/thing/d7de27f8-1633-3fcc-b308-c95a2ad7d1cd",
-      }
-    ]
-}
-```
+If the operation is successful, the application returns an HTTP 200 response code.
 
 ### PATCH - Replacing draft editorial annotations
 
@@ -250,27 +210,7 @@ curl http://localhost:8080/drafts/content/{content-uuid}/annotations/{concept-uu
 
 A PATCH request on this endpoint replaces all annotations for a single concept in the editorially curated published annotations for a specific piece of content. To retrieve these annotations it calls [UPP Public Annotations API](https://github.com/Financial-Times/public-annotations-api) using the "lifecycle" parameter.
 The new list of draft annotations will override any unpublished draft annotations for this piece of content.
-If the operation is successful, the application returns the canonicalized input body with an HTTP 200 response code.
-
-This is an example response body:
-```
-{
-      "annotations":[
-      {
-        "predicate": "http://www.ft.com/ontology/annotation/hasContributor",
-        "id": "http://www.ft.com/thing/5bd49568-6d7c-3c10-a5b0-2f3fd5974a6b",
-      },
-      {
-        "predicate": "http://www.ft.com/ontology/annotation/about",
-        "id": "http://www.ft.com/thing/d7de27f8-1633-3fcc-b308-c95a2ad7d1cd",
-      },
-      {
-        "predicate": "http://www.ft.com/ontology/annotation/hasDisplayTag",
-        "id": "http://www.ft.com/thing/d7de27f8-1633-3fcc-b308-c95a2ad7d1cd",
-      }
-    ]
-}
-```
+If the operation is successful, the application returns an HTTP 200 response code.
 
 ## Healthchecks
 

diff --git a/_ft/api.yml b/_ft/api.yml
@@ -126,8 +126,6 @@ paths:
         - Public API
       consumes:
         - application/json
-      produces:
-        - application/json
       parameters:
         - name: uuid
           in: path
@@ -158,12 +156,7 @@ paths:
               - predicate
       responses:
         200:
-          description: Returns a canonicalized array of annotations that have been successufully saved in PAC.
-          examples:
-            application/json:
-              annotations:
-                - id: http://api.ft.com/thing/d7113d1d-ed66-3adf-9910-1f62b2c40e6a
-                  predicate: http://www.ft.com/ontology/annotation/about
+          description: The annotation was successfully saved to the cannonicalized list of annotations in PAC.
         400:
           description: Invalid content UUID, concept UUID or predicate supplied.
         404:
@@ -176,8 +169,6 @@ paths:
       description: Returns the draft annotations for the content after the delete operation.
       tags:
         - Public API
-      produces:
-        - application/json
       parameters:
         - name: uuid
           in: path
@@ -193,12 +184,7 @@ paths:
           x-example: 0667615f-499e-4fa6-8130-f3430450228d
       responses:
         200:
-          description: Returns the canonicalized array of annotations that have been successufully saved in PAC.
-          examples:
-            application/json:
-              annotations:
-                - id: http://api.ft.com/things/5507ab98-b747-3ebc-b816-11603b9009f4
-                  predicate: http://www.ft.com/ontology/annotation/about
+          description: The annotation was successfully deleted from the cannonicalized list of annotations in PAC.
         400:
           description: Invalid content or concept UUID supplied
         404:
@@ -212,8 +198,6 @@ paths:
         - Public API
       consumes:
         - application/json
-      produces:
-        - application/json
       parameters:
         - name: uuid
           in: path
@@ -249,12 +233,7 @@ paths:
               - id
       responses:
         200:
-          description: Returns the canonicalized array of annotations that have been successfully saved in PAC.
-          examples:
-            application/json:
-              annotations:
-                - id: http://api.ft.com/things/d7113d1d-ed66-3adf-9910-1f62b2c40e6a
-                  predicate: http://www.ft.com/ontology/annotation/mentions
+          description: The annotation was successfully replaced in the cannonicalized list of annotations in PAC.
         400:
           description: Invalid content or concept UUID supplied
         404:

diff --git a/handler/handler.go b/handler/handler.go
@@ -166,11 +166,6 @@ func (h *Handler) saveAndReturnAnnotations(ctx context.Context, w http.ResponseW
 	}
 
 	w.Header().Set(annotations.DocumentHashHeader, newHash)
-	err = json.NewEncoder(w).Encode(newAnnotations)
-	if err != nil {
-		handleWriteErrors("Error encoding draft annotations response", err, writeLog, w, http.StatusInternalServerError)
-		return
-	}
 }
 
 // ReadAnnotations gets the annotations for a given content uuid.

diff --git a/handler/handler_test.go b/handler/handler_test.go
@@ -838,12 +838,6 @@ func TestHappyDeleteAnnotations(t *testing.T) {
 	r.ServeHTTP(w, req)
 	resp := w.Result()
 	assert.Equal(t, http.StatusOK, resp.StatusCode)
-
-	actual := annotations.Annotations{}
-	err := json.NewDecoder(resp.Body).Decode(&actual)
-	assert.NoError(t, err)
-
-	assert.Equal(t, expectedCanonicalisedAnnotationsAfterDelete, actual)
 	assert.Equal(t, newHash, resp.Header.Get(annotations.DocumentHashHeader))
 
 	rw.AssertExpectations(t)
@@ -978,12 +972,6 @@ func TestHappyAddAnnotation(t *testing.T) {
 	r.ServeHTTP(w, req)
 	resp := w.Result()
 	assert.Equal(t, http.StatusOK, resp.StatusCode)
-
-	actual := annotations.Annotations{}
-	err := json.NewDecoder(resp.Body).Decode(&actual)
-	assert.NoError(t, err)
-
-	assert.Equal(t, actual, expectedCanonicalisedAnnotationsAfterAdditon)
 	assert.Equal(t, newHash, resp.Header.Get(annotations.DocumentHashHeader))
 
 	rw.AssertExpectations(t)
@@ -1025,12 +1013,6 @@ func TestHappyAddExistingAnnotation(t *testing.T) {
 	r.ServeHTTP(w, req)
 	resp := w.Result()
 	assert.Equal(t, http.StatusOK, resp.StatusCode)
-
-	actual := annotations.Annotations{}
-	err := json.NewDecoder(resp.Body).Decode(&actual)
-	assert.NoError(t, err)
-
-	assert.Equal(t, expectedCanonicalisedAnnotationsBody, actual)
 	assert.Equal(t, newHash, resp.Header.Get(annotations.DocumentHashHeader))
 
 	rw.AssertExpectations(t)
@@ -1071,12 +1053,6 @@ func TestHappyAddAnnotationWithExistingConceptIdDifferentPredicate(t *testing.T)
 	r.ServeHTTP(w, req)
 	resp := w.Result()
 	assert.Equal(t, http.StatusOK, resp.StatusCode)
-
-	actual := annotations.Annotations{}
-	err := json.NewDecoder(resp.Body).Decode(&actual)
-	assert.NoError(t, err)
-
-	assert.Equal(t, expectedCanonicalisedAnnotationsSameConceptId, actual)
 	assert.Equal(t, newHash, resp.Header.Get(annotations.DocumentHashHeader))
 
 	rw.AssertExpectations(t)
@@ -1319,6 +1295,7 @@ func TestHappyReplaceAnnotation(t *testing.T) {
 	r.ServeHTTP(w, req)
 	resp := w.Result()
 	assert.Equal(t, http.StatusOK, resp.StatusCode)
+	assert.Equal(t, newHash, resp.Header.Get(annotations.DocumentHashHeader))
 }
 
 func TestHappyReplaceAnnotationWithPredicate(t *testing.T) {
@@ -1383,6 +1360,7 @@ func TestHappyReplaceAnnotationWithPredicate(t *testing.T) {
 	r.ServeHTTP(w, req)
 	resp := w.Result()
 	assert.Equal(t, http.StatusOK, resp.StatusCode)
+	assert.Equal(t, newHash, resp.Header.Get(annotations.DocumentHashHeader))
 }
 
 func TestHappyReplaceExistingAnnotation(t *testing.T) {
@@ -1417,12 +1395,6 @@ func TestHappyReplaceExistingAnnotation(t *testing.T) {
 	r.ServeHTTP(w, req)
 	resp := w.Result()
 	assert.Equal(t, http.StatusOK, resp.StatusCode)
-
-	actual := annotations.Annotations{}
-	err := json.NewDecoder(resp.Body).Decode(&actual)
-	assert.NoError(t, err)
-
-	assert.Equal(t, expectedAnnotationsReplaceExisting, actual)
 	assert.Equal(t, newHash, resp.Header.Get(annotations.DocumentHashHeader))
 
 	rw.AssertExpectations(t)