diff --git a/website/content/api-docs/admin-partitions.mdx b/website/content/api-docs/admin-partitions.mdx index 6d8124debc..7078cbfbf0 100644 --- a/website/content/api-docs/admin-partitions.mdx +++ b/website/content/api-docs/admin-partitions.mdx @@ -19,14 +19,14 @@ This endpoint creates a new partition and has the following characteristics: | Characteristic | Value | | -------------- | ----- | -| [HTTP Method] | `PUT` | -| [URL Path] | `/partition` | -| [Response Type] | `application/json` | +| HTTP method | `PUT` | +| URL path | `/v1/partition` | +| Response type | `application/json` | | [Required ACLs] | `operator:write` | -| Corresponding CLI Command | [`consul partition create`](/commands/partition#create) | -| [Consistency Modes] | N/A | -| [Blocking Queries] | N/A | -| [Agent Caching] | N/A | +| Corresponding CLI command | [`consul partition create`](/commands/partition#create) | +| [Consistency modes] | N/A | +| [Blocking queries] | N/A | +| [Agent caching] | N/A | ### JSON Request Body Schema @@ -70,14 +70,14 @@ This endpoint reads a partition with the given name and has the following charac | Characteristic | Value | | -------------- | ----- | -| [HTTP Method] | `GET` | -| [URL Path] | `/partition/:name` | -| [Response Type] | `application/json` | +| HTTP method | `GET` | +| URL path | `/v1/partition/:name` | +| Response type | `application/json` | | [Required ACLs] | `operator:read`; however, a non-anonymous token can always read its own partition | -| Corresponding CLI Command | [`consul partition read`](/commands/partition#read) | -| [Consistency Modes] | `default`, `consistent` | -| [Blocking Queries] | no | -| [Agent Caching] | no | +| Corresponding CLI command | [`consul partition read`](/commands/partition#read) | +| [Consistency modes] | `default`, `consistent` | +| [Blocking queries] | No | +| [Agent caching] | No | ### Path Parameters @@ -107,14 +107,14 @@ This endpoint updates a partition description and has the following characterist | Characteristic | Value | | -------------- | ----- | -| [HTTP Method] | `PUT` | -| [URL Path] | `/partition/:name` | -| [Response Type] | `application/json` | +| HTTP method | `PUT` | +| URL path | `/v1/partition/:name` | +| Response type | `application/json` | | [Required ACLs] | `operator:write` | -| Corresponding CLI Command | [`consul partition write`](/commands/partition#write) | -| [Consistency Modes] | N/A | -| [Blocking Queries] | N/A | -| [Agent Caching] | N/A | +| Corresponding CLI command | [`consul partition write`](/commands/partition#write) | +| [Consistency modes] | N/A | +| [Blocking queries] | N/A | +| [Agent caching] | N/A | ### Path Parameters @@ -169,14 +169,14 @@ This endpoint has the following characteristics: | Characteristic | Value | | -------------- | ----- | -| [HTTP Method] | `DELETE` | -| [URL Path] | `/partition/:name` | -| [Response Type] | none; success or failure is indicated by the HTTP response status code | +| HTTP method | `DELETE` | +| URL path | `/v1/partition/:name` | +| Response type | none; success or failure is indicated by the HTTP response status code | | [Required ACLs] | `operator:write` | -| Corresponding CLI Command | [`consul partition delete`](/commands/partition#delete) | -| [Consistency Modes] | N/A | -| [Blocking Queries] | N/A | -| [Agent Caching] | N/A | +| Corresponding CLI command | [`consul partition delete`](/commands/partition#delete) | +| [Consistency modes] | N/A | +| [Blocking queries] | N/A | +| [Agent caching] | N/A | ### Path Parameters @@ -208,14 +208,14 @@ This endpoint lists all the partitions and has the following characteristics: | Characteristic | Value | | -------------- | ----- | -| [HTTP Method] | `GET` | -| [URL Path] | `/partitions` | -| [Response Type] | `application/json` | +| HTTP method | `GET` | +| URL path | `/v1/partitions` | +| Response type | `application/json` | | [Required ACLs] | `operator:read` | -| Corresponding CLI Command | [`consul partition list`](/commands/partition#list) | -| [Consistency Modes] | `default`, `consistent` | -| [Blocking Queries] | no | -| [Agent Caching] | no | +| Corresponding CLI command | [`consul partition list`](/commands/partition#list) | +| [Consistency modes] | `default`, `consistent` | +| [Blocking queries] | No | +| [Agent caching] | No | ### Sample Request diff --git a/website/content/commands/partition.mdx b/website/content/commands/partition.mdx index c04e33295c..df9f4067f5 100644 --- a/website/content/commands/partition.mdx +++ b/website/content/commands/partition.mdx @@ -73,9 +73,9 @@ This subcommand has the following characteristics: | Characteristic | Value | | -------------- | ----- | | [Required ACLs] | `operator:write` | -| Corresponding HTTP API Endpoint | [\[PUT\] /partition](/api-docs/admin-partitions#create-a-partition) | -| [Blocking Queries] | Not supported from commands, but may be from the corresponding HTTP API endpoint | -| [Agent Caching] | Not supported from commands, but may be from the corresponding HTTP API endpoint | +| Corresponding HTTP API endpoint | [\[PUT\] /v1/partition](/api-docs/admin-partitions#create-a-partition) | +| [Blocking queries] | Not supported from commands, but may be from the corresponding HTTP API endpoint | +| [Agent caching] | Not supported from commands, but may be from the corresponding HTTP API endpoint | The admin partition is created according to the values specified in the options. You can specify the following options: @@ -107,9 +107,9 @@ This subcommand has the following characteristics: | Characteristic | Value | | -------------- | ----- | | [Required ACLs] | `operator:write` | -| Corresponding HTTP API Endpoint | [\[PUT\] /partition/:name](/api-docs/admin-partitions#update-a-partition) | -| [Blocking Queries] | Not supported from commands, but may be from the corresponding HTTP API endpoint | -| [Agent Caching] | Not supported from commands, but may be from the corresponding HTTP API endpoint | +| Corresponding HTTP API endpoint | [\[PUT\] /v1/partition/:name](/api-docs/admin-partitions#update-a-partition) | +| [Blocking queries] | Not supported from commands, but may be from the corresponding HTTP API endpoint | +| [Agent caching] | Not supported from commands, but may be from the corresponding HTTP API endpoint | Use the following syntax to write from file: @@ -153,9 +153,9 @@ This subcommand has the following characteristics: | Characteristic | Value | | -------------- | ----- | | [Required ACLs] | `operator:read`; however, a non-anonymous token can always read its own partition | -| Corresponding HTTP API Endpoint | [\[GET\] /partition/:name](/api-docs/admin-partitions#read-a-partition) | -| [Blocking Queries] | Not supported from commands, but may be from the corresponding HTTP API endpoint | -| [Agent Caching] | Not supported from commands, but may be from the corresponding HTTP API endpoint | +| Corresponding HTTP API endpoint | [\[GET\] /v1/partition/:name](/api-docs/admin-partitions#read-a-partition) | +| [Blocking queries] | Not supported from commands, but may be from the corresponding HTTP API endpoint | +| [Agent caching] | Not supported from commands, but may be from the corresponding HTTP API endpoint | The admin partition is created according to the values specified in the options. You can specify the following options: @@ -184,9 +184,9 @@ This subcommand has the following characteristics: | Characteristic | Value | | -------------- | ----- | | [Required ACLs] | `operator:read` | -| Corresponding HTTP API Endpoint | [\[GET\] /partitions](/api-docs/admin-partitions#list-all-partitions) | -| [Blocking Queries] | Not supported from commands, but may be from the corresponding HTTP API endpoint | -| [Agent Caching] | Not supported from commands, but may be from the corresponding HTTP API endpoint | +| Corresponding HTTP API endpoint | [\[GET\] /v1/partitions](/api-docs/admin-partitions#list-all-partitions) | +| [Blocking queries] | Not supported from commands, but may be from the corresponding HTTP API endpoint | +| [Agent caching] | Not supported from commands, but may be from the corresponding HTTP API endpoint | The admin partition is created according to the values specified in the options. You can specify the following options: @@ -229,9 +229,9 @@ This subcommand has the following characteristics: | Characteristic | Value | | -------------- | ----- | | [Required ACLs] | `operator:write` | -| Corresponding HTTP API Endpoint | [\[DELETE\] /partitions](/api-docs/admin-partitions#delete-a-partition) | -| [Blocking Queries] | Not supported from commands, but may be from the corresponding HTTP API endpoint | -| [Agent Caching] | Not supported from commands, but may be from the corresponding HTTP API endpoint | +| Corresponding HTTP API endpoint | [\[DELETE\] /v1/partitions](/api-docs/admin-partitions#delete-a-partition) | +| [Blocking queries] | Not supported from commands, but may be from the corresponding HTTP API endpoint | +| [Agent caching] | Not supported from commands, but may be from the corresponding HTTP API endpoint | In the following example, the `webdev-bu` partition is deleted: diff --git a/website/content/partials/http_api_and_cli_characteristics_links.mdx b/website/content/partials/http_api_and_cli_characteristics_links.mdx index 4669c1ec1f..0cbb237023 100644 --- a/website/content/partials/http_api_and_cli_characteristics_links.mdx +++ b/website/content/partials/http_api_and_cli_characteristics_links.mdx @@ -1,9 +1,6 @@ -[HTTP Method]: /api-docs#http-methods -[URL Path]: /api-docs#version-prefix -[Response Type]: /api-docs#formatted-json-output -[Required ACLs]: /docs/security/acl/acl-system -[Blocking Queries]: /api-docs/features/blocking -[Consistency Modes]: /api-docs/features/consistency -[Agent Caching]: /api-docs/features/caching +[Required ACLs]: /docs/security/acl +[Blocking queries]: /api-docs/features/blocking +[Consistency modes]: /api-docs/features/consistency +[Agent caching]: /api-docs/features/caching