Skip to content

Commit 6159498

Browse files
committed
server: Update swagger schema for BookmarkQueryParameters
Since the BookmarkServiceManager class is mentioning the BookmarkQueryParameters for its endpoints, the actual swagger documentation was not aligned with it. Now, the swagger documentation (schema) is same as its implementation and usage. [Fixed] Incorrect swagger documentation for BookmarkQueryParameters is fixed Signed-off-by: Kaveh Shahedi <kaveh.shahedi@ericsson.com>
1 parent 06c61d7 commit 6159498

File tree

1 file changed

+29
-13
lines changed
  • trace-server/org.eclipse.tracecompass.incubator.trace.server.jersey.rest.core/src/org/eclipse/tracecompass/incubator/internal/trace/server/jersey/rest/core/model

1 file changed

+29
-13
lines changed

trace-server/org.eclipse.tracecompass.incubator.trace.server.jersey.rest.core/src/org/eclipse/tracecompass/incubator/internal/trace/server/jersey/rest/core/model/BookmarkQueryParameters.java

Lines changed: 29 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010
*******************************************************************************/
1111
package org.eclipse.tracecompass.incubator.internal.trace.server.jersey.rest.core.model;
1212

13+
import com.fasterxml.jackson.annotation.JsonProperty;
14+
1315
import io.swagger.v3.oas.annotations.media.Schema;
1416
import io.swagger.v3.oas.annotations.media.Schema.RequiredMode;
1517

@@ -20,21 +22,35 @@
2022
* @since 10.1
2123
*/
2224
public interface BookmarkQueryParameters {
23-
/**
24-
* @return The bookmark name
25-
*/
26-
@Schema(description = "The name to give this bookmark", requiredMode = RequiredMode.REQUIRED)
27-
String getName();
2825

2926
/**
30-
* @return The start time
27+
* @return The bookmark parameters
3128
*/
32-
@Schema(description = "The bookmark's start time", requiredMode = RequiredMode.REQUIRED)
33-
long getStart();
29+
@JsonProperty("parameters")
30+
@Schema(description = "The bookmark parameters", requiredMode = RequiredMode.REQUIRED)
31+
BookmarkParameters getParameters();
3432

35-
/**
36-
* @return The end time
37-
*/
38-
@Schema(description = "The bookmark's end time", requiredMode = RequiredMode.REQUIRED)
39-
long getEnd();
33+
34+
interface BookmarkParameters {
35+
/**
36+
* @return The bookmark name
37+
*/
38+
@JsonProperty("name")
39+
@Schema(description = "The name to give this bookmark", requiredMode = RequiredMode.REQUIRED)
40+
String getName();
41+
42+
/**
43+
* @return The start time
44+
*/
45+
@JsonProperty("start")
46+
@Schema(description = "The bookmark's start time", requiredMode = RequiredMode.REQUIRED)
47+
long getStart();
48+
49+
/**
50+
* @return The end time
51+
*/
52+
@JsonProperty("end")
53+
@Schema(description = "The bookmark's end time", requiredMode = RequiredMode.REQUIRED)
54+
long getEnd();
55+
}
4056
}

0 commit comments

Comments
 (0)