fix several openapi errors

This commit is contained in:
Eduard Heimbuch
2020-03-03 14:49:35 +01:00
parent 04d480684a
commit 5897863f7e
9 changed files with 15 additions and 63 deletions

View File

@@ -51,7 +51,7 @@ public class GitConfigResource {
@GET @GET
@Path("") @Path("")
@Produces(GitVndMediaType.GIT_CONFIG) @Produces(GitVndMediaType.GIT_CONFIG)
@Operation(summary = "Git configuration", description = "Returns the global git configuration.", tags = "Git") @Operation(summary = "Git configuration", description = "Returns the global git configuration.", tags = "Git", operationId = "git_get_config")
@ApiResponse( @ApiResponse(
responseCode = "200", responseCode = "200",
description = "success", description = "success",
@@ -91,11 +91,8 @@ public class GitConfigResource {
@PUT @PUT
@Path("") @Path("")
@Consumes(GitVndMediaType.GIT_CONFIG) @Consumes(GitVndMediaType.GIT_CONFIG)
@Operation(summary = "Modify git configuration", description = "Modifies the global git configuration.", tags = "Git") @Operation(summary = "Modify git configuration", description = "Modifies the global git configuration.", tags = "Git", operationId = "git_put_config")
@ApiResponse( @ApiResponse(responseCode = "204", description = "update success")
responseCode = "204",
description = "update success"
)
@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 \"configuration:write:git\" privilege") @ApiResponse(responseCode = "403", description = "not authorized, the current user does not have the \"configuration:write:git\" privilege")
@ApiResponse( @ApiResponse(

View File

@@ -57,7 +57,7 @@ public class HgConfigResource {
@GET @GET
@Path("") @Path("")
@Produces(HgVndMediaType.CONFIG) @Produces(HgVndMediaType.CONFIG)
@Operation(summary = "Hg configuration", description = "Returns the global mercurial configuration.", tags = "Mercurial") @Operation(summary = "Hg configuration", description = "Returns the global mercurial configuration.", tags = "Mercurial", operationId = "hg_get_config")
@ApiResponse( @ApiResponse(
responseCode = "200", responseCode = "200",
description = "success", description = "success",
@@ -97,7 +97,7 @@ public class HgConfigResource {
@PUT @PUT
@Path("") @Path("")
@Consumes(HgVndMediaType.CONFIG) @Consumes(HgVndMediaType.CONFIG)
@Operation(summary = "Modify hg configuration", description = "Modifies the global mercurial configuration.", tags = "Mercurial") @Operation(summary = "Modify hg configuration", description = "Modifies the global mercurial configuration.", tags = "Mercurial", operationId = "hg_put_config")
@ApiResponse( @ApiResponse(
responseCode = "204", responseCode = "204",
description = "update success" description = "update success"

View File

@@ -48,7 +48,7 @@ public class SvnConfigResource {
@GET @GET
@Path("") @Path("")
@Produces(SvnVndMediaType.SVN_CONFIG) @Produces(SvnVndMediaType.SVN_CONFIG)
@Operation(summary = "Svn configuration", description = "Returns the global subversion configuration.", tags = "Subversion") @Operation(summary = "Svn configuration", description = "Returns the global subversion configuration.", tags = "Subversion", operationId = "svn_get_config")
@ApiResponse( @ApiResponse(
responseCode = "200", responseCode = "200",
description = "success", description = "success",
@@ -88,7 +88,7 @@ public class SvnConfigResource {
@PUT @PUT
@Path("") @Path("")
@Consumes(SvnVndMediaType.SVN_CONFIG) @Consumes(SvnVndMediaType.SVN_CONFIG)
@Operation(summary = "Modify svn configuration", description = "Modifies the global subversion configuration.", tags = "Subversion") @Operation(summary = "Modify svn configuration", description = "Modifies the global subversion configuration.", tags = "Subversion", operationId = "svn_put_config")
@ApiResponse( @ApiResponse(
responseCode = "204", responseCode = "204",
description = "update success" description = "update success"

View File

@@ -2,7 +2,6 @@ package sonia.scm.api.v2.resources;
import com.google.common.base.Strings; import com.google.common.base.Strings;
import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.headers.Header;
import io.swagger.v3.oas.annotations.media.Content; import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema; import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.responses.ApiResponse; import io.swagger.v3.oas.annotations.responses.ApiResponse;
@@ -180,14 +179,7 @@ public class BranchRootResource {
@Path("") @Path("")
@Consumes(VndMediaType.BRANCH_REQUEST) @Consumes(VndMediaType.BRANCH_REQUEST)
@Operation(summary = "Create branch", description = "Creates a new branch.", tags = "Repository") @Operation(summary = "Create branch", description = "Creates a new branch.", tags = "Repository")
@ApiResponse( @ApiResponse(responseCode = "201", description = "create success")
responseCode = "201",
description = "create success",
headers = @Header(
name = "Location",
description = "uri to the created branch"
)
)
@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 \"push\" privilege") @ApiResponse(responseCode = "403", description = "not authorized, the current user does not have the \"push\" privilege")
@ApiResponse(responseCode = "409", description = "conflict, a branch with this name already exists") @ApiResponse(responseCode = "409", description = "conflict, a branch with this name already exists")

View File

@@ -1,7 +1,6 @@
package sonia.scm.api.v2.resources; package sonia.scm.api.v2.resources;
import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.headers.Header;
import io.swagger.v3.oas.annotations.media.Content; import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema; import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.responses.ApiResponse; import io.swagger.v3.oas.annotations.responses.ApiResponse;
@@ -95,15 +94,8 @@ public class GroupCollectionResource {
@POST @POST
@Path("") @Path("")
@Consumes(VndMediaType.GROUP) @Consumes(VndMediaType.GROUP)
@Operation(summary = "Create group", description = "Creates a new group.", tags = "Group") @Operation(summary = "Create group", description = "Creates a new group.", tags = "Group", operationId = "group_create")
@ApiResponse( @ApiResponse(responseCode = "201", description = "create success")
responseCode = "201",
description = "create success",
headers = @Header(
name = "Location",
description = "uri to the created group"
)
)
@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 = "409", description = "conflict, a group with this name already exists") @ApiResponse(responseCode = "409", description = "conflict, a group with this name already exists")

View File

@@ -1,7 +1,6 @@
package sonia.scm.api.v2.resources; package sonia.scm.api.v2.resources;
import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.headers.Header;
import io.swagger.v3.oas.annotations.media.Content; import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema; import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.responses.ApiResponse; import io.swagger.v3.oas.annotations.responses.ApiResponse;
@@ -104,14 +103,7 @@ public class RepositoryCollectionResource {
@Path("") @Path("")
@Consumes(VndMediaType.REPOSITORY) @Consumes(VndMediaType.REPOSITORY)
@Operation(summary = "Create repository", description = "Creates a new repository.", tags = "Repository") @Operation(summary = "Create repository", description = "Creates a new repository.", tags = "Repository")
@ApiResponse( @ApiResponse(responseCode = "201", description = "create success")
responseCode = "201",
description = "create success",
headers = @Header(
name = "Location",
description = "uri to the created 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 does not have the \"repository\" privilege") @ApiResponse(responseCode = "403", description = "not authorized, the current user does not have the \"repository\" privilege")
@ApiResponse(responseCode = "409", description = "conflict, a repository with this name already exists") @ApiResponse(responseCode = "409", description = "conflict, a repository with this name already exists")

View File

@@ -1,7 +1,6 @@
package sonia.scm.api.v2.resources; package sonia.scm.api.v2.resources;
import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.headers.Header;
import io.swagger.v3.oas.annotations.media.Content; import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema; import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.responses.ApiResponse; import io.swagger.v3.oas.annotations.responses.ApiResponse;
@@ -9,9 +8,9 @@ import lombok.extern.slf4j.Slf4j;
import sonia.scm.AlreadyExistsException; import sonia.scm.AlreadyExistsException;
import sonia.scm.NotFoundException; import sonia.scm.NotFoundException;
import sonia.scm.repository.NamespaceAndName; import sonia.scm.repository.NamespaceAndName;
import sonia.scm.repository.RepositoryPermission;
import sonia.scm.repository.Repository; import sonia.scm.repository.Repository;
import sonia.scm.repository.RepositoryManager; import sonia.scm.repository.RepositoryManager;
import sonia.scm.repository.RepositoryPermission;
import sonia.scm.repository.RepositoryPermissions; import sonia.scm.repository.RepositoryPermissions;
import sonia.scm.web.VndMediaType; import sonia.scm.web.VndMediaType;
@@ -68,11 +67,7 @@ public class RepositoryPermissionRootResource {
@Path("") @Path("")
@Consumes(VndMediaType.REPOSITORY_PERMISSION) @Consumes(VndMediaType.REPOSITORY_PERMISSION)
@Operation(summary = "Create repository-specific permission", description = "Adds a new permission to the user or group managed by the repository.", tags = {"Repository", "Permissions"}) @Operation(summary = "Create repository-specific permission", description = "Adds a new permission to the user or group managed by the repository.", tags = {"Repository", "Permissions"})
@ApiResponse( @ApiResponse(responseCode = "201", description = "creates")
responseCode = "201",
description = "creates",
headers = @Header(name = "Location", description = "uri of the created permission")
)
@ApiResponse( @ApiResponse(
responseCode = "404", responseCode = "404",
description = "not found", description = "not found",

View File

@@ -1,7 +1,6 @@
package sonia.scm.api.v2.resources; package sonia.scm.api.v2.resources;
import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.headers.Header;
import io.swagger.v3.oas.annotations.media.Content; import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema; import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.responses.ApiResponse; import io.swagger.v3.oas.annotations.responses.ApiResponse;
@@ -91,14 +90,7 @@ public class RepositoryRoleCollectionResource {
@Path("") @Path("")
@Consumes(VndMediaType.REPOSITORY_ROLE) @Consumes(VndMediaType.REPOSITORY_ROLE)
@Operation(summary = "Create repository role", description = "Creates a new repository role.", tags = "Repository role") @Operation(summary = "Create repository role", description = "Creates a new repository role.", tags = "Repository role")
@ApiResponse( @ApiResponse(responseCode = "201", description = "create success")
responseCode = "201",
description = "create success",
headers = @Header(
name = "Location",
description = "uri to the created repository role"
)
)
@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 \"repositoryRole\" privilege") @ApiResponse(responseCode = "403", description = "not authorized, the current user does not have the \"repositoryRole\" privilege")
@ApiResponse(responseCode = "409", description = "conflict, a repository role with this name already exists") @ApiResponse(responseCode = "409", description = "conflict, a repository role with this name already exists")

View File

@@ -1,7 +1,6 @@
package sonia.scm.api.v2.resources; package sonia.scm.api.v2.resources;
import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.headers.Header;
import io.swagger.v3.oas.annotations.media.Content; import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema; import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.responses.ApiResponse; import io.swagger.v3.oas.annotations.responses.ApiResponse;
@@ -100,14 +99,7 @@ public class UserCollectionResource {
@Path("") @Path("")
@Consumes(VndMediaType.USER) @Consumes(VndMediaType.USER)
@Operation(summary = "Create user", description = "Creates a new user.", tags = "User") @Operation(summary = "Create user", description = "Creates a new user.", tags = "User")
@ApiResponse( @ApiResponse(responseCode = "201", description = "create success")
responseCode = "201",
description = "create success",
headers = @Header(
name = "Location",
description = "uri to the created user"
)
)
@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 \"user\" privilege") @ApiResponse(responseCode = "403", description = "not authorized, the current user does not have the \"user\" privilege")
@ApiResponse(responseCode = "409", description = "conflict, a user with this name already exists") @ApiResponse(responseCode = "409", description = "conflict, a user with this name already exists")