Add data type hints to column and entry descriptions #50
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes eclipse-cdt-cloud#35 With this, it is expected that column and entry descriptions may contain an optional typing option, to explain what the data type is and, if available, what unit to use when formatting it. This allow the server implementations to send raw data to the client, who would then have the option to format the data, but also the possibility to do some other actions, like sorting, or use the data for richer data interactions, as raw data may have a same meaning in different outputs, unlike pre-formatted data which may not allow such interaction. Signed-off-by: Geneviève Bastien <[email protected]>
bhufmann
requested changes
Feb 23, 2021
| type: string | ||
| enum: | ||
| - NUMBER |
There was a problem hiding this comment.
Could you add some description on what each type means and can be used for? Also, if omitted it's a assumed a type string.
| description: | ||
| description: Description of the column | ||
| type: string | ||
| - $ref: '#/components/schemas/DataType' |
There was a problem hiding this comment.
data type is optional, right? Can you add the list of mandatory and optional properties?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #35
With this, it is expected that column and entry descriptions may contain
an optional typing option, to explain what the data type is and, if
available, what unit to use when formatting it.
This allow the server implementations to send raw data to the client,
who would then have the option to format the data, but also the
possibility to do some other actions, like sorting, or use the data for
richer data interactions, as raw data may have a same meaning in
different outputs, unlike pre-formatted data which may not allow such
interaction.
Signed-off-by: Geneviève Bastien [email protected]