Skip to content
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.

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

Introduce tooltips to events table #36

Closed
Closed
Changes from all commits
Commits
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
62 changes: 62 additions & 0 deletions API.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1131,6 +1131,68 @@ paths:
application/json:
schema:
type: string
/experiments/{expUUID}/outputs/table/{outputID}/tooltip:
post:
tags:
- Virtual Tables
summary: API to get virtual table tooltip
operationId: getTooltip
parameters:
- name: expUUID
in: path
description: The UUID of the experiment in the server
required: true
schema:
type : string
format: uuid
- name: outputID
in: path
description: The name of the table provider to query
required: true
schema:
type: string
requestBody:
description: Query parameters to fetch the timegraph tree.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update description? Also, I don't think the parameters mentioned below apply to this query, right?

Usually contains these parameters, but not limited to
- requested_items, index of the first line to query
- requested_times, number of lines to return
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Query'
responses:
200:
description: Returns a list of tooltip entries. The returned model must be consistent, parentIds must refer to a parent which exists in the model.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you have the concept of parent in the table?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, could you define more precisely "tooltip entries"? The commit message says it can be used to retrieve raw data, but as an implementer of the protocol who reads this description and not the commit messages, I would never think of returning raw data here. Rather human-readable stuff

content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/GenericResponse'
- type: object
properties:
model:
type: array
items:
$ref: '#/components/schemas/TableModel'
400:
description: Bad request, the requested_items must be larger than 0
content:
application/json:
schema:
type: string
404:
description: No such Experiment
content:
application/json:
schema:
type: string
500:
description: Error reading the Experiment
content:
application/json:
schema:
type: string
/experiments/{expUUID}/outputs/{outputID}/style:
post:
tags:
Expand Down