Nemcio/SCM-Manager
1
0
Fork 0
mirror of https://github.com/scm-manager/scm-manager.git synced 2025-11-13 08:55:44 +01:00
Code Issues Packages Projects Releases Activity

Document query parameters

Browse Source
This commit is contained in:
René Pfeuffer
2020-06-10 13:24:42 +02:00
parent e6deecca17
commit 4e69d03678
1 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
scm-webapp/src/main/java/sonia/scm/api/v2/resources/ContentResource.java
View File

@@ -27,6 +27,7 @@ package sonia.scm.api.v2.resources;
import com.github.sdorra.spotter.ContentType; import com.github.sdorra.spotter.ContentType;
import com.github.sdorra.spotter.ContentTypes; import com.github.sdorra.spotter.ContentTypes;
import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
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;
@@ -97,6 +98,17 @@ public class ContentResource {
mediaType = VndMediaType.ERROR_TYPE, mediaType = VndMediaType.ERROR_TYPE,
schema = @Schema(implementation = ErrorDto.class) schema = @Schema(implementation = ErrorDto.class)
)) ))
@Parameter(
name = "start",
description = "If set, the content will be returned from this line on. The first line is line number 0. " +
"If omitted, the output will start with the first line."
)
@Parameter(
name = "end",
description = "If set, the content will be returned excluding the given line number and following." +
"The first line ist line number 0. " +
"If set to -1, no lines will be excluded (this equivalent to omitting this parameter"
)
public Response get( public Response get(
@PathParam("namespace") String namespace, @PathParam("namespace") String namespace,
@PathParam("name") String name, @PathParam("name") String name,