Skip to content

Commit 2344c74

Browse files
committed
add changelog
1 parent 78d92a5 commit 2344c74

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

docs/Change_Log.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Change Log
22

3+
## Updated Connection Property Field Names
4+
5+
#### Jun 17, 2022
6+
7+
The `$` prefix in [identify connection properties](#DOCS_TOPICS_GATEWAY/identify-identify-connection-properties) are deprecated. The new field names are `os`, `browser`, and `device`. When passed, the `$`-prefixed names will resolve to the new ones.
8+
9+
In the next major API version, support for the previous field names (`$os`, `$browser`, and `$device`) will be removed.
10+
311
## Auto Moderation
412

513
#### Jun 16, 2022

docs/topics/Gateway.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -577,7 +577,7 @@ Used to trigger the initial handshake with the gateway.
577577
| device | string | your library name |
578578

579579
> warn
580-
> These fields originally were $ prefixed (i.e: $browser) but this syntax is deprecated. While they currently still work, it is recommended to move to non-prefixed fields.
580+
> These fields originally were $ prefixed (i.e: `$browser`) but [this syntax is deprecated](#DOCS_CHANGE_LOG/updated-connection-property-field-names). While they currently still work, it is recommended to move to non-prefixed fields.
581581
582582
###### Example Identify
583583

0 commit comments

Comments
 (0)