-
Notifications
You must be signed in to change notification settings - Fork 231
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
Clarify success response for telemetry update #461
Conversation
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. |
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 |
MDS Pull Request
Thank you for your contribution!
For most Pull Requests, the target branch should be
dev
. Please ensure you are targetingdev
to 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?
agency
Additional context
None