swagger: Document meaning of value -1 for parentId of TreeDataModel #191
Conversation
This file contains hidden or 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
PatrickTasse
requested changes
May 27, 2025
| */ | ||
| @Schema(description = "Unique id to identify this parent's entry, " + | ||
| "optional if this entry does not have a parent.") | ||
| @Schema(description = "Optional unique id to identify this parent's entry. " + |
Contributor
There was a problem hiding this comment.
I think it was meant to say "this entry's parent" ?
| @Schema(description = "Unique id to identify this parent's entry, " + | ||
| "optional if this entry does not have a parent.") | ||
| @Schema(description = "Optional unique id to identify this parent's entry. " + | ||
| "Use -1 if this entry has no parent. If omitted, this entry has no parent.") |
Contributor
There was a problem hiding this comment.
It feels like we are encouraging the use of -1 when omitting would be just as good. Maybe I would suggest:
"If the parentId is -1 or omitted, this entry has no parent".
Fixes eclipse-cdt-cloud/trace-server-protocol#65 Signed-off-by: Bernd Hufmann <[email protected]>
bhufmann
added a commit
to bhufmann/trace-server-protocol
that referenced
this pull request
May 27, 2025
This PR adds an issue and PR template in this repo, heavily inspired from those of the theia-trace-extension. Corresponding swagger model update: eclipse-tracecompass-incubator/org.eclipse.tracecompass.incubator#191 Signed-off-by: Bernd Hufmann <[email protected]>
PatrickTasse
approved these changes
May 27, 2025
bhufmann
added a commit
to bhufmann/trace-server-protocol
that referenced
this pull request
May 27, 2025
Fixes eclipse-cdt-cloud#65 Corresponding swagger model update: eclipse-tracecompass-incubator/org.eclipse.tracecompass.incubator#191 Signed-off-by: Bernd Hufmann <[email protected]>
1 task
bhufmann
merged commit 8af6d85
into
eclipse-tracecompass-incubator:master
2 checks passed
bhufmann
added a commit
to eclipse-cdt-cloud/trace-server-protocol
that referenced
this pull request
May 27, 2025
Fixes #65 Corresponding swagger model update: eclipse-tracecompass-incubator/org.eclipse.tracecompass.incubator#191 Signed-off-by: Bernd Hufmann <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What it does
Document meaning of value -1 for parentId of TreeDataModel in swagger model.
Fixes eclipse-cdt-cloud/trace-server-protocol#65
How to test
Generate openapi.yaml and verify change is there.
Follow-ups
Update TSP specification
Review checklist