Provide 2 TSP specifications for currently supported APIs and proposed APIs #61
Assignees
Comments
|
This change is meant as the first step towards addressing this issue, to compare its now generated api with otherwise manually documented TSP(s). |
christophebedard
pushed a commit
to christophebedard/tracecompass-incubator
that referenced
this issue
Sep 27, 2021
Add the registration of OpenApiResource to support [1]'s both endpoints,
based on [2] (references below). Do not add AcceptHeaderOpenApiResource
for now though, as it is likely not required. This change allows to get
either the json or yaml versions of the hereby (automatically) crawled
OpenAPI endpoints ([2]).
Add io.swagger.core.v3.swagger-jaxrs2 to MANIFEST, to resolve the hereby
added imports in WebApplication, while editing the latter in Eclipse.
Add the necessary jar file to the tracecompass-incubator-master target,
along with the traceserver.product file, to resolve everything new here.
However, only io.swagger.core.v3.swagger-jaxrs2 is a brand new Eclipse
dependency. Using dash-licenses [3] locally to check this added 2.1.10
(currently latest) version outputs this:
[main] INFO Querying Eclipse Foundation for license data for 1 items.
[main] INFO Found 0 items.
[main] INFO Querying ClearlyDefined for license data for 1 items.
[main] INFO Found 1 items.
Vetted license information was found for all content.
No further investigation is required.
Amending the 2020-06 target file in turn is left as another change. This
change is meant as the first step towards addressing [4], to compare its
now generated api with otherwise manually documented TSP(s).
[1] http://localhost:8080/tsp/api/openapi{.json,.yaml}
[2] https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-configuration#openapiresource
[3] https://github.com/eclipse/dash-licenses
[4] eclipse-cdt-cloud/trace-server-protocol#61
Change-Id: I7cbc64347d46378ec1bd5d99b6a116126ad9f455
Signed-off-by: Marco Miller <marco.miller@ericsson.com>
Reviewed-on: https://git.eclipse.org/r/c/tracecompass.incubator/org.eclipse.tracecompass.incubator/+/185637
Tested-by: Trace Compass Bot <tracecompass-bot@eclipse.org>
Tested-by: Bernd Hufmann <bernd.hufmann@ericsson.com>
Tested-by: Matthew Khouzam <matthew.khouzam@ericsson.com>
Reviewed-by: Bernd Hufmann <bernd.hufmann@ericsson.com>
Reviewed-by: Matthew Khouzam <matthew.khouzam@ericsson.com>
|
This was referenced Sep 29, 2021
|
More related WIP. |
christophebedard
pushed a commit
to christophebedard/tracecompass-incubator
that referenced
this issue
Oct 13, 2021
Base these annotations on below [1]'s manually documented content. This change is part of solving [2] among other changes and more to come. It is based on [3]. Reference [4]'s README change explains how to test it. Add these constant yet related strings using EndpointConstants. Formatting is the default one coming with this Eclipse project. Comparing [1]'s contents with this change, only typos found in [1] were fixed herein. The original content previously documented through [1] is kept in this change, for this initial step that is. There are more such annotations to come, to keep aligning this yaml with [1]'s and beyond. [1] https://github.com/theia-ide/trace-server-protocol/blob/master/API.yaml [2] eclipse-cdt-cloud/trace-server-protocol#61 [3] https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Annotations#open-api-specification-annotations [4] eclipse-cdt-cloud/trace-server-protocol#62 Change-Id: I9fff048e848ed00b92dae6605effc01c08e3537c Signed-off-by: Marco Miller <marco.miller@ericsson.com> Reviewed-on: https://git.eclipse.org/r/c/tracecompass.incubator/org.eclipse.tracecompass.incubator/+/186025 Tested-by: Trace Compass Bot <tracecompass-bot@eclipse.org> Tested-by: Bernd Hufmann <bernd.hufmann@ericsson.com> Reviewed-by: Bernd Hufmann <bernd.hufmann@ericsson.com> Reviewed-by: Patrick Tasse <patrick.tasse@gmail.com>
marco-miller
added a commit
that referenced
this issue
Oct 13, 2021
Add the yaml file currently generated by the Swagger endpoint recently added to trace-server. This yaml file is the openapi or TSP that server currently implements, explicitly in the code. This yaml file differs from API.yaml which has been manually documented up until now. Hence, the hereby added openapi.yaml is the true current (reference) TSP, as opposed to API.yaml's purposely edited one. Add a corresponding README section that explains the full context, while listing steps to undertake and current ways of generating openapi.yaml. This change assumes a companion commit in the gh-pages branch, that adds a ./swagger/index.html file linking to this new openapi.yaml file. That added index file is likely a copy of ./index.html in gh-pages, only not pointing to API.yaml as such. Fixes #61 partially as first steps. Signed-off-by: Marco Miller <marco.miller@ericsson.com>
marco-miller
added a commit
that referenced
this issue
Oct 13, 2021
This change is the companion of the master branch commit that introduces openapi.yaml as the alternate TSP version. This is the TSP documented by Swagger now supported directly in trace-server. As explained in that master commit's message, these alternate GH pages for TSP show the true endpoints currently implemented in server. There is that plan to further align the former manual API.yaml with this generated openapi.yaml, step-wise. The master branch with that companion commit is to be merged in this branch, as usual. That merge should bring the companion openapi.yaml file and README instructions along. Fixes #61 partially as first steps. Signed-off-by: Marco Miller <marco.miller@ericsson.com>
|
The second, recently introduced alternate TSP version (spec) continues as WIP for the following weeks. Hence keeping this Issue open and assigned as more progress unfolds. |
marco-miller
added a commit
that referenced
this issue
Nov 25, 2021
This change brings trace-server's [1] version of the TSP OpenApi herein. It is therefore a continuation of [2]'s WIP. Reference [2] already explains the context and usage of the hereby changed openapi.yaml file. Contributes to fixing #61 partially as another incremental step. [1] https://git.eclipse.org/r/c/tracecompass.incubator/org.eclipse.tracecompass.incubator/+/187795 [2] https://github.com/theia-ide/trace-server-protocol#alternate-tsp-version Signed-off-by: Marco Miller <marco.miller@ericsson.com>
marco-miller
added a commit
that referenced
this issue
Dec 2, 2021
This change brings trace-server's [1] version of the TSP OpenApi herein. It is therefore a continuation of [2]'s WIP. Contributes to fixing #61 further as yet another incremental step. [1] https://git.eclipse.org/r/c/tracecompass.incubator/org.eclipse.tracecompass.incubator/+/186626 [2] https://github.com/theia-ide/trace-server-protocol#alternate-tsp-version Signed-off-by: Marco Miller <marco.miller@ericsson.com>
marco-miller
added a commit
that referenced
this issue
Dec 8, 2021
This change brings trace-server's [1] version of the TSP OpenApi herein. It is therefore a continuation of [2]'s WIP. Contributes to fixing #61 further as yet another incremental step. [1] https://git.eclipse.org/r/c/tracecompass.incubator/org.eclipse.tracecompass.incubator/+/186792 [2] https://github.com/theia-ide/trace-server-protocol#alternate-tsp-version Signed-off-by: Marco Miller marco.miller@ericsson.com
marco-miller
added a commit
that referenced
this issue
Dec 22, 2021
This change brings trace-server's [1] version of the TSP OpenApi herein. It is therefore a continuation of [2]'s WIP. Contributes to fixing #61 further as yet another incremental step. [1] https://git.eclipse.org/r/c/tracecompass.incubator/org.eclipse.tracecompass.incubator/+/188661 [2] https://github.com/theia-ide/trace-server-protocol#alternate-tsp-version Signed-off-by: Marco Miller <marco.miller@ericsson.com>
marco-miller
added a commit
that referenced
this issue
Dec 22, 2021
This change brings trace-server's [1] version of the TSP OpenApi herein. It is therefore a continuation of [2]'s WIP. Contributes to fixing #61 further as yet another incremental step. [1] https://git.eclipse.org/r/c/tracecompass.incubator/org.eclipse.tracecompass.incubator/+/188933 [2] https://github.com/theia-ide/trace-server-protocol#alternate-tsp-version Signed-off-by: Marco Miller <marco.miller@ericsson.com>
marco-miller
added a commit
that referenced
this issue
Dec 22, 2021
This change brings trace-server's [1] version of the TSP OpenApi herein. It is therefore a continuation of [2]'s WIP. Contributes to fixing #61 further as yet another incremental step. [1] https://git.eclipse.org/r/c/tracecompass.incubator/org.eclipse.tracecompass.incubator/+/188936 [2] https://github.com/theia-ide/trace-server-protocol#alternate-tsp-version Signed-off-by: Marco Miller <marco.miller@ericsson.com>
marco-miller
added a commit
that referenced
this issue
Dec 22, 2021
This change brings trace-server's [1] version of the TSP OpenApi herein. It is therefore a continuation of [2]'s WIP. Contributes to fixing #61 further as yet another incremental step. [1] https://git.eclipse.org/r/c/tracecompass.incubator/org.eclipse.tracecompass.incubator/+/188971 [2] https://github.com/theia-ide/trace-server-protocol#alternate-tsp-version Signed-off-by: Marco Miller <marco.miller@ericsson.com>
marco-miller
added a commit
that referenced
this issue
Dec 22, 2021
This change brings trace-server's [1] version of the TSP OpenApi herein. It is therefore a continuation of [2]'s WIP. Contributes to fixing #61 further as yet another incremental step. [1] https://git.eclipse.org/r/c/tracecompass.incubator/org.eclipse.tracecompass.incubator/+/188975 [2] https://github.com/theia-ide/trace-server-protocol#alternate-tsp-version Signed-off-by: Marco Miller <marco.miller@ericsson.com>
marco-miller
added a commit
that referenced
this issue
Dec 22, 2021
This change brings trace-server's [1] version of the TSP OpenApi herein. It is therefore a continuation of [2]'s WIP. Contributes to fixing #61 further as yet another incremental step. [1] https://git.eclipse.org/r/c/tracecompass.incubator/org.eclipse.tracecompass.incubator/+/188977 [2] https://github.com/theia-ide/trace-server-protocol#alternate-tsp-version Signed-off-by: Marco Miller <marco.miller@ericsson.com>
marco-miller
added a commit
that referenced
this issue
Dec 22, 2021
This change brings trace-server's [1] version of the TSP OpenApi herein. It is therefore a continuation of [2]'s WIP. Contributes to fixing #61 further as yet another incremental step. [1] https://git.eclipse.org/r/c/tracecompass.incubator/org.eclipse.tracecompass.incubator/+/189007 [2] https://github.com/theia-ide/trace-server-protocol#alternate-tsp-version Signed-off-by: Marco Miller <marco.miller@ericsson.com>
marco-miller
added a commit
that referenced
this issue
Dec 22, 2021
This change brings trace-server's [1] version of the TSP OpenApi herein. It is therefore a continuation of [2]'s WIP. Contributes to fixing #61 further as yet another incremental step. [1] https://git.eclipse.org/r/c/tracecompass.incubator/org.eclipse.tracecompass.incubator/+/189038 [2] https://github.com/theia-ide/trace-server-protocol#alternate-tsp-version Signed-off-by: Marco Miller <marco.miller@ericsson.com>
marco-miller
added a commit
that referenced
this issue
Dec 22, 2021
This change brings trace-server's [1] version of the TSP OpenApi herein. It is therefore a continuation of [2]'s WIP. Contributes to fixing #61 further as yet another incremental step. [1] https://git.eclipse.org/r/c/tracecompass.incubator/org.eclipse.tracecompass.incubator/+/189058 [2] https://github.com/theia-ide/trace-server-protocol#alternate-tsp-version Signed-off-by: Marco Miller <marco.miller@ericsson.com>
marco-miller
added a commit
that referenced
this issue
Dec 22, 2021
This change brings trace-server's [1] version of the TSP OpenApi herein. It is therefore a continuation of [2]'s WIP. Contributes to fixing #61 further as yet another incremental step. [1] https://git.eclipse.org/r/c/tracecompass.incubator/org.eclipse.tracecompass.incubator/+/189066 [2] https://github.com/theia-ide/trace-server-protocol#alternate-tsp-version Signed-off-by: Marco Miller <marco.miller@ericsson.com>
marco-miller
added a commit
that referenced
this issue
Dec 22, 2021
This change brings trace-server's [1] version of the TSP OpenApi herein. It is therefore a continuation of [2]'s WIP. Contributes to fixing #61 further as yet another incremental step. [1] https://git.eclipse.org/r/c/tracecompass.incubator/org.eclipse.tracecompass.incubator/+/189067 [2] https://github.com/theia-ide/trace-server-protocol#alternate-tsp-version Signed-off-by: Marco Miller <marco.miller@ericsson.com>
bhufmann
added a commit
to bhufmann/trace-server-protocol
that referenced
this issue
Feb 22, 2022
Fixes eclipse-cdt-cloud#61 Signed-off-by: Bernd Hufmann <Bernd.Hufmann@ericsson.com>
bhufmann
added a commit
to bhufmann/trace-server-protocol
that referenced
this issue
Feb 24, 2022
Fixes eclipse-cdt-cloud#61 Signed-off-by: Bernd Hufmann <Bernd.Hufmann@ericsson.com>
bhufmann
added a commit
to bhufmann/trace-server-protocol
that referenced
this issue
Mar 15, 2022
Fixes eclipse-cdt-cloud#61 Signed-off-by: Bernd Hufmann <Bernd.Hufmann@ericsson.com>
bhufmann
added a commit
to bhufmann/trace-server-protocol
that referenced
this issue
Mar 16, 2022
Fixes eclipse-cdt-cloud#61 Signed-off-by: Bernd Hufmann <Bernd.Hufmann@ericsson.com>
bhufmann
added a commit
to bhufmann/trace-server-protocol
that referenced
this issue
Mar 17, 2022
Fixes eclipse-cdt-cloud#61 Signed-off-by: Bernd Hufmann <Bernd.Hufmann@ericsson.com>
bhufmann
added a commit
to bhufmann/trace-server-protocol
that referenced
this issue
Mar 17, 2022
Fixes eclipse-cdt-cloud#61 Signed-off-by: Bernd Hufmann <Bernd.Hufmann@ericsson.com>
bhufmann
added a commit
to bhufmann/trace-server-protocol
that referenced
this issue
Mar 18, 2022
Fixes eclipse-cdt-cloud#61 Signed-off-by: Bernd Hufmann <Bernd.Hufmann@ericsson.com>
bhufmann
added a commit
to bhufmann/trace-server-protocol
that referenced
this issue
Mar 18, 2022
Fixes eclipse-cdt-cloud#61 Signed-off-by: Bernd Hufmann <Bernd.Hufmann@ericsson.com>
bhufmann
added a commit
to bhufmann/trace-server-protocol
that referenced
this issue
Mar 18, 2022
Fixes eclipse-cdt-cloud#61 Signed-off-by: Bernd Hufmann <Bernd.Hufmann@ericsson.com>
bhufmann
added a commit
that referenced
this issue
Mar 18, 2022
Fixes #61 Signed-off-by: Bernd Hufmann <Bernd.Hufmann@ericsson.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Right now the TSP specification contains currently supported and used APIs as well as proposed APIs.
The text was updated successfully, but these errors were encountered: