Skip to content

Commit

Permalink
Merge pull request #133 from dyladan/no-unicode-explain
Browse files Browse the repository at this point in the history
Add notes explaining missing unicode character support
  • Loading branch information
kalyanaj authored Apr 23, 2024
2 parents 3708e51 + d28c54f commit 18cdee1
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
14 changes: 13 additions & 1 deletion baggage/HTTP_HEADER_FORMAT.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ baggage-octet = %x21 / %x23-2B / %x2D-3A / %x3C-5B / %x5D-7E
OWS = *( SP / HTAB ) ; optional white space, as defined in RFC 7230, Section 3.2.3
```

`token` is defined in [[!RFC7230]], Section 3.2.6: https://tools.ietf.org/html/rfc7230#section-3.2.6
`token` is defined in [[RFC7230]], Section 3.2.6: https://tools.ietf.org/html/rfc7230#section-3.2.6

The definition of `OWS` is taken from [[RFC7230]], Section 3.2.3: https://tools.ietf.org/html/rfc7230#section-3.2.3

Expand All @@ -52,6 +52,12 @@ Producers SHOULD try to produce a `baggage-string` without any `list-member`s wh
A `token` which identifies a `value` in the `baggage`. `token` is defined in [RFC7230, Section 3.2.6](https://tools.ietf.org/html/rfc7230#section-3.2.6).
Leading and trailing whitespaces (`OWS`) are allowed and are not considered to be a part of the key.

<aside class="note">

Though the baggage header is a [[UTF-8]] encoded [[UNICODE]] string, `key` is limited to the [=ASCII code points=] allowed by the definition of token in [[RFC7230]]. This is due to the implementation details of stable implementations prior to the writing of this specification.

</aside>

#### value

A string which contains a value identified by the `key`.
Expand All @@ -67,6 +73,12 @@ Leading and trailing whitespaces (`OWS`) are allowed and are not considered to b
Note, `value` MAY contain any number of the equal sign (`U+003D`) code points. Parsers
MUST NOT assume that the equal sign is only used to separate `key` and `value`.

<aside class="note">

Though the baggage header is a [[UTF-8]] encoded [[UNICODE]] string, `value` is limited to the [=ASCII code points=] of `baggage-octet`. This is due to the implementation details of stable implementations prior to the writing of this specification.

</aside>

#### property

Additional metadata MAY be appended to values in the form of property set, represented as semi-colon `;` delimited list of keys and/or key-value pairs, e.g. `;k1=v1;k2;k3=v3`.
Expand Down
1 change: 1 addition & 0 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
href: 'https://w3cdistributedtracing.slack.com/'
}]
}],
xref: ["infra"]
};
</script>
</head>
Expand Down

0 comments on commit 18cdee1

Please sign in to comment.