-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
swagger: Move @OpenAPIDefinition in own class
Before this patch, the application level swagger @OpenAPIDefinition was arbitrarily added to the DataProviderService class, because only one class can specify that. This patch creates a new class TcOpenApiResource that extends the class OpenApiResource that is used to enable the swagger end-point. With this new class a central class is used for application level swagger definitions. Change-Id: Ie42e9614ebe80ad58339d79d664f17b692f77539 Signed-off-by: Bernd Hufmann <bernd.hufmann@ericsson.com> Reviewed-on: https://git.eclipse.org/r/c/tracecompass.incubator/org.eclipse.tracecompass.incubator/+/204787 Tested-by: Patrick Tasse <patrick.tasse@gmail.com> Tested-by: Trace Compass Bot <tracecompass-bot@eclipse.org> Reviewed-by: Patrick Tasse <patrick.tasse@gmail.com>
- Loading branch information
Showing
3 changed files
with
62 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
60 changes: 60 additions & 0 deletions
60
...incubator/internal/trace/server/jersey/rest/core/services/TraceServerOpenApiResource.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| /******************************************************************************* | ||
| * 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.services; | ||
|
|
||
| import static org.eclipse.tracecompass.incubator.internal.trace.server.jersey.rest.core.services.EndpointConstants.ANN; | ||
| import static org.eclipse.tracecompass.incubator.internal.trace.server.jersey.rest.core.services.EndpointConstants.CFG; | ||
| import static org.eclipse.tracecompass.incubator.internal.trace.server.jersey.rest.core.services.EndpointConstants.DESC; | ||
| import static org.eclipse.tracecompass.incubator.internal.trace.server.jersey.rest.core.services.EndpointConstants.DIA; | ||
| import static org.eclipse.tracecompass.incubator.internal.trace.server.jersey.rest.core.services.EndpointConstants.DT; | ||
| import static org.eclipse.tracecompass.incubator.internal.trace.server.jersey.rest.core.services.EndpointConstants.EMAIL; | ||
| import static org.eclipse.tracecompass.incubator.internal.trace.server.jersey.rest.core.services.EndpointConstants.EXP; | ||
| import static org.eclipse.tracecompass.incubator.internal.trace.server.jersey.rest.core.services.EndpointConstants.LICENSE; | ||
| import static org.eclipse.tracecompass.incubator.internal.trace.server.jersey.rest.core.services.EndpointConstants.LICENSE_URL; | ||
| import static org.eclipse.tracecompass.incubator.internal.trace.server.jersey.rest.core.services.EndpointConstants.SERVER; | ||
| import static org.eclipse.tracecompass.incubator.internal.trace.server.jersey.rest.core.services.EndpointConstants.STY; | ||
| import static org.eclipse.tracecompass.incubator.internal.trace.server.jersey.rest.core.services.EndpointConstants.TERMS; | ||
| import static org.eclipse.tracecompass.incubator.internal.trace.server.jersey.rest.core.services.EndpointConstants.TGR; | ||
| import static org.eclipse.tracecompass.incubator.internal.trace.server.jersey.rest.core.services.EndpointConstants.TITLE; | ||
| import static org.eclipse.tracecompass.incubator.internal.trace.server.jersey.rest.core.services.EndpointConstants.TRA; | ||
| import static org.eclipse.tracecompass.incubator.internal.trace.server.jersey.rest.core.services.EndpointConstants.VERSION; | ||
| import static org.eclipse.tracecompass.incubator.internal.trace.server.jersey.rest.core.services.EndpointConstants.VTB; | ||
| import static org.eclipse.tracecompass.incubator.internal.trace.server.jersey.rest.core.services.EndpointConstants.X_Y; | ||
|
|
||
| import io.swagger.v3.jaxrs2.integration.resources.OpenApiResource; | ||
| import io.swagger.v3.oas.annotations.OpenAPIDefinition; | ||
| import io.swagger.v3.oas.annotations.info.Contact; | ||
| import io.swagger.v3.oas.annotations.info.Info; | ||
| import io.swagger.v3.oas.annotations.info.License; | ||
| import io.swagger.v3.oas.annotations.servers.Server; | ||
| import io.swagger.v3.oas.annotations.tags.Tag; | ||
|
|
||
| /** | ||
| * Class extending {@link OpenApiResource} and providing application level open | ||
| * API definitions for the Trace Compass trace server. | ||
| */ | ||
| @OpenAPIDefinition(info = @Info(title = TITLE, description = DESC, termsOfService = TERMS, contact = @Contact(email = EMAIL), license = @License(name = LICENSE, url = LICENSE_URL), version = VERSION), servers = { | ||
| @Server(url = SERVER) | ||
| }, tags = { | ||
| @Tag(name = ANN, description = "Retrieve annotations for different outputs."), | ||
| @Tag(name = CFG, description = "How to manage configuration source types and configurations."), | ||
| @Tag(name = DIA, description = "Refer to the server's status."), | ||
| @Tag(name = DT, description = "Learn about querying data tree models (e.g. for statistics)."), | ||
| @Tag(name = EXP, description = "How to manage experiments on your server; an experiment represents a collection of traces, which can produce output models."), | ||
| @Tag(name = STY, description = "Retrieve styles for different outputs."), | ||
| @Tag(name = TGR, description = "Learn about querying Time Graph models."), | ||
| @Tag(name = TRA, description = "How to manage physical traces on your server."), | ||
| @Tag(name = VTB, description = "Learn about querying virtual table models (e.g. Events Table)."), | ||
| @Tag(name = X_Y, description = "Learn about querying XY models.") | ||
| }) | ||
| public class TraceServerOpenApiResource extends OpenApiResource { | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters