API.yaml

###############################################################################
# Copyright (c) 2018, 2023 Ericsson
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
###############################################################################
openapi: 3.0.1
info:
  title: Trace Server Protocol
  description: "Open source REST API for viewing and analyzing any type of logs or\
    \ traces. Its goal is to provide models to populate views, graphs, metrics, and\
    \ more to help extract useful information from traces, in a way that is more user-friendly\
    \ and informative than huge text dumps."
  termsOfService: https://www.eclipse.org/tracecompass/
  contact:
    email: tracecompass-dev@eclipse.org
  license:
    name: Apache 2
    url: http://www.apache.org/licenses/
  version: 0.1.0
servers:
- url: https://localhost:8080/tsp/api
  variables: {}
tags:
- name: Annotations
  description: Retrieve annotations for different outputs.
- name: Diagnostic
  description: Refer to the server's status.
- name: Experiments
  description: "How to manage experiments on your server; an experiment represents\
    \ a collection of traces, which can produce output models."
- name: Styles
  description: Retrieve styles for different outputs.
- name: TimeGraph
  description: Learn about querying Time Graph models.
- name: Traces
  description: How to manage physical traces on your server.
- name: Virtual Tables
  description: Learn about querying virtual table models (e.g. Events Table).
- name: XY
  description: Learn about querying XY models.
paths:
  /experiments/{expUUID}/outputs/{outputId}/annotations:
    get:
      tags:
      - Annotations
      summary: API to get annotation categories associated to this experiment and
        output
      operationId: getAnnotationCategories
      parameters:
      - name: expUUID
        in: path
        description: UUID of the experiment to query
        required: true
        schema:
          type: string
          format: uuid
      - name: outputId
        in: path
        description: ID of the output provider to query
        required: true
        schema:
          type: string
      - name: markerSetId
        in: query
        description: The optional requested marker set's id
        schema:
          type: string
      responses:
        "200":
          description: Annotation categories
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnnotationCategoriesResponse'
        "400":
          description: Missing parameter outputId
          content:
            application/json:
              schema:
                type: string
        "404":
          description: Experiment or output provider not found
          content:
            application/json:
              schema:
                type: string
        "405":
          description: Analysis cannot run
          content:
            application/json:
              schema:
                type: string
    post:
      tags:
      - Annotations
      summary: API to get the annotations associated to this experiment and output
      operationId: getAnnotations
      parameters:
      - name: expUUID
        in: path
        description: UUID of the experiment to query
        required: true
        schema:
          type: string
          format: uuid
      - name: outputId
        in: path
        description: ID of the output provider to query
        required: true
        schema:
          type: string
      requestBody:
        description: "Query parameters to fetch the annotations. The object 'requested_timerange'\
          \ is the requested time range and number of samples. The array 'requested_items'\
          \ is the list of entryId being requested. The string 'requested_marker_set'\
          \ is the optional requested marker set's id. The array 'requested_marker_categories'\
          \ is the list of requested annotation categories; if absent, all annotations\
          \ are returned."
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnnotationsQueryParameters'
            example:
              parameters:
                requested_timerange:
                  start: 111111111
                  end: 222222222
                  nbTimes: 1920
                requested_items:
                - 1
                - 2
                requested_marker_set: markerSetId
                requested_marker_categories:
                - category1
                - category2
        required: true
      responses:
        "200":
          description: Annotation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnnotationResponse'
        "400":
          description: Missing query parameters
          content:
            application/json:
              schema:
                type: string
        "404":
          description: Experiment or output provider not found
          content:
            application/json:
              schema:
                type: string
        "405":
          description: Analysis cannot run
          content:
            application/json:
              schema:
                type: string
  /experiments/{expUUID}/outputs/timeGraph/{outputId}/arrows:
    post:
      tags:
      - TimeGraph
      summary: API to get the Time Graph arrows
      description: "Unique entry point for all TimeGraph models, ensures that the\
        \ same template is followed for all models"
      operationId: getArrows
      parameters:
      - name: expUUID
        in: path
        description: UUID of the experiment to query
        required: true
        schema:
          type: string
          format: uuid
      - name: outputId
        in: path
        description: ID of the output provider to query
        required: true
        schema:
          type: string
      requestBody:
        description: Query parameters to fetch the timegraph arrows. The object 'requested_timerange'
          is the requested time range and number of samples.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ArrowsQueryParameters'
            example:
              parameters:
                requested_timerange:
                  start: 111111111
                  end: 222222222
                  nbTimes: 1920
        required: true
      responses:
        "200":
          description: Returns a sampled list of TimeGraph arrows
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TimeGraphArrowsResponse'
        "400":
          description: Missing query parameters
          content:
            application/json:
              schema:
                type: string
        "404":
          description: Experiment or output provider not found
          content:
            application/json:
              schema:
                type: string
        "405":
          description: Analysis cannot run
          content:
            application/json:
              schema:
                type: string
  /experiments/{expUUID}/outputs/table/{outputId}/columns:
    post:
      tags:
      - Virtual Tables
      summary: API to get table columns
      description: "Unique entry point for output providers, to get the column entries"
      operationId: getColumns
      parameters:
      - name: expUUID
        in: path
        description: UUID of the experiment to query
        required: true
        schema:
          type: string
          format: uuid
      - name: outputId
        in: path
        description: ID of the output provider to query
        required: true
        schema:
          type: string
      requestBody:
        description: Query parameters to fetch the table columns
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OptionalQueryParameters'
            example:
              parameters: {}
        required: true
      responses:
        "200":
          description: Returns a list of table headers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TableColumnHeadersResponse'
        "400":
          description: Invalid query parameters
          content:
            application/json:
              schema:
                type: string
        "404":
          description: Experiment or output provider not found
          content:
            application/json:
              schema:
                type: string
        "405":
          description: Analysis cannot run
          content:
            application/json:
              schema:
                type: string
  /experiments/{expUUID}/outputs/data/{outputId}/tree:
    post:
      tags:
      - Data Tree
      summary: API to get the data tree
      description: "Unique entry point for output providers, to get the tree of visible\
        \ entries"
      operationId: getDataTree
      parameters:
      - name: expUUID
        in: path
        description: UUID of the experiment to query
        required: true
        schema:
          type: string
          format: uuid
      - name: outputId
        in: path
        description: ID of the output provider to query
        required: true
        schema:
          type: string
      requestBody:
        description: Query parameters to fetch the data tree entries. The object 'requested_timerange'
          specifies the requested time range. When absent the tree for the full range
          is returned.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TreeQueryParameters'
            example:
              parameters:
                requested_timerange:
                  start: 111111111
                  end: 222222222
        required: true
      responses:
        "200":
          description: "Returns a list of data tree entries. The returned model must\
            \ be consistent, parentIds must refer to a parent which exists in the\
            \ model."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XYTreeResponse'
        "400":
          description: Invalid query parameters
          content:
            application/json:
              schema:
                type: string
        "404":
          description: Experiment or output provider not found
          content:
            application/json:
              schema:
                type: string
        "405":
          description: Analysis cannot run
          content:
            application/json:
              schema:
                type: string
  /experiments/{expUUID}/outputs/table/{outputId}/lines:
    post:
      tags:
      - Virtual Tables
      summary: API to get virtual table lines
      operationId: getLines
      parameters:
      - name: expUUID
        in: path
        description: UUID of the experiment to query
        required: true
        schema:
          type: string
          format: uuid
      - name: outputId
        in: path
        description: ID of the output provider to query
        required: true
        schema:
          type: string
      requestBody:
        description: "Query parameters to fetch the table lines. One of 'requested_table_index'\
          \ or 'requested_times' should be present. If 'requested_table_index' is\
          \ used it is the starting index of the lines to be returned. If 'requested_times'\
          \ is used it should contain an array with a single timestamp. The returned\
          \ lines starting at the given timestamp (or the nearest following) will\
          \ be returned. The 'requested_table_count' is the number of lines that should\
          \ be returned. When 'requested_table_column_ids' is absent all columns are\
          \ returned. When present it is the array of requested columnIds. Use 'table_search_expressions'\
          \ for search providing a map of <columnId, regular expression>. Returned\
          \ lines that match the search expression will be tagged. Use 'table_search_direction'\
          \ to specify search direction [NEXT, PREVIOUS]. If present, 'requested_table_count'\
          \ events are returned starting from the first matching event. Matching and\
          \ not matching events are returned. Matching events will be tagged. If no\
          \ matches are found, an empty list will be returned."
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinesQueryParameters'
            example:
              parameters:
                requested_table_index: 0
                requested_table_count: 100
                requested_table_column_ids:
                - 0
                - 1
                - 2
                table_search_expressions:
                  "1": cpu.*
                table_search_direction: NEXT
        required: true
      responses:
        "200":
          description: Returns a table model with a 2D array of strings and metadata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VirtualTableResponse'
        "400":
          description: Invalid query parameters
          content:
            application/json:
              schema:
                type: string
        "404":
          description: Experiment or output provider not found
          content:
            application/json:
              schema:
                type: string
        "405":
          description: Analysis cannot run
          content:
            application/json:
              schema:
                type: string
        "500":
          description: Error reading the experiment
          content:
            application/json:
              schema:
                type: string
  /experiments/{expUUID}/outputs/markerSets:
    get:
      tags:
      - Annotations
      summary: API to get marker sets available for this experiment
      operationId: getMarkerSets
      parameters:
      - name: expUUID
        in: path
        description: UUID of the experiment to query
        required: true
        schema:
          type: string
          format: uuid
      responses:
        "200":
          description: List of marker sets
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarkerSetsResponse'
        "404":
          description: Experiment or output provider not found
          content:
            application/json:
              schema:
                type: string
  /experiments/{expUUID}/outputs/{outputId}:
    get:
      tags:
      - Experiments
      summary: Get the output descriptor for this experiment and output
      operationId: getProvider
      parameters:
      - name: expUUID
        in: path
        description: UUID of the experiment to query
        required: true
        schema:
          type: string
          format: uuid
      - name: outputId
        in: path
        description: ID of the output provider to query
        required: true
        schema:
          type: string
      responses:
        "200":
          description: Returns the output provider descriptor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataProvider'
        "404":
          description: Experiment or output provider not found
          content:
            application/json:
              schema:
                type: string
  /experiments/{expUUID}/outputs:
    get:
      tags:
      - Experiments
      summary: Get the list of outputs for this experiment
      operationId: getProviders
      parameters:
      - name: expUUID
        in: path
        description: UUID of the experiment to query
        required: true
        schema:
          type: string
          format: uuid
      responses:
        "200":
          description: Returns a list of output provider descriptors
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DataProvider'
        "404":
          description: Experiment or output provider not found
          content:
            application/json:
              schema:
                type: string
  /experiments/{expUUID}/outputs/timeGraph/{outputId}/states:
    post:
      tags:
      - TimeGraph
      summary: API to get the Time Graph states
      description: "Unique entry point for all TimeGraph states, ensures that the\
        \ same template is followed for all views"
      operationId: getStates
      parameters:
      - name: expUUID
        in: path
        description: UUID of the experiment to query
        required: true
        schema:
          type: string
          format: uuid
      - name: outputId
        in: path
        description: ID of the output provider to query
        required: true
        schema:
          type: string
      requestBody:
        description: Query parameters to fetch the timegraph states. The object 'requested_timerange'
          is the requested time range and number of samples. The array 'requested_items'
          is the list of entryId being requested.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestedQueryParameters'
            example:
              parameters:
                requested_timerange:
                  start: 111111111
                  end: 222222222
                  nbTimes: 1920
                requested_items:
                - 1
                - 2
        required: true
      responses:
        "200":
          description: Returns a list of time graph rows
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TimeGraphStatesResponse'
        "400":
          description: Missing query parameters
          content:
            application/json:
              schema:
                type: string
        "404":
          description: Experiment or output provider not found
          content:
            application/json:
              schema:
                type: string
        "405":
          description: Analysis cannot run
          content:
            application/json:
              schema:
                type: string
  /experiments/{expUUID}/outputs/{outputId}/style:
    post:
      tags:
      - Styles
      summary: API to get the style map associated to this experiment and output
      operationId: getStyles
      parameters:
      - name: expUUID
        in: path
        description: UUID of the experiment to query
        required: true
        schema:
          type: string
          format: uuid
      - name: outputId
        in: path
        description: ID of the output provider to query
        required: true
        schema:
          type: string
      requestBody:
        description: Query parameters to fetch the style map
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OptionalQueryParameters'
            example:
              parameters: {}
        required: true
      responses:
        "200":
          description: Style model that can be used jointly with OutputElementStyle
            to retrieve specific style values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StylesResponse'
        "400":
          description: Missing query parameters
          content:
            application/json:
              schema:
                type: string
        "404":
          description: Experiment or output provider not found
          content:
            application/json:
              schema:
                type: string
        "405":
          description: Analysis cannot run
          content:
            application/json:
              schema:
                type: string
  /experiments/{expUUID}/outputs/timeGraph/{outputId}/tooltip:
    post:
      tags:
      - TimeGraph
      summary: API to get a Time Graph tooltip
      description: Endpoint to retrieve tooltips for time graph
      operationId: getTimeGraphTooltip
      parameters:
      - name: expUUID
        in: path
        description: UUID of the experiment to query
        required: true
        schema:
          type: string
          format: uuid
      - name: outputId
        in: path
        description: ID of the output provider to query
        required: true
        schema:
          type: string
      requestBody:
        description: Query parameters to fetch the timegraph tooltip. The array 'requested_times'
          is an array with a single timestamp. The array 'requested_items' is an array
          with a single entryId being requested.  The object 'requested_element' is
          the element for which the tooltip is requested.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TooltipQueryParameters'
            example:
              parameters:
                requested_times:
                - 111200000
                requested_items:
                - 1
                requested_element:
                  elementType: state
                  time: 111100000
                  duration: 100000
        required: true
      responses:
        "200":
          description: Returns a list of tooltip keys to values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TimeGraphTooltipResponse'
        "400":
          description: Missing query parameters
          content:
            application/json:
              schema:
                type: string
        "404":
          description: Experiment or output provider not found
          content:
            application/json:
              schema:
                type: string
        "405":
          description: Analysis cannot run
          content:
            application/json:
              schema:
                type: string
  /experiments/{expUUID}/outputs/timeGraph/{outputId}/tree:
    post:
      tags:
      - TimeGraph
      summary: API to get the Time Graph tree
      description: "Unique entry point for output providers, to get the tree of visible\
        \ entries"
      operationId: getTimeGraphTree
      parameters:
      - name: expUUID
        in: path
        description: UUID of the experiment to query
        required: true
        schema:
          type: string
          format: uuid
      - name: outputId
        in: path
        description: ID of the output provider to query
        required: true
        schema:
          type: string
      requestBody:
        description: Query parameters to fetch the timegraph tree. The object 'requested_timerange'
          specifies the requested time range. When absent the tree for the full range
          is returned.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TreeQueryParameters'
            example:
              parameters:
                requested_timerange:
                  start: 111111111
                  end: 222222222
        required: true
      responses:
        "200":
          description: "Returns a list of Time Graph entries. The returned model must\
            \ be consistent, parentIds must refer to a parent which exists in the\
            \ model."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TimeGraphTreeResponse'
        "400":
          description: Invalid query parameters
          content:
            application/json:
              schema:
                type: string
        "404":
          description: Experiment or output provider not found
          content:
            application/json:
              schema:
                type: string
        "405":
          description: Analysis cannot run
          content:
            application/json:
              schema:
                type: string
  /experiments/{expUUID}/outputs/XY/{outputId}/xy:
    post:
      tags:
      - XY
      summary: API to get the XY model
      description: "Unique endpoint for all xy models, ensures that the same template\
        \ is followed for all endpoints."
      operationId: getXY
      parameters:
      - name: expUUID
        in: path
        description: UUID of the experiment to query
        required: true
        schema:
          type: string
          format: uuid
      - name: outputId
        in: path
        description: ID of the output provider to query
        required: true
        schema:
          type: string
      requestBody:
        description: Query parameters to fetch the XY model. The object 'requested_timerange'
          is the requested time range and number of samples. The array 'requested_items'
          is the list of entryId or seriesId being requested.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestedQueryParameters'
            example:
              parameters:
                requested_timerange:
                  start: 111111111
                  end: 222222222
                  nbTimes: 1920
                requested_items:
                - 1
                - 2
        required: true
      responses:
        "200":
          description: Return the queried XYResponse
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XYResponse'
        "400":
          description: Missing query parameters
          content:
            application/json:
              schema:
                type: string
        "404":
          description: Experiment or output provider not found
          content:
            application/json:
              schema:
                type: string
        "405":
          description: Analysis cannot run
          content:
            application/json:
              schema:
                type: string
  /experiments/{expUUID}/outputs/XY/{outputId}/tree:
    post:
      tags:
      - XY
      summary: API to get the XY tree
      description: "Unique entry point for output providers, to get the tree of visible\
        \ entries"
      operationId: getXYTree
      parameters:
      - name: expUUID
        in: path
        description: UUID of the experiment to query
        required: true
        schema:
          type: string
          format: uuid
      - name: outputId
        in: path
        description: ID of the output provider to query
        required: true
        schema:
          type: string
      requestBody:
        description: Query parameters to fetch the XY tree. The object 'requested_timerange'
          specifies the requested time range. When absent the tree for the full range
          is returned.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TreeQueryParameters'
            example:
              parameters:
                requested_timerange:
                  start: 111111111
                  end: 222222222
        required: true
      responses:
        "200":
          description: "Returns a list of XY entries. The returned model must be consistent,\
            \ parentIds must refer to a parent which exists in the model."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XYTreeResponse'
        "400":
          description: Invalid query parameters
          content:
            application/json:
              schema:
                type: string
        "404":
          description: Experiment or output provider not found
          content:
            application/json:
              schema:
                type: string
        "405":
          description: Analysis cannot run
          content:
            application/json:
              schema:
                type: string
  /experiments/{expUUID}:
    get:
      tags:
      - Experiments
      summary: Get the model object for an experiment
      operationId: getExperiment
      parameters:
      - name: expUUID
        in: path
        description: UUID of the experiment to query
        required: true
        schema:
          type: string
          format: uuid
      responses:
        "200":
          description: Return the experiment model
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Experiment'
        "404":
          description: No such experiment
          content:
            application/json:
              schema:
                type: string
    delete:
      tags:
      - Experiments
      summary: Remove an experiment from the server
      operationId: deleteExperiment
      parameters:
      - name: expUUID
        in: path
        description: UUID of the experiment to query
        required: true
        schema:
          type: string
          format: uuid
      responses:
        "200":
          description: "The trace was successfully deleted, return the deleted experiment."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Experiment'
        "404":
          description: No such experiment
          content:
            application/json:
              schema:
                type: string
  /experiments:
    get:
      tags:
      - Experiments
      summary: Get the list of experiments on the server
      operationId: getExperiments
      responses:
        "200":
          description: Returns a list of experiments
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Experiment'
    post:
      tags:
      - Experiments
      summary: Create a new experiment on the server
      operationId: postExperiment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExperimentQueryParameters'
        required: true
      responses:
        "200":
          description: The experiment was successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Experiment'
        "204":
          description: The experiment has at least one trace which hasn't been created
            yet
          content:
            application/json:
              schema:
                type: string
        "400":
          description: Invalid query parameters
          content:
            application/json:
              schema:
                type: string
        "409":
          description: The experiment (name) already exists and both differ
          content:
            application/json:
              schema:
                type: string
        "500":
          description: Internal trace-server error while trying to post experiment
          content:
            application/json:
              schema:
                type: string
  /health:
    get:
      tags:
      - Diagnostic
      summary: Get the health status of this server
      operationId: getHealthStatus
      responses:
        "200":
          description: The trace server is running and ready to receive requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerStatus'
        "503":
          description: The trace server is unavailable or in maintenance and cannot
            receive requests
  /traces/{uuid}:
    get:
      tags:
      - Traces
      summary: Get the model object for a trace
      operationId: getTrace
      parameters:
      - name: uuid
        in: path
        description: UUID of the trace to query
        required: true
        schema:
          type: string
          format: uuid
      responses:
        "200":
          description: Return the trace model
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Trace'
        "404":
          description: No such trace
          content:
            application/json:
              schema:
                type: string
    delete:
      tags:
      - Traces
      summary: Remove a trace from the server and disk
      operationId: deleteTrace
      parameters:
      - name: uuid
        in: path
        description: UUID of the trace to query
        required: true
        schema:
          type: string
          format: uuid
      responses:
        "200":
          description: The trace was successfully deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Trace'
        "404":
          description: No such trace
          content:
            application/json:
              schema:
                type: string
        "409":
          description: The trace is in use by at least one experiment thus cannot
            be deleted
          content:
            application/json:
              schema:
                type: string
  /traces:
    get:
      tags:
      - Traces
      summary: Get the list of physical traces imported on the server
      operationId: getTraces
      responses:
        "200":
          description: Returns a list of traces
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Trace'
    post:
      tags:
      - Traces
      summary: Import a trace
      description: Import a trace to the trace server. Return some base information
        once imported.
      operationId: putTrace
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TraceQueryParameters'
        required: true
      responses:
        "200":
          description: The trace has been successfully added to the trace server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Trace'
        "400":
          description: Missing query parameters
          content:
            application/json:
              schema:
                type: string
        "404":
          description: No such trace
          content:
            application/json:
              schema:
                type: string
        "406":
          description: Cannot read this trace type
          content:
            application/json:
              schema:
                type: string
        "409":
          description: There was already a trace with this name
          content:
            application/json:
              schema:
                type: string
        "500":
          description: Trace resource creation failed
          content:
            application/json:
              schema:
                type: string
        "501":
          description: Trace type not supported
          content:
            application/json:
              schema:
                type: string
components:
  schemas:
    AnnotationCategoriesModel:
      type: object
      properties:
        annotationCategories:
          type: array
          description: Array of all the categories
          items:
            type: string
      description: Model returned by outputs that contains annotation categories available
        for this output
    AnnotationCategoriesResponse:
      type: object
      allOf:
      - $ref: '#/components/schemas/GenericResponse'
      - type: object
        properties:
          model:
            $ref: '#/components/schemas/AnnotationCategoriesModel'
    GenericResponse:
      type: object
      properties:
        statusMessage:
          type: string
        status:
          type: string
          description: All possible statuses for a server response
          enum:
          - RUNNING
          - COMPLETED
          - FAILED
          - CANCELLED
      description: Response that includes the status and a status message
    Annotation:
      required:
      - duration
      - entryId
      - time
      - type
      type: object
      properties:
        type:
          type: string
          description: Type of annotation indicating its location
          enum:
          - CHART
          - TREE
        time:
          type: integer
          description: Time of this annotation
          format: int64
        duration:
          type: integer
          description: Duration of this annotation
          format: int64
        style:
          $ref: '#/components/schemas/OutputElementStyle'
        entryId:
          type: integer
          description: Entry's unique ID or -1 if annotation not associated with an
            entry
          format: int64
        label:
          type: string
          description: Text label of this annotation
      description: An annotation is used to mark an interesting area at a given time
        or time range
    AnnotationModel:
      type: object
      properties:
        annotations:
          type: object
          additionalProperties:
            type: array
            description: Map of annotations where the keys are categories
            items:
              $ref: '#/components/schemas/Annotation'
          description: Map of annotations where the keys are categories
      description: Model returned by outputs that contains annotations per category
    AnnotationResponse:
      type: object
      allOf:
      - $ref: '#/components/schemas/GenericResponse'
      - type: object
        properties:
          model:
            $ref: '#/components/schemas/AnnotationModel'
    OutputElementStyle:
      type: object
      properties:
        parentKey:
          type: string
          description: "Parent style key or empty if there is no parent. The parent\
            \ key should match a style key defined in the style model and is used\
            \ for style inheritance. A comma-delimited list of parent style keys can\
            \ be used for style composition, the last one taking precedence."
        values:
          type: object
          additionalProperties:
            type: object
            description: Style values or empty map if there are no values. Keys and
              values are defined in https://git.eclipse.org/r/plugins/gitiles/tracecompass/org.eclipse.tracecompass/+/refs/heads/master/tmf/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/model/StyleProperties.java
          description: Style values or empty map if there are no values. Keys and
            values are defined in https://git.eclipse.org/r/plugins/gitiles/tracecompass/org.eclipse.tracecompass/+/refs/heads/master/tmf/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/model/StyleProperties.java
      description: "Represents the style on an element (ex. Entry, TimeGraphState,\
        \ ...) returned by any output. Supports style inheritance. To avoid having\
        \ too many styles, the element style can have a parent style and will have\
        \ all the same style property values as the parent, and can add or override\
        \ style properties."
    AnnotationsParameters:
      required:
      - requested_timerange
      type: object
      properties:
        requested_timerange:
          $ref: '#/components/schemas/TimeRange'
        requested_items:
          type: array
          items:
            type: integer
            format: int32
        requested_marker_set:
          type: string
        requested_marker_categories:
          type: array
          items:
            type: string
    AnnotationsQueryParameters:
      required:
      - parameters
      type: object
      properties:
        parameters:
          $ref: '#/components/schemas/AnnotationsParameters'
    TimeRange:
      required:
      - end
      - start
      type: object
      properties:
        nbTimes:
          type: integer
          description: The number of timestamps to be sampled (1-65536) in the given
            range
          format: int32
        start:
          type: integer
          description: The start of the time range
          format: int64
        end:
          type: integer
          description: The end of the time range
          format: int64
      description: A time range with optional number of timestamps to be sampled
    TimeGraphArrow:
      required:
      - end
      - sourceId
      - start
      - targetId
      type: object
      properties:
        targetId:
          type: integer
          description: Target entry's unique ID
          format: int64
        start:
          type: integer
          description: Start time for this arrow
          format: int64
        style:
          $ref: '#/components/schemas/OutputElementStyle'
        sourceId:
          type: integer
          description: Source entry's unique ID
          format: int64
        end:
          type: integer
          description: End time for this arrow
          format: int64
    TimeGraphArrowsResponse:
      type: object
      allOf:
      - $ref: '#/components/schemas/GenericResponse'
      - type: object
        properties:
          model:
            type: array
            items:
              $ref: '#/components/schemas/TimeGraphArrow'
    ArrowsParameters:
      required:
      - requested_timerange
      type: object
      properties:
        requested_timerange:
          $ref: '#/components/schemas/TimeRange'
    ArrowsQueryParameters:
      required:
      - parameters
      type: object
      properties:
        parameters:
          $ref: '#/components/schemas/ArrowsParameters'
    TableColumnHeader:
      type: object
      properties:
        name:
          type: string
          description: Displayed name for this column
        id:
          type: integer
          description: Unique id to identify this column in the backend
          format: int64
        type:
          type: string
          description: Type of data associated to this column
        description:
          type: string
          description: Description of the column
    TableColumnHeadersResponse:
      type: object
      allOf:
      - $ref: '#/components/schemas/GenericResponse'
      - type: object
        properties:
          model:
            type: array
            items:
              $ref: '#/components/schemas/TableColumnHeader'
    OptionalParameters:
      type: object
    OptionalQueryParameters:
      required:
      - parameters
      type: object
      properties:
        parameters:
          $ref: '#/components/schemas/OptionalParameters'
    VirtualTableCell:
      type: object
      properties:
        content:
          type: string
          description: Content of the cell for this line
        tags:
          type: integer
          description: Specific tags for this cell. A value of 0 should be handled
            as none (no tags)
          format: int32
    VirtualTableLine:
      type: object
      properties:
        index:
          type: integer
          description: The index of this line in the virtual table
          format: int64
        tags:
          type: integer
          description: "Tags for the entire line. A bit mask to apply for tagging\
            \ elements (e.g. table lines, states). This can be used by the server\
            \ to indicate if a filter matches and what action to apply. Use 0 for\
            \ no tags, 1 and 2 are reserved, 4 for 'BORDER' and 8 for 'HIGHLIGHT'."
          format: int32
        cells:
          type: array
          description: The content of the cells for this line. This array matches
            the column ids returned above
          items:
            $ref: '#/components/schemas/VirtualTableCell'
    VirtualTableModel:
      type: object
      properties:
        size:
          type: integer
          description: "Number of events. If filtered, the size will be the number\
            \ of events that match the filters"
          format: int64
        columnIds:
          type: array
          description: The array of column ids that are returned. They should match
            the content of the lines' content
          items:
            type: integer
            format: int64
        lowIndex:
          type: integer
          description: Index in the virtual table of the first returned event
          format: int64
        lines:
          type: array
          items:
            $ref: '#/components/schemas/VirtualTableLine'
    VirtualTableResponse:
      type: object
      allOf:
      - $ref: '#/components/schemas/GenericResponse'
      - type: object
        properties:
          model:
            $ref: '#/components/schemas/VirtualTableModel'
    LinesParameters:
      required:
      - requested_table_count
      type: object
      properties:
        requested_times:
          type: array
          items:
            type: integer
            format: int64
        requested_table_index:
          type: integer
          format: int64
        requested_table_count:
          type: integer
          format: int32
        requested_table_column_ids:
          type: array
          items:
            type: integer
            format: int64
        table_search_expressions:
          type: object
          additionalProperties:
            type: string
        table_search_direction:
          type: string
          description: "Search next or previous item (e.g. event, state etc.)"
          enum:
          - NEXT
          - PREVIOUS
    LinesQueryParameters:
      required:
      - parameters
      type: object
      properties:
        parameters:
          $ref: '#/components/schemas/LinesParameters'
    MarkerSet:
      type: object
      properties:
        name:
          type: string
          description: Name of this marker set
        id:
          type: string
          description: ID of this marker set
      description: A marker set is used to represent a set of annotations that can
        be fetched
    MarkerSetsResponse:
      type: object
      allOf:
      - $ref: '#/components/schemas/GenericResponse'
      - type: object
        properties:
          model:
            type: array
            items:
              $ref: '#/components/schemas/MarkerSet'
    DataProvider:
      type: object
      properties:
        name:
          type: string
          description: The human readable name
        id:
          type: string
          description: The output provider's ID
        type:
          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."
          enum:
          - TABLE
          - TREE_TIME_XY
          - TIME_GRAPH
          - DATA_TREE
        description:
          type: string
          description: Describes the output provider's features
    TimeGraphModel:
      type: object
      properties:
        rows:
          type: array
          items:
            $ref: '#/components/schemas/TimeGraphRowModel'
    TimeGraphRowModel:
      required:
      - entryId
      - states
      type: object
      properties:
        states:
          type: array
          description: List of the time graph entry states associated to this entry
            and zoom level
          items:
            $ref: '#/components/schemas/TimeGraphState'
        entryId:
          type: integer
          description: The entry to map this state list to
          format: int64
    TimeGraphState:
      required:
      - end
      - start
      type: object
      properties:
        tags:
          type: integer
          description: Tags to apply on this state. A value of 0 should be handled
            as none (no tags)
          format: int32
        start:
          type: integer
          description: Start time for this state
          format: int64
        style:
          $ref: '#/components/schemas/OutputElementStyle'
        label:
          type: string
          description: "Text label to apply to this TimeGraphState if resolution permits.\
            \ Optional, no label is applied if absent"
        end:
          type: integer
          description: End time for this state
          format: int64
    TimeGraphStatesResponse:
      type: object
      allOf:
      - $ref: '#/components/schemas/GenericResponse'
      - type: object
        properties:
          model:
            $ref: '#/components/schemas/TimeGraphModel'
    RequestedParameters:
      required:
      - requested_items
      - requested_timerange
      type: object
      properties:
        requested_timerange:
          $ref: '#/components/schemas/TimeRange'
        requested_items:
          type: array
          items:
            type: integer
            format: int32
    RequestedQueryParameters:
      required:
      - parameters
      type: object
      properties:
        parameters:
          $ref: '#/components/schemas/RequestedParameters'
    OutputStyleModel:
      type: object
      properties:
        styles:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/OutputElementStyle'
      description: Map of styles specific to an output where values give hints on
        the style. The keys are strings that can be used in OutputElementStyle
    StylesResponse:
      type: object
      allOf:
      - $ref: '#/components/schemas/GenericResponse'
      - type: object
        properties:
          model:
            $ref: '#/components/schemas/OutputStyleModel'
    TimeGraphTooltip:
      type: object
      properties:
        value:
          type: string
        key:
          type: string
    TimeGraphTooltipResponse:
      type: object
      allOf:
      - $ref: '#/components/schemas/GenericResponse'
      - type: object
        properties:
          model:
            type: array
            items:
              $ref: '#/components/schemas/TimeGraphTooltip'
    Element:
      required:
      - duration
      - elementType
      - time
      type: object
      properties:
        time:
          type: integer
          description: Element's start time
          format: int64
        elementType:
          type: string
          description: The type of element
          enum:
          - STATE
          - ANNOTATION
          - ARROW
        duration:
          type: integer
          description: Element's duration
          format: int64
        entryId:
          type: integer
          description: "Entry's unique ID (annotation, arrow)"
          format: int64
        destinationId:
          type: integer
          description: Destination entry's unique ID (arrow)
          format: int64
      description: An element model to be identified
    TooltipParameters:
      required:
      - requested_element
      - requested_items
      - requested_times
      type: object
      properties:
        requested_element:
          $ref: '#/components/schemas/Element'
        requested_times:
          type: array
          items:
            type: integer
            format: int64
        requested_items:
          type: array
          items:
            type: integer
            format: int32
    TooltipQueryParameters:
      required:
      - parameters
      type: object
      properties:
        parameters:
          $ref: '#/components/schemas/TooltipParameters'
    TimeGraphEntry:
      type: object
      allOf:
      - $ref: '#/components/schemas/TreeDataModel'
      - type: object
        properties:
          start:
            type: integer
            description: Beginning of the range for which this entry exists
            format: int64
          metadata:
            type: object
            additionalProperties:
              type: array
              description: Optional metadata map for domain specific data for matching data
                across data providers. Keys for the same data shall be the same across
                data providers. Only values of type Number or String are allowed.
                For each key all values shall have the same type.
              items:
                type: object
                description: Optional metadata map for domain specific data for matching data
                  across data providers. Keys for the same data shall be the same
                  across data providers. Only values of type Number or String are
                  allowed. For each key all values shall have the same type.
            description: Optional metadata map for domain specific data for matching data across
              data providers. Keys for the same data shall be the same across data
              providers. Only values of type Number or String are allowed. For each
              key all values shall have the same type.
          end:
            type: integer
            description: End of the range for which this entry exists
            format: int64
    TimeGraphTreeModel:
      type: object
      allOf:
      - $ref: '#/components/schemas/TreeEntryModel'
      - type: object
        properties:
          entries:
            type: array
            items:
              $ref: '#/components/schemas/TimeGraphEntry'
    TimeGraphTreeResponse:
      type: object
      allOf:
      - $ref: '#/components/schemas/GenericResponse'
      - type: object
        properties:
          model:
            $ref: '#/components/schemas/TimeGraphTreeModel'
    TreeColumnHeader:
      required:
      - name
      type: object
      properties:
        name:
          type: string
          description: Displayed name for this header
        tooltip:
          type: string
          description: "Displayed tooltip for this header. Optional, no tooltip is\
            \ applied if absent."
    TreeDataModel:
      required:
      - id
      - labels
      type: object
      properties:
        id:
          type: integer
          description: Unique id to identify this entry in the backend
          format: int64
        hasData:
          type: boolean
          description: Whether or not this entry has data
        style:
          $ref: '#/components/schemas/OutputElementStyle'
        parentId:
          type: integer
          description: "Unique id to identify this parent's entry, optional if this\
            \ entry does not have a parent."
          format: int64
        labels:
          type: array
          description: Array of cell labels to be displayed. The length of the array
            and the index of each column need to correspond to the header array returned
            in the tree model.
          items:
            type: string
      description: Base entry returned by tree endpoints
    TreeEntryModel:
      required:
      - entries
      type: object
      properties:
        entries:
          type: array
          items:
            $ref: '#/components/schemas/TreeDataModel'
        headers:
          type: array
          items:
            $ref: '#/components/schemas/TreeColumnHeader'
    TreeParameters:
      type: object
      properties:
        requested_times:
          type: array
          items:
            type: integer
            format: int64
    TreeQueryParameters:
      required:
      - parameters
      type: object
      properties:
        parameters:
          $ref: '#/components/schemas/TreeParameters'
    SeriesModel:
      required:
      - seriesId
      - seriesName
      - style
      - xValues
      - yValues
      type: object
      properties:
        seriesId:
          type: integer
          description: Series' ID
          format: int64
        seriesName:
          type: string
          description: Series' name
        style:
          $ref: '#/components/schemas/OutputElementStyle'
        xValues:
          type: array
          description: Series' X values
          items:
            type: integer
            format: int64
        yValues:
          type: array
          description: Series' Y values
          items:
            type: integer
            format: int64
      description: This model includes the series output style values.
    XYModel:
      required:
      - series
      - title
      type: object
      properties:
        series:
          type: array
          description: The collection of series
          items:
            $ref: '#/components/schemas/SeriesModel'
        title:
          type: string
          description: Title of the model
    XYResponse:
      type: object
      allOf:
      - $ref: '#/components/schemas/GenericResponse'
      - type: object
        properties:
          model:
            $ref: '#/components/schemas/XYModel'
    XYTreeEntry:
      type: object
      allOf:
      - $ref: '#/components/schemas/TreeDataModel'
      - type: object
        properties:
          isDefault:
            type: boolean
            description: Optional flag to indicate whether or not the entry is a default
              entry and its xy data should be fetched by default.
    XYTreeEntryModel:
      type: object
      allOf:
      - $ref: '#/components/schemas/TreeEntryModel'
      - type: object
        properties:
          entries:
            type: array
            items:
              $ref: '#/components/schemas/XYTreeEntry'
    XYTreeResponse:
      type: object
      allOf:
      - $ref: '#/components/schemas/GenericResponse'
      - type: object
        properties:
          model:
            $ref: '#/components/schemas/XYTreeEntryModel'
    Experiment:
      type: object
      properties:
        name:
          type: string
          description: User defined name for the experiment
        traces:
          type: array
          description: The traces encapsulated by this experiment
          items:
            $ref: '#/components/schemas/Trace'
        nbEvents:
          type: integer
          description: Current number of indexed events in the experiment
          format: int64
        start:
          type: integer
          description: The experiment's start time
          format: int64
        indexingStatus:
          type: string
          description: Status of the experiment indexing
          enum:
          - RUNNING
          - COMPLETED
          - CLOSED
        end:
          type: integer
          description: The experiment's end time
          format: int64
        UUID:
          type: string
          description: The experiment's unique identifier
          format: uuid
    Trace:
      type: object
      properties:
        name:
          type: string
          description: User defined name for the trace
        path:
          type: string
          description: Path to the trace on the server's file system
        nbEvents:
          type: integer
          description: Current number of indexed events in the trace
          format: int64
        start:
          type: integer
          description: The trace's start time
          format: int64
        indexingStatus:
          type: string
          description: Status of the trace indexing
          enum:
          - RUNNING
          - COMPLETED
          - CLOSED
        end:
          type: integer
          description: The trace's end time
          format: int64
        UUID:
          type: string
          description: The trace's unique identifier
          format: uuid
    ExperimentQueryParameters:
      required:
      - name
      - traces
      type: object
      properties:
        name:
          type: string
          description: The name to give this experiment
        traces:
          type: array
          description: The unique identifiers of the traces to encapsulate in this
            experiment
          items:
            type: string
            format: uuid
    ServerStatus:
      type: object
      properties:
        status:
          type: string
          description: The status of the server
          enum:
          - UP
    TraceQueryParameters:
      required:
      - uri
      type: object
      properties:
        name:
          type: string
          description: "The name of the trace in the server, to override the default\
            \ name"
        typeID:
          type: string
          description: "The trace type's ID, to force the use of a parser / disambiguate\
            \ the trace type"
        uri:
          type: string
          description: URI of the trace