1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00

docs(fix): change the remoteAddress description (#1539)

remoteAddress previously used the sessionId description.
This commit is contained in:
Thomas Heartman 2022-04-28 16:20:28 +02:00 committed by GitHub
parent 5f96cb3785
commit 05f4cbb708
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -23,7 +23,7 @@ The below table gives a brief overview over what the fields' intended usage is,
| `environment`[^1] | `string` | static | the environment the app is running in | | `environment`[^1] | `string` | static | the environment the app is running in |
| `userId` | `string` | dynamic | an identifier for the current user | | `userId` | `string` | dynamic | an identifier for the current user |
| `sessionId` | `string` | dynamic | an identifier for the current session | | `sessionId` | `string` | dynamic | an identifier for the current session |
| `remoteAddress` | `string` | dynamic | an identifier for the current session | | `remoteAddress` | `string` | dynamic | the app's IP address |
| `properties` | `Map<string, string>` | dynamic | a key-value store of any data you want | | `properties` | `Map<string, string>` | dynamic | a key-value store of any data you want |
| `currentTime`[^2] | `DateTime`/`string` | dynamic | A `DateTime` (or similar) data class instance or a string in an RFC3339-compatible format. **Defaults to the current time** if not set by the user. | | `currentTime`[^2] | `DateTime`/`string` | dynamic | A `DateTime` (or similar) data class instance or a string in an RFC3339-compatible format. **Defaults to the current time** if not set by the user. |