server: Add swagger doc for optional XY default entry flag

Bug 581326

[Added] Swagger doc for optional XY default entry flag

Change-Id: Ie47a51cc1f05e4762eeaff34cd14397b7e9f14da
Signed-off-by: Bernd Hufmann <bernd.hufmann@ericsson.com>
Reviewed-on: https://git.eclipse.org/r/c/tracecompass.incubator/org.eclipse.tracecompass.incubator/+/199321
Tested-by: Trace Compass Bot <tracecompass-bot@eclipse.org>
Tested-by: Marco Miller <marco.miller@ericsson.com>
Reviewed-by: Marco Miller <marco.miller@ericsson.com>

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

@@ -0,0 +1,31 @@
+/**********************************************************************
+ * Copyright (c) 2023 Ericsson
+ *
+ * All rights reserved. This program and the accompanying materials are
+ * made available under the terms of the Eclipse Public License 2.0 which
+ * accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ **********************************************************************/
+
+package org.eclipse.tracecompass.incubator.internal.trace.server.jersey.rest.core.model;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+
+/**
+ * Contributes to the model used for TSP swagger-core annotations.
+ */
+@Schema(allOf = TreeDataModel.class)
+public interface XYTreeEntry {
+
+    /**
+     * @return whether or not the entry is a default entry and its xy data
+     *         should be fetched by default.
+     */
+    @JsonProperty("isDefault")
+    @Schema(description = "Optional flag to indicate whether or not the entry is a default entry and its xy data should be fetched by default.")
+    boolean isDefault();
+}

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

@@ -0,0 +1,31 @@
+/**********************************************************************
+ * Copyright (c) 2023 Ericsson
+ *
+ * All rights reserved. This program and the accompanying materials are
+ * made available under the terms of the Eclipse Public License 2.0 which
+ * accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ **********************************************************************/
+
+package org.eclipse.tracecompass.incubator.internal.trace.server.jersey.rest.core.model;
+
+import java.util.List;
+
+import org.eclipse.jdt.annotation.NonNull;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+
+/**
+ * Contributes to the model used for TSP swagger-core annotations.
+ */
+@Schema(allOf = TreeEntryModel.class)
+public interface XYTreeEntryModel {
+
+    /**
+     * @return The entries.
+     */
+    @NonNull
+    List<@NonNull XYTreeEntry> getEntries();
+}

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

@@ -25,5 +25,5 @@ public interface XYTreeResponse {
      * @return The model.
      */
     @Nullable
-    TreeEntryModel getModel();
+    XYTreeEntryModel getModel();
 }