Add content to 404 response

This commit is contained in:
Florian Scholdei
2020-02-24 08:55:17 +01:00
parent 39846314cb
commit 6d9256ed99
8 changed files with 92 additions and 20 deletions

View File

@@ -104,7 +104,13 @@ public class AvailablePluginResource {
) )
@ApiResponse(responseCode = "401", description = "not authenticated / invalid credentials") @ApiResponse(responseCode = "401", description = "not authenticated / invalid credentials")
@ApiResponse(responseCode = "403", description = "not authorized, the current user does not have the \"plugin:read\" privilege") @ApiResponse(responseCode = "403", description = "not authorized, the current user does not have the \"plugin:read\" privilege")
@ApiResponse(responseCode = "404", description = "not found") @ApiResponse(
responseCode = "404",
description = "not found, no plugin with the specified name found",
content = @Content(
mediaType = VndMediaType.ERROR_TYPE,
schema = @Schema(implementation = ErrorDto.class)
))
@ApiResponse( @ApiResponse(
responseCode = "500", responseCode = "500",
description = "internal server error", description = "internal server error",

View File

@@ -82,7 +82,13 @@ public class BranchRootResource {
@ApiResponse(responseCode = "400", description = "branches not supported for given repository") @ApiResponse(responseCode = "400", description = "branches not supported for given repository")
@ApiResponse(responseCode = "401", description = "not authenticated / invalid credentials") @ApiResponse(responseCode = "401", description = "not authenticated / invalid credentials")
@ApiResponse(responseCode = "403", description = "not authorized, the current user has no privileges to read the branch") @ApiResponse(responseCode = "403", description = "not authorized, the current user has no privileges to read the branch")
@ApiResponse(responseCode = "404", description = "not found, no branch with the specified name for the repository available or repository not found") @ApiResponse(
responseCode = "404",
description = "not found, no branch with the specified name for the repository available or repository found",
content = @Content(
mediaType = VndMediaType.ERROR_TYPE,
schema = @Schema(implementation = ErrorDto.class)
))
@ApiResponse( @ApiResponse(
responseCode = "500", responseCode = "500",
description = "internal server error", description = "internal server error",
@@ -122,7 +128,13 @@ public class BranchRootResource {
) )
@ApiResponse(responseCode = "401", description = "not authenticated / invalid credentials") @ApiResponse(responseCode = "401", description = "not authenticated / invalid credentials")
@ApiResponse(responseCode = "403", description = "not authorized, the current user has no privileges to read the changeset") @ApiResponse(responseCode = "403", description = "not authorized, the current user has no privileges to read the changeset")
@ApiResponse(responseCode = "404", description = "not found, no changesets available in the repository") @ApiResponse(
responseCode = "404",
description = "not found, no changesets available in the repository",
content = @Content(
mediaType = VndMediaType.ERROR_TYPE,
schema = @Schema(implementation = ErrorDto.class)
))
@ApiResponse( @ApiResponse(
responseCode = "500", responseCode = "500",
description = "internal server error", description = "internal server error",
@@ -137,7 +149,7 @@ public class BranchRootResource {
@DefaultValue("0") @QueryParam("page") int page, @DefaultValue("0") @QueryParam("page") int page,
@DefaultValue("10") @QueryParam("pageSize") int pageSize) throws IOException { @DefaultValue("10") @QueryParam("pageSize") int pageSize) throws IOException {
try (RepositoryService repositoryService = serviceFactory.create(new NamespaceAndName(namespace, name))) { try (RepositoryService repositoryService = serviceFactory.create(new NamespaceAndName(namespace, name))) {
if (!branchExists(branchName, repositoryService)){ if (!branchExists(branchName, repositoryService)) {
throw notFound(entity(Branch.class, branchName).in(Repository.class, namespace + "/" + name)); throw notFound(entity(Branch.class, branchName).in(Repository.class, namespace + "/" + name));
} }
Repository repository = repositoryService.getRepository(); Repository repository = repositoryService.getRepository();

View File

@@ -59,7 +59,13 @@ public class DiffRootResource {
@ApiResponse(responseCode = "400", description = "bad request") @ApiResponse(responseCode = "400", description = "bad request")
@ApiResponse(responseCode = "401", description = "not authenticated / invalid credentials") @ApiResponse(responseCode = "401", description = "not authenticated / invalid credentials")
@ApiResponse(responseCode = "403", description = "not authorized, the current user has no privileges to read the diff") @ApiResponse(responseCode = "403", description = "not authorized, the current user has no privileges to read the diff")
@ApiResponse(responseCode = "404", description = "not found, no revision with the specified param for the repository available or repository not found") @ApiResponse(
responseCode = "404",
description = "not found, no revision with the specified param for the repository available or repository found",
content = @Content(
mediaType = VndMediaType.ERROR_TYPE,
schema = @Schema(implementation = ErrorDto.class)
))
@ApiResponse( @ApiResponse(
responseCode = "500", responseCode = "500",
description = "internal server error", description = "internal server error",
@@ -97,7 +103,13 @@ public class DiffRootResource {
@ApiResponse(responseCode = "400", description = "bad request") @ApiResponse(responseCode = "400", description = "bad request")
@ApiResponse(responseCode = "401", description = "not authenticated / invalid credentials") @ApiResponse(responseCode = "401", description = "not authenticated / invalid credentials")
@ApiResponse(responseCode = "403", description = "not authorized, the current user has no privileges to read the diff") @ApiResponse(responseCode = "403", description = "not authorized, the current user has no privileges to read the diff")
@ApiResponse(responseCode = "404", description = "not found, no revision with the specified param for the repository available or repository not found") @ApiResponse(
responseCode = "404",
description = "not found, no revision with the specified param for the repository available or repository not found",
content = @Content(
mediaType = VndMediaType.ERROR_TYPE,
schema = @Schema(implementation = ErrorDto.class)
))
@ApiResponse( @ApiResponse(
responseCode = "500", responseCode = "500",
description = "internal server error", description = "internal server error",

View File

@@ -50,7 +50,13 @@ public class GroupPermissionResource {
)) ))
@ApiResponse(responseCode = "401", description = "not authenticated / invalid credentials") @ApiResponse(responseCode = "401", description = "not authenticated / invalid credentials")
@ApiResponse(responseCode = "403", description = "not authorized, the current user has no privileges to read the group") @ApiResponse(responseCode = "403", description = "not authorized, the current user has no privileges to read the group")
@ApiResponse(responseCode = "404", description = "not found, no group with the specified id/name available") @ApiResponse(
responseCode = "404",
description = "not found, no group with the specified id/name available",
content = @Content(
mediaType = VndMediaType.ERROR_TYPE,
schema = @Schema(implementation = ErrorDto.class)
))
@ApiResponse( @ApiResponse(
responseCode = "500", responseCode = "500",
description = "internal server error", description = "internal server error",
@@ -79,7 +85,13 @@ public class GroupPermissionResource {
@ApiResponse(responseCode = "400", description = "invalid body") @ApiResponse(responseCode = "400", description = "invalid body")
@ApiResponse(responseCode = "401", description = "not authenticated / invalid credentials") @ApiResponse(responseCode = "401", description = "not authenticated / invalid credentials")
@ApiResponse(responseCode = "403", description = "not authorized, the current group does not have the correct privilege") @ApiResponse(responseCode = "403", description = "not authorized, the current group does not have the correct privilege")
@ApiResponse(responseCode = "404", description = "not found, no group with the specified id/name available") @ApiResponse(
responseCode = "404",
description = "not found, no group with the specified id/name available",
content = @Content(
mediaType = VndMediaType.ERROR_TYPE,
schema = @Schema(implementation = ErrorDto.class)
))
@ApiResponse( @ApiResponse(
responseCode = "500", responseCode = "500",
description = "internal server error", description = "internal server error",

View File

@@ -56,7 +56,13 @@ public class GroupResource {
) )
@ApiResponse(responseCode = "401", description = "not authenticated / invalid credentials") @ApiResponse(responseCode = "401", description = "not authenticated / invalid credentials")
@ApiResponse(responseCode = "403", description = "not authorized, the current user has no privileges to read the group") @ApiResponse(responseCode = "403", description = "not authorized, the current user has no privileges to read the group")
@ApiResponse(responseCode = "404", description = "not found, no group with the specified id/name available") @ApiResponse(
responseCode = "404",
description = "not found, no group with the specified id/name available",
content = @Content(
mediaType = VndMediaType.ERROR_TYPE,
schema = @Schema(implementation = ErrorDto.class)
))
@ApiResponse( @ApiResponse(
responseCode = "500", responseCode = "500",
description = "internal server error", description = "internal server error",
@@ -110,7 +116,13 @@ public class GroupResource {
@ApiResponse(responseCode = "400", description = "invalid body, e.g. illegal change of id/group name") @ApiResponse(responseCode = "400", description = "invalid body, e.g. illegal change of id/group name")
@ApiResponse(responseCode = "401", description = "not authenticated / invalid credentials") @ApiResponse(responseCode = "401", description = "not authenticated / invalid credentials")
@ApiResponse(responseCode = "403", description = "not authorized, the current user does not have the \"group\" privilege") @ApiResponse(responseCode = "403", description = "not authorized, the current user does not have the \"group\" privilege")
@ApiResponse(responseCode = "404", description = "not found, no group with the specified id/name available") @ApiResponse(
responseCode = "404",
description = "not found, no group with the specified id/name available",
content = @Content(
mediaType = VndMediaType.ERROR_TYPE,
schema = @Schema(implementation = ErrorDto.class)
))
@ApiResponse( @ApiResponse(
responseCode = "500", responseCode = "500",
description = "internal server error", description = "internal server error",

View File

@@ -126,7 +126,13 @@ public class InstalledPluginResource {
) )
@ApiResponse(responseCode = "401", description = "not authenticated / invalid credentials") @ApiResponse(responseCode = "401", description = "not authenticated / invalid credentials")
@ApiResponse(responseCode = "403", description = "not authorized, the current user does not have the \"plugin:read\" privilege") @ApiResponse(responseCode = "403", description = "not authorized, the current user does not have the \"plugin:read\" privilege")
@ApiResponse(responseCode = "404", description = "not found, plugin by given id could not be found") @ApiResponse(
responseCode = "404",
description = "not found, plugin by given id could not be found",
content = @Content(
mediaType = VndMediaType.ERROR_TYPE,
schema = @Schema(implementation = ErrorDto.class)
))
@ApiResponse( @ApiResponse(
responseCode = "500", responseCode = "500",
description = "internal server error", description = "internal server error",

View File

@@ -45,7 +45,13 @@ public class RepositoryTypeResource {
schema = @Schema(implementation = RepositoryTypeDto.class) schema = @Schema(implementation = RepositoryTypeDto.class)
) )
) )
@ApiResponse(responseCode = "404", description = "not found, no repository type with the specified name available") @ApiResponse(
responseCode = "404",
description = "not found, no repository type with the specified name available",
content = @Content(
mediaType = VndMediaType.ERROR_TYPE,
schema = @Schema(implementation = ErrorDto.class)
))
@ApiResponse( @ApiResponse(
responseCode = "500", responseCode = "500",
description = "internal server error", description = "internal server error",

View File

@@ -87,7 +87,13 @@ public class UserPermissionResource {
@ApiResponse(responseCode = "400", description = "invalid body") @ApiResponse(responseCode = "400", description = "invalid body")
@ApiResponse(responseCode = "401", description = "not authenticated / invalid credentials") @ApiResponse(responseCode = "401", description = "not authenticated / invalid credentials")
@ApiResponse(responseCode = "403", description = "not authorized, the current user does not have the correct privilege") @ApiResponse(responseCode = "403", description = "not authorized, the current user does not have the correct privilege")
@ApiResponse(responseCode = "404", description = "not found, no user with the specified id/name available") @ApiResponse(
responseCode = "404",
description = "not found, no user with the specified id/name available",
content = @Content(
mediaType = VndMediaType.ERROR_TYPE,
schema = @Schema(implementation = ErrorDto.class)
))
@ApiResponse( @ApiResponse(
responseCode = "500", responseCode = "500",
description = "internal server error", description = "internal server error",