luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

Merge pull request #12580 from hashicorp/docs/results-filtered-by-acl-awareness 

docs: mention filtered by ACLs in affected APIs
This commit is contained in:
Jared Kirschner 2022-03-21 12:59:59 -04:00 committed by GitHub
parent e90c2a6994 fcec9a18ce
commit dcc6ad0cac
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 56 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
website/content/api-docs/agent/check.mdx
View File

@ -21,6 +21,8 @@ there is no leader elected. The agent performs active
[anti-entropy](/docs/architecture/anti-entropy), so in most situations
everything will be in sync within a few seconds.
@include 'http_api_results_filtered_by_acls.mdx'
| Method | Path | Produces |
| ------ | --------------- | ------------------ |
| `GET` | `/agent/checks` | `application/json` |

2
website/content/api-docs/agent/index.mdx
View File

@ -213,6 +213,8 @@ to the nature of gossip, this is eventually consistent: the results may differ
by agent. The strongly consistent view of nodes is instead provided by
`/v1/catalog/nodes`.
@include 'http_api_results_filtered_by_acls.mdx'
| Method | Path | Produces |
| ------ | ---------------- | ------------------ |
| `GET` | `/agent/members` | `application/json` |

2
website/content/api-docs/agent/service.mdx
View File

@ -23,6 +23,8 @@ while there is no leader elected. The agent performs active
[anti-entropy](/docs/architecture/anti-entropy), so in most situations
everything will be in sync within a few seconds.
@include 'http_api_results_filtered_by_acls.mdx'
| Method | Path | Produces |
| ------ | ----------------- | ------------------ |
| `GET` | `/agent/services` | `application/json` |

14
website/content/api-docs/catalog.mdx
View File

@ -285,6 +285,8 @@ $ curl \
This endpoint and returns the nodes registered in a given datacenter.
@include 'http_api_results_filtered_by_acls.mdx'
| Method | Path | Produces |
| ------ | ---------------- | ------------------ |
| `GET` | `/catalog/nodes` | `application/json` |
@ -382,6 +384,8 @@ the following selectors and filter operations being supported:
This endpoint returns the services registered in a given datacenter.
@include 'http_api_results_filtered_by_acls.mdx'
| Method | Path | Produces |
| ------ | ------------------- | ------------------ |
| `GET` | `/catalog/services` | `application/json` |
@ -438,6 +442,8 @@ a given service.
This endpoint returns the nodes providing a service in a given datacenter.
@include 'http_api_results_filtered_by_acls.mdx'
| Method | Path | Produces |
| ------ | --------------------------- | ------------------ |
| `GET` | `/catalog/service/:service` | `application/json` |
@ -651,6 +657,8 @@ This will include both proxies and native integrations. A service may
register both Connect-capable and incapable services at the same time,
so this endpoint may be used to filter only the Connect-capable endpoints.
@include 'http_api_results_filtered_by_acls.mdx'
| Method | Path | Produces |
| ------ | --------------------------- | ------------------ |
| `GET` | `/catalog/connect/:service` | `application/json` |
@ -662,6 +670,8 @@ Parameters and response format are the same as
This endpoint returns the node's registered services.
@include 'http_api_results_filtered_by_acls.mdx'
| Method | Path | Produces |
| ------ | --------------------- | ------------------ |
| `GET` | `/catalog/node/:node` | `application/json` |
@ -791,6 +801,8 @@ top level Node object. The following selectors and filter operations are support
This endpoint returns the node's registered services.
@include 'http_api_results_filtered_by_acls.mdx'
| Method | Path | Produces |
| ------ | ------------------------------ | ------------------ |
| `GET` | `/catalog/node-services/:node` | `application/json` |
@ -925,6 +937,8 @@ top level object. The following selectors and filter operations are supported:
This endpoint returns the services associated with an ingress gateway or terminating gateway.
@include 'http_api_results_filtered_by_acls.mdx'
| Method | Path | Produces |
| ------ | ------------------------------------ | ------------------ |
| `GET` | `/catalog/gateway-services/:gateway` | `application/json` |

2
website/content/api-docs/config.mdx
View File

@ -161,6 +161,8 @@ $ curl \
This endpoint returns all config entries of the given kind.
@include 'http_api_results_filtered_by_acls.mdx'
| Method | Path | Produces |
| ------ | --------------- | ------------------ |
| `GET` | `/config/:kind` | `application/json` |

2
website/content/api-docs/connect/intentions.mdx
View File

@ -435,6 +435,8 @@ $ curl \
This endpoint lists all intentions.
@include 'http_api_results_filtered_by_acls.mdx'
| Method | Path | Produces |
| ------ | --------------------- | ------------------ |
| `GET` | `/connect/intentions` | `application/json` |

2
website/content/api-docs/event.mdx
View File

@ -93,6 +93,8 @@ agent may have a different view of the events. Events are broadcast using the
[gossip protocol](/docs/architecture/gossip), so they have no global ordering
nor do they make a promise of delivery.
@include 'http_api_results_filtered_by_acls.mdx'
| Method | Path | Produces |
| ------ | ------------- | ------------------ |
| `GET` | `/event/list` | `application/json` |

12
website/content/api-docs/health.mdx
View File

@ -18,6 +18,8 @@ raw entries.
This endpoint returns the checks specific to the node provided on the path.
@include 'http_api_results_filtered_by_acls.mdx'
| Method | Path | Produces |
| ------ | -------------------- | ------------------ |
| `GET` | `/health/node/:node` | `application/json` |
@ -113,6 +115,8 @@ the following selectors and filter operations being supported:
This endpoint returns the checks associated with the service provided on the
path.
@include 'http_api_results_filtered_by_acls.mdx'
| Method | Path | Produces |
| ------ | ------------------------- | ------------------ |
| `GET` | `/health/checks/:service` | `application/json` |
@ -203,6 +207,8 @@ This endpoint returns the service instances providing the service indicated on t
Users can also build in support for dynamic load balancing and other features by
incorporating the use of health checks.
@include 'http_api_results_filtered_by_acls.mdx'
| Method | Path | Produces |
| ------ | -------------------------- | ------------------ |
| `GET` | `/health/service/:service` | `application/json` |
@ -409,6 +415,8 @@ This will include both proxies and native integrations. A service may
register both Connect-capable and incapable services at the same time,
so this endpoint may be used to filter only the Connect-capable endpoints.
@include 'http_api_results_filtered_by_acls.mdx'
| Method | Path | Produces |
| ------ | -------------------------- | ------------------ |
| `GET` | `/health/connect/:service` | `application/json` |
@ -423,6 +431,8 @@ Parameters and response format are the same as
This endpoint returns the service instances providing an [ingress
gateway](/docs/connect/gateways/ingress-gateway) for a service in a given datacenter.
@include 'http_api_results_filtered_by_acls.mdx'
| Method | Path | Produces |
| ------ | -------------------------- | ------------------ |
| `GET` | `/health/ingress/:service` | `application/json` |
@ -438,6 +448,8 @@ endpoint does not support the [streaming backend](/api/features/blocking#streami
This endpoint returns the checks in the state provided on the path.
@include 'http_api_results_filtered_by_acls.mdx'
| Method | Path | Produces |
| ------ | ---------------------- | ------------------ |
| `GET` | `/health/state/:state` | `application/json` |

6
website/content/api-docs/kv.mdx
View File

@ -29,6 +29,12 @@ This endpoint returns the specified key. If no key exists at the given path, a
For multi-key reads (up to a limit of 64 KV operations) please consider using
[transactions](/api/txn) instead.
If the [`recurse`](#recurse) or [`keys`](#keys) query parameters are `true`,
this endpoint will return an array of keys. In this case,
the HTTP response includes the `X-Consul-Results-Filtered-By-ACLs: true` header
if the response array excludes results due to ACL policy configuration.
Refer to the [HTTP API documentation](/api-docs#results-filtered-by-acls) for more information.
| Method | Path | Produces |
| ------ | ---------- | ------------------ |
| `GET` | `/kv/:key` | `application/json` |

2
website/content/api-docs/namespaces.mdx
View File

@ -427,6 +427,8 @@ $ curl --request DELETE \
This endpoint lists all the Namespaces. The output will be filtered based on the
privileges of the ACL token used for the request.
@include 'http_api_results_filtered_by_acls.mdx'
| Method | Path | Produces |
| ------ | ------------- | ------------------ |
| `GET` | `/namespaces` | `application/json` |

6
website/content/api-docs/query.mdx
View File

@ -299,6 +299,8 @@ $ curl \
This endpoint returns a list of all prepared queries.
@include 'http_api_results_filtered_by_acls.mdx'
| Method | Path | Produces |
| ------ | -------- | ------------------ |
| `GET` | `/query` | `application/json` |
@ -478,6 +480,10 @@ $ curl \
This endpoint executes an existing prepared query. If no query exists by the
given ID, an error is returned.
The HTTP response includes the `X-Consul-Results-Filtered-By-ACLs: true` header
if the [`Nodes`](#nodes) response array excludes results due to ACL policy configuration.
Refer to the [HTTP API documentation](/api-docs#results-filtered-by-acls) for more information.
| Method | Path | Produces |
| ------ | ---------------------- | ------------------ |
| `GET` | `/query/:uuid/execute` | `application/json` |

4
website/content/api-docs/session.mdx
View File

@ -230,6 +230,8 @@ If the session does not exist, an empty JSON list `[]` is returned.
This endpoint returns the active sessions for a given node.
@include 'http_api_results_filtered_by_acls.mdx'
| Method | Path | Produces |
| :----- | :-------------------- | ------------------ |
| `GET` | `/session/node/:node` | `application/json` |
@ -292,6 +294,8 @@ $ curl \
This endpoint returns the list of active sessions.
@include 'http_api_results_filtered_by_acls.mdx'
| Method | Path | Produces |
| :----- | :-------------- | ------------------ |
| `GET` | `/session/list` | `application/json` |