Intention ACL API clarification (#4547)

This commit is contained in:
Paul Banks 2018-08-20 20:33:15 +01:00 committed by GitHub
parent 12342e0d0e
commit cb340cefea
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -30,9 +30,12 @@ The table below shows this endpoint's support for
[consistency modes](/api/index.html#consistency-modes), and [consistency modes](/api/index.html#consistency-modes), and
[required ACLs](/api/index.html#acls). [required ACLs](/api/index.html#acls).
| Blocking Queries | Consistency Modes | ACL Required | | Blocking Queries | Consistency Modes | ACL Required |
| ---------------- | ----------------- | ---------------- | | ---------------- | ----------------- | ------------------------------ |
| `NO` | `none` | `service {intentions:write}` | | `NO` | `none` | `intentions:write`<sup>1</sup> |
<sup>1</sup> Intention ACL rules are specified as part of a `service` rule.
See [Intention Management Permissions](/docs/connect/intentions.html#intention-management-permissions) for more details.
### Parameters ### Parameters
@ -99,7 +102,10 @@ The table below shows this endpoint's support for
| Blocking Queries | Consistency Modes | ACL Required | | Blocking Queries | Consistency Modes | ACL Required |
| ---------------- | ----------------- | --------------- | | ---------------- | ----------------- | --------------- |
| `YES` | `all` | `service:read` | | `YES` | `all` | `intentions:read`<sup>1</sup> |
<sup>1</sup> Intention ACL rules are specified as part of a `service` rule.
See [Intention Management Permissions](/docs/connect/intentions.html#intention-management-permissions) for more details.
### Parameters ### Parameters
@ -151,7 +157,10 @@ The table below shows this endpoint's support for
| Blocking Queries | Consistency Modes | ACL Required | | Blocking Queries | Consistency Modes | ACL Required |
| ---------------- | ----------------- | --------------- | | ---------------- | ----------------- | --------------- |
| `YES` | `all` | `service:read` | | `YES` | `all` | `intentions:read`<sup>1</sup> |
<sup>1</sup> Intention ACL rules are specified as part of a `service` rule.
See [Intention Management Permissions](/docs/connect/intentions.html#intention-management-permissions) for more details.
### Sample Request ### Sample Request
@ -200,7 +209,11 @@ The table below shows this endpoint's support for
| Blocking Queries | Consistency Modes | ACL Required | | Blocking Queries | Consistency Modes | ACL Required |
| ---------------- | ----------------- | ---------------- | | ---------------- | ----------------- | ---------------- |
| `NO` | `none` | `service:write` | | `NO` | `none` | `intentions:write`<sup>1</sup> |
<sup>1</sup> Intention ACL rules are specified as part of a `service` rule.
See [Intention Management Permissions](/docs/connect/intentions.html#intention-management-permissions) for more details.
### Parameters ### Parameters
@ -244,7 +257,11 @@ The table below shows this endpoint's support for
| Blocking Queries | Consistency Modes | ACL Required | | Blocking Queries | Consistency Modes | ACL Required |
| ---------------- | ----------------- | ---------------- | | ---------------- | ----------------- | ---------------- |
| `NO` | `none` | `service:write` | | `NO` | `none` | `intentions:write`<sup>1</sup> |
<sup>1</sup> Intention ACL rules are specified as part of a `service` rule.
See [Intention Management Permissions](/docs/connect/intentions.html#intention-management-permissions) for more details.
### Parameters ### Parameters
@ -281,7 +298,10 @@ The table below shows this endpoint's support for
| Blocking Queries | Consistency Modes | ACL Required | | Blocking Queries | Consistency Modes | ACL Required |
| ---------------- | ----------------- | ---------------- | | ---------------- | ----------------- | ---------------- |
| `NO` | `none` | `service:read` | | `NO` | `none` | `intentions:read`<sup>1</sup> |
<sup>1</sup> Intention ACL rules are specified as part of a `service` rule.
See [Intention Management Permissions](/docs/connect/intentions.html#intention-management-permissions) for more details.
### Parameters ### Parameters
@ -324,7 +344,10 @@ The table below shows this endpoint's support for
| Blocking Queries | Consistency Modes | ACL Required | | Blocking Queries | Consistency Modes | ACL Required |
| ---------------- | ----------------- | --------------- | | ---------------- | ----------------- | --------------- |
| `NO` | `none` | `service:read` | | `NO` | `none` | `intentions:read`<sup>1</sup> |
<sup>1</sup> Intention ACL rules are specified as part of a `service` rule.
See [Intention Management Permissions](/docs/connect/intentions.html#intention-management-permissions) for more details.
### Parameters ### Parameters