Skip to content

Commit bba9bd7

Browse files
committed
swagger: Clarify optional parameter autoExpandLevel
This parameter is optional but the description didn't clarify that and didn't mention the default value if it's omitted. Signed-off-by: Bernd Hufmann <bernd.hufmann@ericsson.com>
1 parent 0ee6201 commit bba9bd7

File tree

1 file changed

+3
-2
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

+3
-2
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/TreeEntryModel.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,11 @@ public interface TreeEntryModel {
3838
/**
3939
* @return The auto-expand level.
4040
*/
41-
@Schema(description = "Sets the auto-expand level to be used for the input of the tree. The "
41+
@Schema(description = "Optional auto-expand level to be used for the input of the tree. "
42+
+ "If omitted or value -1 means that all subtrees should be expanded. The "
4243
+ "value 0 means that there is no auto-expand; 1 means that top-level "
4344
+ "elements are expanded, but not their children; 2 means that top-level "
4445
+ "elements are expanded, and their children, but not grand-children; and so "
45-
+ "on. The value -1 means that all subtrees should be expanded.")
46+
+ "on.")
4647
int getAutoExpandLevel();
4748
}

0 commit comments

Comments
 (0)