Skip to content

Generate openapi.yaml for Gantt Chart, update README and license/copyright #127

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bhufmann merged 3 commits into from
Jul 18, 2025
Merged

Generate openapi.yaml for Gantt Chart, update README and license/copyright #127

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4713956
Update API and API-proposed with GANTT_CHART
aaanh Jul 14, 2025
aaadcf7
Update openapi.license
aaanh Jul 14, 2025
6c25d59
Update README
aaanh Jul 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions API-proposed.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ info:
license:
name: Apache 2
url: http://www.apache.org/licenses/
version: 0.4.0
version: 0.5.0
servers:
- url: https://localhost:8080/tsp/api
tags:
Expand Down Expand Up @@ -2480,17 +2480,21 @@ components:
type: string
description: "Type of data returned by this output. Serves as a hint to\
\ determine what kind of view should be used for this output (ex. XY,\
\ Time Graph, Table, etc..). Providers of type TREE_TIME_XY and TIME_GRAPH\
\ can be grouped under the same time axis. Providers of type DATA_TREE\
\ only provide a tree with columns and don't have any XY nor time graph\
\ data associated with it. Providers of type NONE have no data to visualize.\
\ Can be used for grouping purposes and/or as data provider configurator."
\ Time Graph, Table, Gantt chart, etc..). Providers of type TREE_TIME_XY\
\ and TIME_GRAPH can be grouped under the same time axis. Providers of\
\ type DATA_TREE only provide a tree with columns and don't have any XY\
\ nor time graph data associated with it. Providers of type GANTT_CHART\
\ use the same endpoint as TIME_GRAPH, but have a different x-axis (duration,\
\ page faults, etc.), with their own separate ranges.\
\ Providers of type NONE have no data to visualize. Can be used for grouping\
\ purposes and/or as data provider configurator."
enum:
- TABLE
- TREE_TIME_XY
- TIME_GRAPH
- DATA_TREE
- NONE
- GANTT_CHART
configuration:
$ref: "#/components/schemas/Configuration"
capabilities:
Expand Down
16 changes: 10 additions & 6 deletions API.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ info:
license:
name: Apache 2
url: http://www.apache.org/licenses/
version: 0.4.0
version: 0.5.0
servers:
- url: https://localhost:8080/tsp/api
tags:
Expand Down Expand Up @@ -1959,17 +1959,21 @@ components:
type: string
description: "Type of data returned by this output. Serves as a hint to\
\ determine what kind of view should be used for this output (ex. XY,\
\ Time Graph, Table, etc..). Providers of type TREE_TIME_XY and TIME_GRAPH\
\ can be grouped under the same time axis. Providers of type DATA_TREE\
\ only provide a tree with columns and don't have any XY nor time graph\
\ data associated with it. Providers of type NONE have no data to visualize.\
\ Can be used for grouping purposes and/or as data provider configurator."
\ Time Graph, Table, Gantt chart, etc..). Providers of type TREE_TIME_XY\
\ and TIME_GRAPH can be grouped under the same time axis. Providers of\
\ type DATA_TREE only provide a tree with columns and don't have any XY\
\ nor time graph data associated with it. Providers of type GANTT_CHART\
\ use the same endpoint as TIME_GRAPH, but have a different x-axis (duration,\
\ page faults, etc.), with their own separate ranges.\
\ Providers of type NONE have no data to visualize. Can be used for grouping\
\ purposes and/or as data provider configurator."
enum:
- TABLE
- TREE_TIME_XY
- TIME_GRAPH
- DATA_TREE
- NONE
- GANTT_CHART
configuration:
$ref: "#/components/schemas/Configuration"
capabilities:
Expand Down
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,9 @@ Swagger has recently been added to the Trace Compass trace-server (reference imp
1. Browse [to here][apiyaml] ([swagger][swagger]) or so to generate server's TSP.
1. The resulting file is stored in the user's Downloads directory; e.g.: `~/Downloads/openapi.yaml`
1. Copy `~/Downloads/openapi.yaml` to this directory.
1. Update the latter with its license information and remove extra information: `./openapi.py`
1. Update the latter with its license information and remove extra information by running `./openapi.py`
1. The resulting diff between `API.yaml` and `openapi.yaml` can then be pushed for review.
* Use any diff tools to transfer over the new changes from `openapi.yaml` to `API.yaml`
* Note, that the order of fields, components etc. might be different everytime the API is generated using swagger-core. This is due to how swagger-core is implemented.
1. Make sure to transfer the diffs to `API-proposed.yaml` as well.
1. `openapi.yaml` should not be merged to the repository and can be deleted when not needed anymore.
Expand Down
2 changes: 1 addition & 1 deletion openapi.license
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
###############################################################################
# Copyright (c) 2018, 2024 Ericsson
# Copyright (c) 2018, 2025 Ericsson
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down