From 10e951c4b1e770bbdbe1a6926aca94f0f0f44264 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Pfeuffer?= Date: Wed, 27 Jun 2018 11:23:08 +0200 Subject: [PATCH] Document return codes --- .../sonia/scm/api/v2/resources/GroupCollectionResource.java | 1 + .../sonia/scm/api/v2/resources/UserCollectionResource.java | 5 ++++- .../main/java/sonia/scm/api/v2/resources/UserResource.java | 1 + 3 files changed, 6 insertions(+), 1 deletion(-) diff --git a/scm-webapp/src/main/java/sonia/scm/api/v2/resources/GroupCollectionResource.java b/scm-webapp/src/main/java/sonia/scm/api/v2/resources/GroupCollectionResource.java index ab23658918..056d8a7857 100644 --- a/scm-webapp/src/main/java/sonia/scm/api/v2/resources/GroupCollectionResource.java +++ b/scm-webapp/src/main/java/sonia/scm/api/v2/resources/GroupCollectionResource.java @@ -80,6 +80,7 @@ public class GroupCollectionResource { @ResponseHeader(name = "Location", description = "uri to the created group") }), @ResponseCode(code = 403, condition = "forbidden, the current user has no admin privileges"), + @ResponseCode(code = 409, condition = "conflict, a group with this name already exists"), @ResponseCode(code = 500, condition = "internal server error") }) @TypeHint(TypeHint.NO_CONTENT.class) diff --git a/scm-webapp/src/main/java/sonia/scm/api/v2/resources/UserCollectionResource.java b/scm-webapp/src/main/java/sonia/scm/api/v2/resources/UserCollectionResource.java index af45fadd4b..980ed9ce06 100644 --- a/scm-webapp/src/main/java/sonia/scm/api/v2/resources/UserCollectionResource.java +++ b/scm-webapp/src/main/java/sonia/scm/api/v2/resources/UserCollectionResource.java @@ -80,8 +80,11 @@ public class UserCollectionResource { @POST @Path("") @StatusCodes({ - @ResponseCode(code = 201, condition = "create success"), + @ResponseCode(code = 201, condition = "create success", additionalHeaders = { + @ResponseHeader(name = "Location", description = "uri to the created user") + }), @ResponseCode(code = 403, condition = "forbidden, the current user does not have the \"user\" privilege"), + @ResponseCode(code = 409, condition = "conflict, a user with this name already exists"), @ResponseCode(code = 500, condition = "internal server error") }) @TypeHint(TypeHint.NO_CONTENT.class) diff --git a/scm-webapp/src/main/java/sonia/scm/api/v2/resources/UserResource.java b/scm-webapp/src/main/java/sonia/scm/api/v2/resources/UserResource.java index 01287e8a12..07008e8e4c 100644 --- a/scm-webapp/src/main/java/sonia/scm/api/v2/resources/UserResource.java +++ b/scm-webapp/src/main/java/sonia/scm/api/v2/resources/UserResource.java @@ -70,6 +70,7 @@ public class UserResource { @StatusCodes({ @ResponseCode(code = 204, condition = "update success"), @ResponseCode(code = 403, condition = "forbidden, the current user does not have the \"user\" privilege"), + @ResponseCode(code = 404, condition = "not found, no user with the specified id/name available"), @ResponseCode(code = 500, condition = "internal server error") }) @TypeHint(TypeHint.NO_CONTENT.class)