Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Improved Access Control general syntax description #2119

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions docs/features/access-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,23 +41,23 @@ The Stream ID uses UTF-8 encoding.

## General Syntax

This recommended syntax starts with the characters known as an executable
specification in POSIX: `#!`.
The recommended syntax starts with the characters known as an executable specification in POSIX: `#!`.

The next two characters are:
The next character defines the format used for the following key-value pair syntax.
At the moment, there is only one supported syntax identified by `:` and described below.

- `:` - marks the format of the following key-value pair syntax (the only one defined currently).
- The content format, which is either:
- `:` - the comma-separated keys with no nesting
- `{` - like above, but nesting is allowed and must end with `}`
Everything that comes after a syntax identifier is further referenced as the content of the Stream ID.

(Nesting means that you can have multiple level brace-enclosed parts inside.)
The content starts with a `:` or `{` character identifying its format:

The form of the key-value pair is:
- `:` : comma-separated key-value pairs with no nesting,
- `{` : a nested block with one or several key-value pairs that must end with a `}` character. Nesting means that multiple level brace-enclosed parts are allowed.

```js
key1=value1,key2=value2...
```
The form of the key-value pair is

~~~
key1=value1,key2=value2,...
~~~

## Standard Keys

Expand Down