Clarify success response for telemetry update #461
Merged
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
The telemetry spec only says that when new telemetry are successfully received, the server should: > Responds with number of successfully written telemetry data points and total number of provided points. But the format is not specified.
|
This PR would be rendered obsolete by #462 |
|
Waiting to merge to see if we move forward on #462 for the 1.0.0. It needs some decisions and a PR. |
marie-x
reviewed
Jun 24, 2020
agency/README.md
Outdated
| @@ -209,7 +209,7 @@ Body Params: | |||
|
|
|||
| | Field | Type | Field Description | | |||
| | --------- | ------------------------------ | ------------------------------------------------------------------------------------------------------- | | |||
| | `result` | String | Responds with number of successfully written telemetry data points and total number of provided points. | | |||
| | `result` | String | Responds with number of successfully written telemetry data points and total number of provided points. Format to use: `{success}/{total}`, both amounts as integers. | | |||
There was a problem hiding this comment.
How about adding successes and total as integers, in addition to a result string, or dropping result entirely?
- Change response code to 200 to solve issue #461 - Split `result` response field in `success` and `total`
|
@karcass @schnuerle I just updated the PR, you can review it |
schnuerle
approved these changes
Jun 26, 2020
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.
MDS Pull Request
Thank you for your contribution!
For most Pull Requests, the target branch should be
dev. Please ensure you are targetingdevto avoid complications and help make the Review process as smooth as possible.Explain pull request
The telemetry spec only says that when new telemetry are successfully received, the server should:
But the spec does not specify how those two numbers should be written.
Is this a breaking change
A breaking change would require consumers or implementors of the API to modify their code for it to continue to function (ex: renaming of a required field or the change in data type of an existing field). A non-breaking change would allow existing code to continue to function (ex: addition of an optional field or the creation of a new optional endpoint).
Impacted Spec
Which spec(s) will this pull request impact?
agencyAdditional context
None