Skip to content

Commit 75eccec

Browse files
committed
swagger: Document meaning of value -1 for parentId of TreeDataModel
Fixes eclipse-cdt-cloud/trace-server-protocol#65 Signed-off-by: Bernd Hufmann <[email protected]>
1 parent ed4fc6a commit 75eccec

File tree

1 file changed

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

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,13 @@ public interface TreeDataModel {
2828
/**
2929
* @return The ID.
3030
*/
31-
@Schema(description = "Unique id to identify this entry in the backend", required = true)
31+
@Schema(description = "Unique ID to identify this entry in the backend", required = true)
3232
long getId();
3333

3434
/**
3535
* @return The parent ID.
3636
*/
37-
@Schema(description = "Unique id to identify this parent's entry, " +
38-
"optional if this entry does not have a parent.")
37+
@Schema(description = "Optional unique ID to identify this entry's parent. If the parent ID is -1 or omitted, this entry has no parent.")
3938
long getParentId();
4039

4140
/**

0 commit comments

Comments
 (0)