Document that `||` is a reserved string that cannot be used in state keys. (#3524)

* Document that `||` is a reserved key that cannot be used in state keys.

Signed-off-by: joshvanl <me@joshvanl.dev>

* `character` -> `string`

Signed-off-by: joshvanl <me@joshvanl.dev>

---------

Signed-off-by: joshvanl <me@joshvanl.dev>
Co-authored-by: Mark Fussell <markfussell@gmail.com>
This commit is contained in:
Josh van Leeuwen 2023-06-10 01:54:50 +01:00 committed by GitHub
parent 7aeab68b33
commit 7e9152fca4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 0 deletions

View File

@ -68,6 +68,9 @@ POST http://localhost:3500/v1.0/state/myStore?metadata.contentType=application/j
```
> All URL parameters are case-sensitive.
> Since `||` is a reserved string it cannot be used in the `<state key>`
> field.
#### Request Body
A JSON array of state objects. Each state object is comprised with the following fields: