Document result inconsistencies for getServicesMap#92
Merged
sherold merged 1 commit intoinstana:masterfrom Dec 7, 2023
Merged
Conversation
sherold
reviewed
Dec 7, 2023
spec/descriptions/getServicesMap.md
Outdated
|
|
||
| ## Result fields: | ||
|
|
||
| - The `snapshotIds` field for result services is not used and always an empty list. |
There was a problem hiding this comment.
Suggested change
| - The `snapshotIds` field for result services is not used and always an empty list. | |
| - The `snapshotIds` field for result services is unsupported and always empty. |
spec/descriptions/getServicesMap.md
Outdated
| @@ -0,0 +1,7 @@ | |||
| This endpoint retrieves services and connections (call paths) between them for calls in the scope given by the parameters. | |||
|
|
|||
| ## Result fields: | |||
There was a problem hiding this comment.
What do you think of changing the header to Erratum?
spec/descriptions/getServicesMap.md
Outdated
| ## Result fields: | ||
|
|
||
| - The `snapshotIds` field for result services is not used and always an empty list. | ||
| - The `applications`, `maxSeverity` and `numberOfOpenIssues` fields for result services are not currently used and not present in the result JSON |
There was a problem hiding this comment.
Suggested change
| - The `applications`, `maxSeverity` and `numberOfOpenIssues` fields for result services are not currently used and not present in the result JSON | |
| - The `applications`, `maxSeverity` and `numberOfOpenIssues` fields for result services are unsupported and always missing. |
spec/descriptions/getServicesMap.md
Outdated
|
|
||
| - The `snapshotIds` field for result services is not used and always an empty list. | ||
| - The `applications`, `maxSeverity` and `numberOfOpenIssues` fields for result services are not currently used and not present in the result JSON | ||
| - The `applications` field for result services is not currently used and not present in the result JSON, even though it is declared as required in the result schema. |
There was a problem hiding this comment.
This field is already covered in the previous bullet point.
Contributor
Author
|
@sherold thanks, updated |
timoinstana
reviewed
Dec 7, 2023
spec/descriptions/getServicesMap.md
Outdated
|
|
||
| ## Errata: | ||
|
|
||
| - The `snapshotIds` field for result services is unsupported and always empty. |
There was a problem hiding this comment.
suggestion: As they all target the result services, we can have something like
In the result services
- the ...,
- the ... and
- ...
There was a problem hiding this comment.
I would also prefer to have them ordered by their appearance in the OpenAPI result.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Customer reported unsupported result fields in the spec.
Can't fix the OpenAPI spec without affecting generated clients in a possibly breaking way, so just documenting the deficiencies.