status-im/consul
2
0
Fork 0
mirror of https://github.com/status-im/consul.git synced 2025-02-18 00:27:04 +00:00
Code Issues Projects Releases Wiki Activity

DOCS: CE-556 Add partition parameter to API endpoint docs (#21374)

Browse Source 
* CD-556 rename partition partial that's only used in CLI

Update CLI pages for partial rename

API: Add partial for partition as body option
API: Add partial for partition as query parameter

Update API peering and members pages

* acl/auth-methods.mdx

Update partition partials to be generic

* binding-rules.mdx, policies.mdx

* roles.mdx, templated-policies.mdx

* tokens.mdx, catalog.mdx, config.mdx, intentions.mdx

* service.mdx, exported-services.mdx, kv.mdx, namespaces.mdx

* Apply suggestions from code review

Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>

* Add partial to acl/auth-methods.mdx

Fix headings indent in a few files.

* Update website/content/api-docs/acl/auth-methods.mdx

Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>

---------

Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>
This commit is contained in:
Aimee Ukasick 2024-07-18 12:02:45 -05:00 committed by GitHub
parent a9d92d020d
commit 654528ca60
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
81 changed files with 190 additions and 90 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
website/content/api-docs/acl/auth-methods.mdx
View File

@ -107,6 +107,8 @@ The corresponding CLI command is [`consul acl auth-method create`](/consul/comma
prefixed-${serviceaccount.name} prefixed-${serviceaccount.name}
``` ```
@include 'http-api-body-options-partition.mdx'
### Sample Payload ### Sample Payload
```json ```json
@ -178,6 +180,8 @@ The corresponding CLI command is [`consul acl auth-method read`](/consul/command
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the auth method you look up. - `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the auth method you look up.
You can also [specify the namespace through other methods](#methods-to-specify-namespace). You can also [specify the namespace through other methods](#methods-to-specify-namespace).
@include 'http-api-query-parms-partition.mdx'
### Sample Request ### Sample Request
```shell-session ```shell-session
@ -294,6 +298,8 @@ The corresponding CLI command is [`consul acl auth-method update`](/consul/comma
prefixed-${serviceaccount.name} prefixed-${serviceaccount.name}
``` ```
@include 'http-api-body-options-partition.mdx'
### Sample Payload ### Sample Payload
```json ```json
@ -369,6 +375,8 @@ The corresponding CLI command is [`consul acl auth-method delete`](/consul/comma
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the auth method you delete. - `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the auth method you delete.
You can also [specify the namespace through other methods](#methods-to-specify-namespace). You can also [specify the namespace through other methods](#methods-to-specify-namespace).
@include 'http-api-query-parms-partition.mdx'
### Sample Request ### Sample Request
```shell-session ```shell-session
@ -408,8 +416,9 @@ The corresponding CLI command is [`consul acl auth-method list`](/consul/command
The namespace may be specified as '\*' to return results for all namespaces. The namespace may be specified as '\*' to return results for all namespaces.
You can also [specify the namespace through other methods](#methods-to-specify-namespace). You can also [specify the namespace through other methods](#methods-to-specify-namespace).
The namespace may be specified as '\*' and then The namespace may be specified as '\*' and then results are returned for all namespaces.
results will be returned for all namespaces.
@include 'http-api-query-parms-partition.mdx'
## Sample Request ## Sample Request

14
website/content/api-docs/acl/binding-rules.mdx
View File

@ -172,6 +172,8 @@ The corresponding CLI command is [`consul acl binding-rule create`](/consul/comm
This field takes precedence over the `ns` query parameter, This field takes precedence over the `ns` query parameter,
one of several [other methods to specify the namespace](#methods-to-specify-namespace). one of several [other methods to specify the namespace](#methods-to-specify-namespace).
@include 'http-api-body-options-partition.mdx'
### Sample Payload ### Sample Payload
```json ```json
@ -238,6 +240,8 @@ The corresponding CLI command is [`consul acl binding-rule read`](/consul/comman
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the binding rule you lookup. - `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the binding rule you lookup.
You can also [specify the namespace through other methods](#methods-to-specify-namespace). You can also [specify the namespace through other methods](#methods-to-specify-namespace).
@include 'http-api-query-parms-partition.mdx'
### Sample Request ### Sample Request
```shell-session ```shell-session
@ -423,6 +427,8 @@ The corresponding CLI command is [`consul acl binding-rule update`](/consul/comm
This field takes precedence over the `ns` query parameter, This field takes precedence over the `ns` query parameter,
one of several [other methods to specify the namespace](#methods-to-specify-namespace). one of several [other methods to specify the namespace](#methods-to-specify-namespace).
@include 'http-api-body-options-partition.mdx'
### Sample Payload ### Sample Payload
```json ```json
@ -489,6 +495,8 @@ The corresponding CLI command is [`consul acl binding-rule delete`](/consul/comm
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the binding rule you delete. - `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the binding rule you delete.
You can also [specify the namespace through other methods](#methods-to-specify-namespace). You can also [specify the namespace through other methods](#methods-to-specify-namespace).
@include 'http-api-query-parms-partition.mdx'
### Sample Request ### Sample Request
```shell-session ```shell-session
@ -522,7 +530,7 @@ The table below shows this endpoint's support for
The corresponding CLI command is [`consul acl binding-rule list`](/consul/commands/acl/binding-rule/list). The corresponding CLI command is [`consul acl binding-rule list`](/consul/commands/acl/binding-rule/list).
## Query Parameters ### Query Parameters
- `authmethod` `(string: "")` - Filters the binding rule list to those binding - `authmethod` `(string: "")` - Filters the binding rule list to those binding
rules that are linked with the specific named auth method. rules that are linked with the specific named auth method.
@ -531,7 +539,9 @@ The corresponding CLI command is [`consul acl binding-rule list`](/consul/comman
The namespace may be specified as '\*' to return results for all namespaces. The namespace may be specified as '\*' to return results for all namespaces.
You can also [specify the namespace through other methods](#methods-to-specify-namespace). You can also [specify the namespace through other methods](#methods-to-specify-namespace).
## Sample Request @include 'http-api-query-parms-partition.mdx'
### Sample Request
```shell-session ```shell-session
$ curl --request GET http://127.0.0.1:8500/v1/acl/binding-rules $ curl --request GET http://127.0.0.1:8500/v1/acl/binding-rules

12
website/content/api-docs/acl/policies.mdx
View File

@ -57,6 +57,8 @@ The corresponding CLI command is [`consul acl policy create`](/consul/commands/a
This field takes precedence over the `ns` query parameter, This field takes precedence over the `ns` query parameter,
one of several [other methods to specify the namespace](#methods-to-specify-namespace). one of several [other methods to specify the namespace](#methods-to-specify-namespace).
@include 'http-api-body-options-partition.mdx'
### Sample Payload ### Sample Payload
```json ```json
@ -170,6 +172,8 @@ The corresponding CLI command is [`consul acl policy read -name=<string>`](/cons
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the policy you lookup. - `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the policy you lookup.
You can also [specify the namespace through other methods](#methods-to-specify-namespace). You can also [specify the namespace through other methods](#methods-to-specify-namespace).
@include 'http-api-query-parms-partition.mdx'
### Sample Request ### Sample Request
```shell-session ```shell-session
@ -242,6 +246,8 @@ The corresponding CLI command is [`consul acl policy update`](/consul/commands/a
This field takes precedence over the `ns` query parameter, This field takes precedence over the `ns` query parameter,
one of several [other methods to specify the namespace](#methods-to-specify-namespace). one of several [other methods to specify the namespace](#methods-to-specify-namespace).
@include 'http-api-body-options-partition.mdx'
### Sample Payload ### Sample Payload
```json ```json
@ -307,6 +313,8 @@ The corresponding CLI command is [`consul acl policy delete`](/consul/commands/a
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the policy you delete. - `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the policy you delete.
You can also [specify the namespace through other methods](#methods-to-specify-namespace). You can also [specify the namespace through other methods](#methods-to-specify-namespace).
@include 'http-api-query-parms-partition.mdx'
### Sample Request ### Sample Request
```shell-session ```shell-session
@ -346,7 +354,9 @@ The corresponding CLI command is [`consul acl policy list`](/consul/commands/acl
The namespace may be specified as '\*' to return results for all namespaces. The namespace may be specified as '\*' to return results for all namespaces.
You can also [specify the namespace through other methods](#methods-to-specify-namespace). You can also [specify the namespace through other methods](#methods-to-specify-namespace).
## Sample Request @include 'http-api-query-parms-partition.mdx'
### Sample Request
```shell-session ```shell-session
$ curl --request GET http://127.0.0.1:8500/v1/acl/policies $ curl --request GET http://127.0.0.1:8500/v1/acl/policies

12
website/content/api-docs/acl/roles.mdx
View File

@ -95,6 +95,8 @@ The corresponding CLI command is [`consul acl role create`](/consul/commands/acl
This field takes precedence over the `ns` query parameter, This field takes precedence over the `ns` query parameter,
one of several [other methods to specify the namespace](#methods-to-specify-namespace). one of several [other methods to specify the namespace](#methods-to-specify-namespace).
@include 'http-api-body-options-partition.mdx'
### Sample Payload ### Sample Payload
```json ```json
@ -223,6 +225,8 @@ The corresponding CLI command is [`consul acl role read`](/consul/commands/acl/r
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the role you lookup. - `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the role you lookup.
You can also [specify the namespace through other methods](#methods-to-specify-namespace). You can also [specify the namespace through other methods](#methods-to-specify-namespace).
@include 'http-api-query-parms-partition.mdx'
### Sample Request ### Sample Request
```shell-session ```shell-session
@ -306,6 +310,8 @@ The corresponding CLI command is [`consul acl role read -name=<string>`](/consul
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the role you lookup. - `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the role you lookup.
You can also [specify the namespace through other methods](#methods-to-specify-namespace). You can also [specify the namespace through other methods](#methods-to-specify-namespace).
@include 'http-api-query-parms-partition.mdx'
### Sample Request ### Sample Request
```shell-session ```shell-session
@ -418,6 +424,8 @@ The corresponding CLI command is [`consul acl role update`](/consul/commands/acl
This field takes precedence over the `ns` query parameter, This field takes precedence over the `ns` query parameter,
one of several [other methods to specify the namespace](#methods-to-specify-namespace). one of several [other methods to specify the namespace](#methods-to-specify-namespace).
@include 'http-api-body-options-partition.mdx'
### Sample Payload ### Sample Payload
```json ```json
@ -523,6 +531,8 @@ The corresponding CLI command is [`consul acl role delete`](/consul/commands/acl
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the role you delete. - `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the role you delete.
You can also [specify the namespace through other methods](#methods-to-specify-namespace). You can also [specify the namespace through other methods](#methods-to-specify-namespace).
@include 'http-api-query-parms-partition.mdx'
### Sample Request ### Sample Request
```shell-session ```shell-session
@ -565,6 +575,8 @@ The corresponding CLI command is [`consul acl role list`](/consul/commands/acl/r
The namespace may be specified as '\*' to return results for all namespaces. The namespace may be specified as '\*' to return results for all namespaces.
You can also [specify the namespace through other methods](#methods-to-specify-namespace). You can also [specify the namespace through other methods](#methods-to-specify-namespace).
@include 'http-api-query-parms-partition.mdx'
## Sample Request ## Sample Request
```shell-session ```shell-session

2
website/content/api-docs/acl/templated-policies.mdx
View File

@ -87,6 +87,8 @@ The corresponding CLI command is [`consul acl templated-policy preview`](/consul
- `Name` `(string: <optional>)` - Specifies the value of the `name` variable in the templated policy variables. - `Name` `(string: <optional>)` - Specifies the value of the `name` variable in the templated policy variables.
@include 'http-api-body-options-partition.mdx'
### Sample payload ### Sample payload
```json ```json

12
website/content/api-docs/acl/tokens.mdx
View File

@ -118,6 +118,8 @@ The corresponding CLI command is [`consul acl token create`](/consul/commands/ac
This field takes precedence over the `ns` query parameter, This field takes precedence over the `ns` query parameter,
one of several [other methods to specify the namespace](#methods-to-specify-namespace). one of several [other methods to specify the namespace](#methods-to-specify-namespace).
@include 'http-api-body-options-partition.mdx'
### Sample Payload ### Sample Payload
```json ```json
@ -217,6 +219,8 @@ The corresponding CLI command is [`consul acl token read`](/consul/commands/acl/
- `expanded` `(bool: false)` - If this field is set, the contents of all policies and - `expanded` `(bool: false)` - If this field is set, the contents of all policies and
roles affecting the token will also be returned. roles affecting the token will also be returned.
@include 'http-api-query-parms-partition.mdx'
### Sample Request ### Sample Request
```shell-session ```shell-session
@ -497,6 +501,8 @@ The corresponding CLI command is [`consul acl token update`](/consul/commands/ac
This field takes precedence over the `ns` query parameter, This field takes precedence over the `ns` query parameter,
one of several [other methods to specify the namespace](#methods-to-specify-namespace). one of several [other methods to specify the namespace](#methods-to-specify-namespace).
@include 'http-api-body-options-partition.mdx'
### Sample Payload ### Sample Payload
```json ```json
@ -591,6 +597,8 @@ The corresponding CLI command is [`consul acl token clone`](/consul/commands/acl
This field takes precedence over the `ns` query parameter, This field takes precedence over the `ns` query parameter,
one of several [other methods to specify the namespace](#methods-to-specify-namespace). one of several [other methods to specify the namespace](#methods-to-specify-namespace).
@include 'http-api-body-options-partition.mdx'
### Sample Payload ### Sample Payload
```json ```json
@ -668,6 +676,8 @@ The corresponding CLI command is [`consul acl token delete`](/consul/commands/ac
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the token you delete. - `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the token you delete.
You can also [specify the namespace through other methods](#methods-to-specify-namespace). You can also [specify the namespace through other methods](#methods-to-specify-namespace).
@include 'http-api-query-parms-partition.mdx'
### Sample Request ### Sample Request
```shell-session ```shell-session
@ -723,6 +733,8 @@ The corresponding CLI command is [`consul acl token list`](/consul/commands/acl/
The namespace may be specified as '\*' to return results for all namespaces. The namespace may be specified as '\*' to return results for all namespaces.
You can also [specify the namespace through other methods](#methods-to-specify-namespace). You can also [specify the namespace through other methods](#methods-to-specify-namespace).
@include 'http-api-query-parms-partition.mdx'
### Sample Request ### Sample Request
```shell-session ```shell-session

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

@ -261,6 +261,8 @@ The corresponding CLI command is [`consul members`](/consul/commands/members).
network segment). When querying a server, setting this to the special string `_all` network segment). When querying a server, setting this to the special string `_all`
will show members in all segments. will show members in all segments.
@include 'http-api-query-parms-partition.mdx'
### Sample Request ### Sample Request
```shell-session ```shell-session

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

@ -684,6 +684,8 @@ The `/agent/service/register` endpoint supports camel case and _snake case_ for
`false`. See [anti-entropy syncs](/consul/docs/architecture/anti-entropy) for `false`. See [anti-entropy syncs](/consul/docs/architecture/anti-entropy) for
additional information. additional information.
@include 'http-api-body-options-partition.mdx'
#### Connect Structure #### Connect Structure
For the `Connect` field, the parameters are: For the `Connect` field, the parameters are:
@ -769,6 +771,8 @@ The corresponding CLI command is [`consul services deregister`](/consul/commands
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the service you deregister. - `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the service you deregister.
You can also [specify the namespace through other methods](#methods-to-specify-namespace). You can also [specify the namespace through other methods](#methods-to-specify-namespace).
@include 'http-api-query-parms-partition.mdx'
### Sample Request ### Sample Request
```shell-session ```shell-session

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

@ -327,6 +327,8 @@ The corresponding CLI command is [`consul catalog nodes`](/consul/commands/catal
- `filter` `(string: "")` - Specifies the expression used to filter the - `filter` `(string: "")` - Specifies the expression used to filter the
queries results prior to returning the data. queries results prior to returning the data.
@include 'http-api-query-parms-partition.mdx'
### Sample Request ### Sample Request
```shell-session ```shell-session
@ -422,6 +424,8 @@ The corresponding CLI command is [`consul catalog services`](/consul/commands/ca
- `filter` `(string: "")` - Specifies the expression used to filter the - `filter` `(string: "")` - Specifies the expression used to filter the
queries results prior to returning the data. queries results prior to returning the data.
@include 'http-api-query-parms-partition.mdx'
### Filtering ### Filtering
The filter will be executed against each Service mapping within the catalog. The filter will be executed against each Service mapping within the catalog.

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

@ -71,6 +71,8 @@ The ACL required depends on the config entry being written:
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the config entry you apply. - `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the config entry you apply.
You can also [specify the namespace through other methods](#methods-to-specify-namespace). You can also [specify the namespace through other methods](#methods-to-specify-namespace).
@include 'http-api-query-parms-partition.mdx'
### Sample Payload ### Sample Payload
```json ```json
@ -150,6 +152,8 @@ The ACL required depends on the config entry kind being read:
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the config entry you lookup - `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the config entry you lookup
You can also [specify the namespace through other methods](#methods-to-specify-namespace). You can also [specify the namespace through other methods](#methods-to-specify-namespace).
@include 'http-api-query-parms-partition.mdx'
### Sample Request ### Sample Request
```shell-session ```shell-session
@ -228,6 +232,8 @@ The corresponding CLI command is [`consul config list`](/consul/commands/config/
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the config entries you lookup. - `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the config entries you lookup.
You can also [specify the namespace through other methods](#methods-to-specify-namespace). You can also [specify the namespace through other methods](#methods-to-specify-namespace).
@include 'http-api-query-parms-partition.mdx'
### Sample Request ### Sample Request
```shell-session ```shell-session
@ -321,6 +327,8 @@ The corresponding CLI command is [`consul config delete`](/consul/commands/confi
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the config entry you delete. - `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the config entry you delete.
You can also [specify the namespace through other methods](#methods-to-specify-namespace). You can also [specify the namespace through other methods](#methods-to-specify-namespace).
@include 'http-api-query-parms-partition.mdx'
### Sample Request ### Sample Request
```shell-session ```shell-session

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

@ -60,6 +60,8 @@ The corresponding CLI command is [`consul intention create -replace`](/consul/co
as shown in the [source and destination naming conventions](/consul/commands/intention#source-and-destination-naming). as shown in the [source and destination naming conventions](/consul/commands/intention#source-and-destination-naming).
You can also [specify the namespace through other methods](#methods-to-specify-namespace). You can also [specify the namespace through other methods](#methods-to-specify-namespace).
@include 'http-api-query-parms-partition.mdx'
### JSON Request Body Schema ### JSON Request Body Schema
- `SourceType` `(string: "")` - The type for the `SourceName` value. - `SourceType` `(string: "")` - The type for the `SourceName` value.
@ -151,6 +153,8 @@ The corresponding CLI command is [`consul intention create`](/consul/commands/in
as shown in the [source and destination naming conventions](/consul/commands/intention#source-and-destination-naming). as shown in the [source and destination naming conventions](/consul/commands/intention#source-and-destination-naming).
You can also [specify the namespace through other methods](#methods-to-specify-namespace). You can also [specify the namespace through other methods](#methods-to-specify-namespace).
@include 'http-api-query-parms-partition.mdx'
### JSON Request Body Schema ### JSON Request Body Schema
- `SourceName` `(string: <required>)` - The source of the intention. - `SourceName` `(string: <required>)` - The source of the intention.
@ -290,6 +294,8 @@ The corresponding CLI command is [`consul intention get`](/consul/commands/inten
as shown in the [source and destination naming conventions](/consul/commands/intention#source-and-destination-naming). as shown in the [source and destination naming conventions](/consul/commands/intention#source-and-destination-naming).
You can also [specify the namespace through other methods](#methods-to-specify-namespace). You can also [specify the namespace through other methods](#methods-to-specify-namespace).
@include 'http-api-query-parms-partition.mdx'
### Sample Request ### Sample Request
```shell-session ```shell-session
@ -404,6 +410,8 @@ The corresponding CLI command is [`consul intention list`](/consul/commands/inte
The `*` wildcard may be used to list intentions from all namespaces. The `*` wildcard may be used to list intentions from all namespaces.
You can also [specify the namespace through other methods](#methods-to-specify-namespace). You can also [specify the namespace through other methods](#methods-to-specify-namespace).
@include 'http-api-query-parms-partition.mdx'
### Sample Request ### Sample Request
```shell-session ```shell-session
@ -485,6 +493,8 @@ The corresponding CLI command is [`consul intention delete`](/consul/commands/in
as shown in the [source and destination naming conventions](/consul/commands/intention#source-and-destination-naming). as shown in the [source and destination naming conventions](/consul/commands/intention#source-and-destination-naming).
You can also [specify the namespace through other methods](#methods-to-specify-namespace). You can also [specify the namespace through other methods](#methods-to-specify-namespace).
@include 'http-api-query-parms-partition.mdx'
### Sample Request ### Sample Request
```shell-session ```shell-session
@ -628,6 +638,8 @@ The corresponding CLI command is [`consul intention match`](/consul/commands/int
as shown in the [source and destination naming conventions](/consul/commands/intention#source-and-destination-naming). as shown in the [source and destination naming conventions](/consul/commands/intention#source-and-destination-naming).
You can also [specify the namespace through other methods](#methods-to-specify-namespace). You can also [specify the namespace through other methods](#methods-to-specify-namespace).
@include 'http-api-query-parms-partition.mdx'
### Sample Request ### Sample Request
```shell-session ```shell-session

3
website/content/api-docs/exported-services.mdx
View File

@ -36,8 +36,7 @@ The table below shows this endpoint's support for
### Query Parameters ### Query Parameters
- `partition` `(string: "")` <EnterpriseAlert inline /> - Specifies the admin partition the services are exported from. When not specified, assumes the default value `default`. @include 'http-api-query-parms-partition.mdx'
### Sample Request ### Sample Request

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

@ -79,6 +79,8 @@ The corresponding CLI command is [`consul kv get`](/consul/commands/kv/get).
For recursive lookups, the namespace may be specified as '\*' For recursive lookups, the namespace may be specified as '\*'
to return results for all namespaces. to return results for all namespaces.
@include 'http-api-query-parms-partition.mdx'
### Sample Request ### Sample Request
```shell-session ```shell-session
@ -220,6 +222,8 @@ The corresponding CLI command is [`consul kv put`](/consul/commands/kv/put).
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to query. - `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to query.
You can also [specify the namespace through other methods](#methods-to-specify-namespace). You can also [specify the namespace through other methods](#methods-to-specify-namespace).
@include 'http-api-query-parms-partition.mdx'
### Sample Payload ### Sample Payload
The payload is arbitrary, and is loaded directly into Consul as supplied. The payload is arbitrary, and is loaded directly into Consul as supplied.
@ -289,6 +293,8 @@ The corresponding CLI command is [`consul kv delete`](/consul/commands/kv/delete
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to query. - `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to query.
You can also [specify the namespace through other methods](#methods-to-specify-namespace). You can also [specify the namespace through other methods](#methods-to-specify-namespace).
@include 'http-api-query-parms-partition.mdx'
### Sample Request ### Sample Request
```shell-session ```shell-session

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

@ -67,6 +67,8 @@ The corresponding CLI command is [`consul namespace create`](/consul/commands/na
- `Meta` `(map<string|string>: <optional>)` - Specifies arbitrary KV metadata - `Meta` `(map<string|string>: <optional>)` - Specifies arbitrary KV metadata
to associate with the namespace. to associate with the namespace.
@include 'http-api-body-options-partition.mdx'
### Sample Payload ### Sample Payload
```json ```json
@ -169,6 +171,10 @@ The corresponding CLI command is [`consul namespace read`](/consul/commands/name
- `name` `(string: <required>)` - Specifies the namespace to read. - `name` `(string: <required>)` - Specifies the namespace to read.
### Query Parameters
@include 'http-api-query-parms-partition.mdx'
### Sample Request ### Sample Request
```shell-session ```shell-session
@ -272,6 +278,8 @@ The corresponding CLI command is [`consul namespace update`](/consul/commands/na
- `Meta` `(map<string|string>: <optional>)` - Specifies arbitrary KV metadata - `Meta` `(map<string|string>: <optional>)` - Specifies arbitrary KV metadata
to associate with the namespace. to associate with the namespace.
@include 'http-api-body-options-partition.mdx'
### Sample Payload ### Sample Payload
```json ```json
@ -348,18 +356,15 @@ $ curl --request PUT \
## Delete a Namespace ## Delete a Namespace
This endpoint marks a Namespace for deletion. Once marked Consul will This endpoint marks a Namespace for deletion. Once marked, Consul deletes all the associated Namespaced data in the background. Only after all associated data has been deleted, Consul deletes the Namespace.
deleted all the associated Namespaced data in the background. Only once Until then, you can perform further reads on the namespace, and a `DeletedAt`
all associated data has been deleted will the Namespace actually disappear. field is populated with the timestamp of when the Namespace was marked for deletion.
Until then, further reads can be performed on the namespace and a `DeletedAt`
field will now be populated with the timestamp of when the Namespace was
marked for deletion.
| Method | Path | Produces | | Method | Path | Produces |
| -------- | ------------------ | -------- | | -------- | ------------------ | -------- |
| `DELETE` | `/namespace/:name` | N/A | | `DELETE` | `/namespace/:name` | N/A |
This endpoint will return no data. Success or failure is indicated by the status This endpoint returns no data. Success or failure is indicated by the status
code returned. code returned.
The table below shows this endpoint's support for The table below shows this endpoint's support for
@ -378,6 +383,10 @@ The corresponding CLI command is [`consul namespace delete`](/consul/commands/na
- `name` `(string: <required>)` - Specifies the namespace to delete. - `name` `(string: <required>)` - Specifies the namespace to delete.
### Query Parameters
@include 'http-api-query-parms-partition.mdx'
### Sample Request ### Sample Request
```shell-session ```shell-session
@ -449,6 +458,10 @@ the request has been granted any access in the namespace (read, list or write).
The corresponding CLI command is [`consul namespace list`](/consul/commands/namespace/list). The corresponding CLI command is [`consul namespace list`](/consul/commands/namespace/list).
### Query Parameters
@include 'http-api-query-parms-partition.mdx'
### Sample Request ### Sample Request
```shell-session ```shell-session

16
website/content/api-docs/peering.mdx
View File

@ -34,8 +34,7 @@ The table below shows this endpoint's support for
and configuration entries such as `service-intentions`. This field must be a and configuration entries such as `service-intentions`. This field must be a
valid DNS hostname label. valid DNS hostname label.
- `Partition` `(string: "")` - <EnterpriseAlert inline /> The admin partition that the @include 'http-api-body-options-partition.mdx'
peering token is generated from. Uses `default` when not specified.
- `ServerExternalAddresses` `([]string: <optional>)` - The addresses for the cluster that generates the peering token. Addresses take the form `{host or IP}:port`. - `ServerExternalAddresses` `([]string: <optional>)` - The addresses for the cluster that generates the peering token. Addresses take the form `{host or IP}:port`.
You can specify one or more load balancers or external IPs that route external traffic to this cluster's Consul servers. You can specify one or more load balancers or external IPs that route external traffic to this cluster's Consul servers.
@ -100,9 +99,7 @@ The table below shows this endpoint's support for
and configuration entries such as `service-intentions`. This field must be a and configuration entries such as `service-intentions`. This field must be a
valid DNS hostname label. valid DNS hostname label.
- `Partition` `(string: "")` - <EnterpriseAlert inline /> The admin partition @include 'http-api-body-options-partition.mdx'
that peers to the cluster that generated the peering token. Uses `default`
when not specified.
- `PeeringToken` `(string: <required>)` - The peering token fetched from the - `PeeringToken` `(string: <required>)` - The peering token fetched from the
peer cluster. peer cluster.
@ -162,8 +159,7 @@ The table below shows this endpoint's support for
### Query Parameters ### Query Parameters
- `partition` `(string: "")` <EnterpriseAlert inline /> - Specifies the partition of the peering @include 'http-api-query-parms-partition.mdx'
to read. If not specified will default to `default`.
### Sample Request ### Sample Request
@ -235,8 +231,7 @@ The table below shows this endpoint's support for
### Query Parameters ### Query Parameters
- `partition` `(string: "")` <EnterpriseAlert inline /> - Specifies the partition of the peerings @include 'http-api-query-parms-partition.mdx'
to delete. If not specified will default to `default`.
### Sample Request ### Sample Request
@ -286,8 +281,7 @@ The table below shows this endpoint's support for
### Query Parameters ### Query Parameters
- `partition` `(string: "")` <EnterpriseAlert inline /> - Specifies the partition of the peerings @include 'http-api-query-parms-partition.mdx'
to list. If not specified will default to `default`.
### Sample Request ### Sample Request

2
website/content/commands/acl/auth-method/create.mdx
View File

@ -67,7 +67,7 @@ Usage: `consul acl auth-method create [options] [args]`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/acl/auth-method/delete.mdx
View File

@ -31,7 +31,7 @@ Usage: `consul acl auth-method delete [options]`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/acl/auth-method/list.mdx
View File

@ -34,7 +34,7 @@ Usage: `consul acl auth-method list`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/acl/auth-method/read.mdx
View File

@ -36,7 +36,7 @@ Usage: `consul acl auth-method read [options] [args]`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/acl/auth-method/update.mdx
View File

@ -72,7 +72,7 @@ Usage: `consul acl auth-method update [options] [args]`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/acl/binding-rule/create.mdx
View File

@ -47,7 +47,7 @@ Usage: `consul acl binding-rule create [options] [args]`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/acl/binding-rule/delete.mdx
View File

@ -32,7 +32,7 @@ Usage: `consul acl binding-rule delete [options]`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/acl/binding-rule/list.mdx
View File

@ -34,7 +34,7 @@ Usage: `consul acl binding-rule list`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/acl/binding-rule/read.mdx
View File

@ -37,7 +37,7 @@ Usage: `consul acl binding-rule read [options] [args]`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/acl/binding-rule/update.mdx
View File

@ -54,7 +54,7 @@ Usage: `consul acl binding-rule update [options] [args]`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/acl/policy/create.mdx
View File

@ -49,7 +49,7 @@ Usage: `consul acl policy create [options] [args]`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/acl/policy/delete.mdx
View File

@ -34,7 +34,7 @@ Usage: `consul acl policy delete [options]`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/acl/policy/list.mdx
View File

@ -34,7 +34,7 @@ Usage: `consul acl policy list`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/acl/policy/read.mdx
View File

@ -39,7 +39,7 @@ Usage: `consul acl policy read [options] [args]`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/acl/policy/update.mdx
View File

@ -58,7 +58,7 @@ Usage: `consul acl policy update [options] [args]`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/acl/role/create.mdx
View File

@ -52,7 +52,7 @@ Usage: `consul acl role create [options] [args]`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/acl/role/delete.mdx
View File

@ -34,7 +34,7 @@ Usage: `consul acl role delete [options]`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/acl/role/list.mdx
View File

@ -34,7 +34,7 @@ Usage: `consul acl role list`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/acl/role/read.mdx
View File

@ -39,7 +39,7 @@ Usage: `consul acl role read [options] [args]`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/acl/role/update.mdx
View File

@ -63,7 +63,7 @@ Usage: `consul acl role update [options] [args]`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/acl/templated-policy/preview.mdx
View File

@ -36,7 +36,7 @@ Usage: `consul acl templated-policy preview [options] [args]`
### Enterprise options ### Enterprise options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/acl/token/clone.mdx
View File

@ -38,7 +38,7 @@ Usage: `consul acl token clone [options]`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/acl/token/create.mdx
View File

@ -66,7 +66,7 @@ Usage: `consul acl token create [options] [args]`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/acl/token/delete.mdx
View File

@ -32,7 +32,7 @@ Usage: `consul acl token delete [options]`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/acl/token/list.mdx
View File

@ -34,7 +34,7 @@ Usage: `consul acl token list`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/acl/token/read.mdx
View File

@ -43,7 +43,7 @@ Usage: `consul acl token read [options] [args]`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/acl/token/update.mdx
View File

@ -93,7 +93,7 @@ instead.
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/catalog/nodes.mdx
View File

@ -85,7 +85,7 @@ Usage: `consul catalog nodes [options]`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
#### API Options #### API Options

2
website/content/commands/catalog/services.mdx
View File

@ -69,7 +69,7 @@ Usage: `consul catalog services [options]`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/config/delete.mdx
View File

@ -61,7 +61,7 @@ config entry. This is used in combination with the -cas flag.
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
#### API Options #### API Options

2
website/content/commands/config/list.mdx
View File

@ -48,7 +48,7 @@ Usage: `consul config list [options]`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/config/read.mdx
View File

@ -52,7 +52,7 @@ Usage: `consul config read [options]`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/config/write.mdx
View File

@ -53,7 +53,7 @@ Usage: `consul config write [options] FILE`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/connect/envoy.mdx
View File

@ -199,7 +199,7 @@ compatibility with Envoy and prevent potential issues. Default is `false`.
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/connect/redirect-traffic.mdx
View File

@ -60,7 +60,7 @@ Usage: `consul connect redirect-traffic [options]`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/intention/check.mdx
View File

@ -41,7 +41,7 @@ Usage: `consul intention check [options] SRC DST`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/intention/create.mdx
View File

@ -52,7 +52,7 @@ are not supported from commands, but may be from the corresponding HTTP endpoint
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/intention/delete.mdx
View File

@ -37,7 +37,7 @@ Usage:
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/intention/get.mdx
View File

@ -37,7 +37,7 @@ Usage:
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/intention/match.mdx
View File

@ -40,7 +40,7 @@ Usage: `consul intention match [options] SRC_OR_DST`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/kv/delete.mdx
View File

@ -40,7 +40,7 @@ Usage: `consul kv delete [options] KEY_OR_PREFIX`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/kv/export.mdx
View File

@ -28,7 +28,7 @@ Usage: `consul kv export [options] [PREFIX]`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/kv/get.mdx
View File

@ -56,7 +56,7 @@ Usage: `consul kv get [options] [KEY_OR_PREFIX]`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/kv/import.mdx
View File

@ -31,7 +31,7 @@ Usage: `consul kv import [options] [DATA]`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/kv/put.mdx
View File

@ -59,7 +59,7 @@ Usage: `consul kv put [options] KEY [DATA]`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/members.mdx
View File

@ -56,7 +56,7 @@ Usage: `consul members [options]`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
#### API Options #### API Options

2
website/content/commands/namespace/create.mdx
View File

@ -61,7 +61,7 @@ from the CLI arguments.
#### API Options #### API Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_options_client.mdx' @include 'http_api_options_client.mdx'

2
website/content/commands/namespace/delete.mdx
View File

@ -30,7 +30,7 @@ Usage: `consul namespace delete <name>`
#### API Options #### API Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_options_client.mdx' @include 'http_api_options_client.mdx'

2
website/content/commands/namespace/list.mdx
View File

@ -42,7 +42,7 @@ Usage: `consul namespace list`
#### API Options #### API Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_options_client.mdx' @include 'http_api_options_client.mdx'

2
website/content/commands/namespace/read.mdx
View File

@ -41,7 +41,7 @@ Usage: `consul namespace read <name>`
#### API Options #### API Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_options_client.mdx' @include 'http_api_options_client.mdx'

2
website/content/commands/namespace/update.mdx
View File

@ -68,7 +68,7 @@ with the existing namespace definition.
#### API Options #### API Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_options_client.mdx' @include 'http_api_options_client.mdx'

2
website/content/commands/namespace/write.mdx
View File

@ -40,7 +40,7 @@ or HCL format. See [here](/consul/docs/enterprise/namespaces#namespace-definitio
#### API Options #### API Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_options_client.mdx' @include 'http_api_options_client.mdx'

2
website/content/commands/peering/delete.mdx
View File

@ -34,7 +34,7 @@ Usage: `consul peering delete [options] -name <peer name>`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
#### API Options #### API Options

2
website/content/commands/peering/establish.mdx
View File

@ -36,7 +36,7 @@ Usage: `consul peering establish [options] -name <peer name> -peering-token <tok
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
#### API Options #### API Options

2
website/content/commands/peering/exported-services.mdx
View File

@ -31,7 +31,7 @@ Usage: `consul peering exported-services [options] -name <peer name>`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
#### API Options #### API Options

2
website/content/commands/peering/generate-token.mdx
View File

@ -43,7 +43,7 @@ You can specify one or more load balancers or external IPs that route external t
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
#### API Options #### API Options

2
website/content/commands/peering/list.mdx
View File

@ -30,7 +30,7 @@ Usage: `consul peering list [options]`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
#### API Options #### API Options

2
website/content/commands/peering/read.mdx
View File

@ -31,7 +31,7 @@ Usage: `consul peering read [options] -name <peer name>`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
#### API Options #### API Options

2
website/content/commands/services/deregister.mdx
View File

@ -43,7 +43,7 @@ This flexibility makes it easy to pair the command with the
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/services/export.mdx
View File

@ -40,7 +40,7 @@ Usage: consul services export [options] -name <service name> -consumer-peers <ot
- `-consumer-partitions=<string>` - A comma-separated list of admin partitions within the - `-consumer-partitions=<string>` - A comma-separated list of admin partitions within the
same datacenter to export the service to. This flag is optional when `-consumer-peers` is specified. same datacenter to export the service to. This flag is optional when `-consumer-peers` is specified.
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

2
website/content/commands/services/exported-services.mdx
View File

@ -32,7 +32,7 @@ Usage: `consul services exported-services [options]`
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
#### API Options #### API Options

2
website/content/commands/services/register.mdx
View File

@ -78,7 +78,7 @@ The following fields specify identical parameters in a standard service definiti
#### Enterprise Options #### Enterprise Options
@include 'http_api_partition_options.mdx' @include 'cli-http-api-partition-options.mdx'
@include 'http_api_namespace_options.mdx' @include 'http_api_namespace_options.mdx'

1
website/content/partials/cli-http-api-partition-options.mdx Normal file
View File

@ -0,0 +1 @@
- `-partition=<string>` - <EnterpriseAlert inline /> Specifies the admin partition to query. If not provided, the partition is inferred from the request's ACL token, or defaults to the `default` partition.

2
website/content/partials/http-api-body-options-partition.mdx Normal file
View File

@ -0,0 +1,2 @@
- `Partition` `(string: "")` - <EnterpriseAlert inline /> The admin partition to use. If not provided, the partition is inferred from the request's ACL token, or defaults to the `default` partition.

1
website/content/partials/http-api-query-parms-partition.mdx Normal file
View File

@ -0,0 +1 @@
- `partition` `(string: "")` <EnterpriseAlert inline /> - The admin partition to use. If not provided, the partition is inferred from the request's ACL token, or defaults to the `default` partition.

1
website/content/partials/http_api_partition_options.mdx
View File

@ -1 +0,0 @@
- `-partition=<string>` - Specifies the partition to query. If not provided, the partition will be inferred from the request's ACL token, or will default to the `default` partition. Partitions are a Consul Enterprise feature added in v1.11.0.