Skip to content

Commit 7fed254

Browse files
committed
Document additional metadata values in UA
1 parent abd1814 commit 7fed254

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

docs/user-agent.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# User Agent
2+
3+
## Additional Metadata
4+
5+
The table below documents additional metadata the SDK may include in the `User-Agent` header of a request. These take the form of `md/[name]#[value]` in the request.
6+
7+
|Name|Value(s)|Description|
8+
|---|---|---|
9+
|`rb`||The request body implementation. This includes `ContentStreamProvider` for sync clients, and `AsyncRequestBody` for async clients.|
10+
||`f`|"File". The body implementation reads from a file.|
11+
||`b`|"Bytes". The body implementation reads from a byte array.|
12+
||`c`|"String" The body implementation reads from a string. |
13+
||`s`|"Stream". The body implementation reads from an `InputStream`.|
14+
||`p`|"Publisher". The body implementation reads from an `SdkPublisher`.|
15+
||`u`|"unknown"|
16+
|`rt`||The response transformer implementation. This includes `ResponseTransformer` for sync clients, and `AsyncResponseTransformer` for async clients.|
17+
||`f`|"File". The response transformer writes the response body to a file.|
18+
||`b`|"Bytes". The response transformer writes the response body to a byte array.|
19+
||`s`|"Stream". The response transformer adapts the response body to an `InputStream`.|
20+
||`p`|"Publisher". The response transformer adapts the response body to an `SdkPublisher`.|
21+
||`u`|"unknown"|

0 commit comments

Comments
 (0)