From a811ccfc91a9766372b3c0fe98960ed369d25460 Mon Sep 17 00:00:00 2001
From: Lars Johansson <lars.johansson@ess.eu>
Date: Mon, 2 May 2022 09:42:43 +0200
Subject: [PATCH] Update http status code handling
Status code 201 Created.
---
src/main/java/org/openepics/names/rest/api/v1/INames.java | 4 ++--
.../java/org/openepics/names/rest/api/v1/IStructures.java | 4 ++--
.../org/openepics/names/rest/controller/NamesController.java | 4 ++--
.../openepics/names/rest/controller/StructuresController.java | 4 ++--
.../java/org/openepics/names/docker/ITUtilNameElement.java | 2 +-
.../org/openepics/names/docker/ITUtilStructureElement.java | 2 +-
6 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/src/main/java/org/openepics/names/rest/api/v1/INames.java b/src/main/java/org/openepics/names/rest/api/v1/INames.java
index 05f413f1..e14b0e5e 100644
--- a/src/main/java/org/openepics/names/rest/api/v1/INames.java
+++ b/src/main/java/org/openepics/names/rest/api/v1/INames.java
@@ -136,7 +136,7 @@ public interface INames {
)
@ApiResponses(value = {
@ApiResponse(
- responseCode = "200",
+ responseCode = "201",
description = "Method completed OK. Return array of created name elements.",
content = @Content(
mediaType = "application/json",
@@ -157,7 +157,7 @@ public interface INames {
@PostMapping(
produces = {"application/json"},
consumes = {"application/json"})
- public List<NameElement> createNames(
+ public ResponseEntity<List<NameElement>> createNames(
@Parameter(
in = ParameterIn.DEFAULT,
description = "array of name elements",
diff --git a/src/main/java/org/openepics/names/rest/api/v1/IStructures.java b/src/main/java/org/openepics/names/rest/api/v1/IStructures.java
index 3b75c3ab..73d6dbf8 100644
--- a/src/main/java/org/openepics/names/rest/api/v1/IStructures.java
+++ b/src/main/java/org/openepics/names/rest/api/v1/IStructures.java
@@ -160,7 +160,7 @@ public interface IStructures {
)
@ApiResponses(value = {
@ApiResponse(
- responseCode = "200",
+ responseCode = "201",
description = "Method completed OK. Return array of structure elements for created structures (proposals).",
content = @Content(
mediaType = "application/json",
@@ -181,7 +181,7 @@ public interface IStructures {
@PostMapping(
produces = {"application/json"},
consumes = {"application/json"})
- public List<StructureElement> createStructures(
+ public ResponseEntity<List<StructureElement>> createStructures(
@Parameter(
in = ParameterIn.DEFAULT,
description = "array of structure elements",
diff --git a/src/main/java/org/openepics/names/rest/controller/NamesController.java b/src/main/java/org/openepics/names/rest/controller/NamesController.java
index eceaad91..5abce3cf 100644
--- a/src/main/java/org/openepics/names/rest/controller/NamesController.java
+++ b/src/main/java/org/openepics/names/rest/controller/NamesController.java
@@ -65,7 +65,7 @@ public class NamesController implements INames {
}
@Override
- public List<NameElement> createNames(List<NameElementCommand> nameElements) {
+ public ResponseEntity<List<NameElement>> createNames(List<NameElementCommand> nameElements) {
// validate authority
// naming user & admin
// validate
@@ -73,7 +73,7 @@ public class NamesController implements INames {
try {
namesService.validateNamesCreate(nameElements);
- return namesService.createNames(nameElements);
+ return new ResponseEntity<>(namesService.createNames(nameElements), Response.HEADER_JSON, HttpStatus.CREATED);
} catch (ServiceHttpStatusException e) {
LogUtil.logServiceHttpStatusException(LOGGER, Level.SEVERE, e);
LogUtil.logStackTraceElements(LOGGER, Level.SEVERE, e);
diff --git a/src/main/java/org/openepics/names/rest/controller/StructuresController.java b/src/main/java/org/openepics/names/rest/controller/StructuresController.java
index 72d4cecc..1ca9d87e 100644
--- a/src/main/java/org/openepics/names/rest/controller/StructuresController.java
+++ b/src/main/java/org/openepics/names/rest/controller/StructuresController.java
@@ -74,7 +74,7 @@ public class StructuresController implements IStructures {
}
@Override
- public List<StructureElement> createStructures(List<StructureElementCommand> structureElements) {
+ public ResponseEntity<List<StructureElement>> createStructures(List<StructureElementCommand> structureElements) {
// validate authority
// naming user & admin
// validate
@@ -82,7 +82,7 @@ public class StructuresController implements IStructures {
try {
structuresService.validateStructuresCreate(structureElements);
- return structuresService.createStructures(structureElements);
+ return new ResponseEntity<>(structuresService.createStructures(structureElements), Response.HEADER_JSON, HttpStatus.CREATED);
} catch (ServiceHttpStatusException e) {
LogUtil.logServiceHttpStatusException(LOGGER, Level.SEVERE, e);
LogUtil.logStackTraceElements(LOGGER, Level.SEVERE, e);
diff --git a/src/test/java/org/openepics/names/docker/ITUtilNameElement.java b/src/test/java/org/openepics/names/docker/ITUtilNameElement.java
index 21bf909e..047fe843 100644
--- a/src/test/java/org/openepics/names/docker/ITUtilNameElement.java
+++ b/src/test/java/org/openepics/names/docker/ITUtilNameElement.java
@@ -470,7 +470,7 @@ public class ITUtilNameElement {
ITUtil.assertEqualsResponseBoolean(mapper.readValue(response[1], ResponseBooleanList.class), Boolean.TRUE);
response = ITUtil.runShellCommand(ITUtil.curlPostPathJson(AuthorizationChoice.NONE, EndpointChoice.NAMES, "", "[" + mapper.writeValueAsString(nameElement) + "]"));
- ITUtil.assertResponseLength2Code(response, HttpURLConnection.HTTP_OK);
+ ITUtil.assertResponseLength2Code(response, HttpURLConnection.HTTP_CREATED);
createdNameElements = mapper.readValue(response[1], NameElement[].class);
createdNameElement = ITUtilNameElement.assertContentLengthOne(createdNameElements);
assertNotNull(createdNameElement.getUuid());
diff --git a/src/test/java/org/openepics/names/docker/ITUtilStructureElement.java b/src/test/java/org/openepics/names/docker/ITUtilStructureElement.java
index 013d109c..fdd64536 100644
--- a/src/test/java/org/openepics/names/docker/ITUtilStructureElement.java
+++ b/src/test/java/org/openepics/names/docker/ITUtilStructureElement.java
@@ -441,7 +441,7 @@ public class ITUtilStructureElement {
ITUtil.assertEqualsResponseBoolean(mapper.readValue(response[1], ResponseBooleanList.class), Boolean.TRUE);
response = ITUtil.runShellCommand(ITUtil.curlPostPathJson(AuthorizationChoice.NONE, EndpointChoice.STRUCTURES, "", "[" + mapper.writeValueAsString(structureElement) + "]"));
- ITUtil.assertResponseLength2Code(response, HttpURLConnection.HTTP_OK);
+ ITUtil.assertResponseLength2Code(response, HttpURLConnection.HTTP_CREATED);
createdStructureElements = mapper.readValue(response[1], StructureElement[].class);
createdStructureElement = ITUtilStructureElement.assertContentLengthOne(createdStructureElements);
assertNotNull(createdStructureElement.getUuid());
--
GitLab