info: document U (User-Agent) envelope field#131
Draft
chrismerck wants to merge 1 commit into
Draft
Conversation
New optional envelope field U carries the User-Agent identifier of the requestor, sanitized to at most 128 printable ASCII bytes (over-long values are truncated and end in ~). The HTTP transport populates it from the User-Agent header; down messages accept it so clients on non-HTTP transports can identify themselves. The bullet explicitly calls out the case distinction between the new uppercase U (User-Agent) and the existing lowercase u (Unixtime request field) so integrators do not confuse the two keys. Also backfills the x (source transport) field in the MQTT section, which has been documented on BPUP since v2.12.1.
|
The rendered doc is at: https://bond-api-docs.s3.amazonaws.com/merck-user-agent-envelope-field-local.html |
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
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.
tl;dr: ___
Summary
Documents a new optional envelope field
Uon the BPUP and MQTT up-messages: the User-Agent identifier of the requestor, sanitized to at most 128 printable ASCII bytes (over-long values end in~). The HTTP transport populates it from theUser-Agentheader; down-messages accept it so clients on non-HTTP transports can identify themselves.The bullet explicitly calls out the case distinction between the new uppercase
U(User-Agent) and the existing lowercaseu(Unixtime request field) so integrators don't confuse the two keys.Also backfills the
x(source transport) field in the MQTT section, documented on BPUP since v2.12.1.Notes
[Since v4.34.0]is a placeholder — confirm against the shipping firmware release before merge.