diff --git a/API-proposed.yaml b/API-proposed.yaml index 4abacbb..f84c436 100644 --- a/API-proposed.yaml +++ b/API-proposed.yaml @@ -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: @@ -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: diff --git a/API.yaml b/API.yaml index d3b8630..f927532 100644 --- a/API.yaml +++ b/API.yaml @@ -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: @@ -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: diff --git a/README.md b/README.md index 6a87e1e..8d004b4 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/openapi.license b/openapi.license index c18ba71..524c46b 100644 --- a/openapi.license +++ b/openapi.license @@ -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.