From 55a77c187b5b020b9ebdfb15c0974cd8d4ae29fc Mon Sep 17 00:00:00 2001 From: Jared Kirschner Date: Wed, 23 Mar 2022 13:26:32 -0700 Subject: [PATCH 1/6] docs: add partial for api/cli characteristics links --- .../partials/http_api_and_cli_characteristics_links.mdx | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 website/content/partials/http_api_and_cli_characteristics_links.mdx diff --git a/website/content/partials/http_api_and_cli_characteristics_links.mdx b/website/content/partials/http_api_and_cli_characteristics_links.mdx new file mode 100644 index 0000000000..4669c1ec1f --- /dev/null +++ b/website/content/partials/http_api_and_cli_characteristics_links.mdx @@ -0,0 +1,9 @@ + + +[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 From bfe79b7b34a514304532a9eb98a953ae889436a1 Mon Sep 17 00:00:00 2001 From: Jared Kirschner Date: Wed, 12 Jan 2022 08:47:13 -0800 Subject: [PATCH 2/6] docs: add partition command characteristics Characteristics include: - Required ACL permissions - Corresponding HTTP API endpoint - (Lack of) support for blocking queries and agent caching --- website/content/commands/partition.mdx | 59 +++++++++++++++++++++++++- 1 file changed, 57 insertions(+), 2 deletions(-) diff --git a/website/content/commands/partition.mdx b/website/content/commands/partition.mdx index ef9142097f..c6e1ed0196 100644 --- a/website/content/commands/partition.mdx +++ b/website/content/commands/partition.mdx @@ -5,6 +5,8 @@ description: | The partition command enables you create and manage Consul Enterprise admin partitions. --- +@include 'http_api_and_cli_characteristics_links.mdx' + # Consul Admin Partition Command: `consul partition` @@ -66,6 +68,16 @@ You can issue the following subcommands with the `consul partition` command. ### `create` The `create` subcommand sends a request to the server to create a new admin partition. +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 | + +#### Usage ```shell-session consul partition create @@ -95,7 +107,20 @@ $ consul partition create -name "webdev" -description "Partition for admin of we ### `write` -The `write` subcommand sends a request to the server to create a new admin partition or update an existing partition from its full definition. You can specify an admin partition definition file or use values from `stdin`. +The `write` subcommand sends a request to the server to create a new admin partition or update an existing partition from its full definition. +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 | + +#### Usage + +You can specify an admin partition definition file or use values from `stdin` +in either JSON or HCL format. Use the following syntax to write from file: @@ -109,7 +134,7 @@ Use the following syntax to write from `stdin`: consul partition write - ``` -The definition file or `stdin` values can be provided in JSON or HCL format. Refer to the [Admin Partition Definition](#partition-definition) section for details about the supported parameters. +Refer to the [Admin Partition Definition](#partition-definition) section for details about the supported parameters. You can specify the following options: @@ -134,6 +159,16 @@ $ consul partition write -format json -show-meta - <<< 'name = "webdev-bu" descr ### `read` The `read` subcommand sends a request to the server to read the configuration for the specified partition and print it to the console. +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 | + +#### Usage ```shell-session consul partition read @@ -161,6 +196,16 @@ consul partition read -format json -meta webdev ### `list` The `list` subcommand prints existing admin partitions to the console. +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 | + +#### Usage ```shell-session consul partition list @@ -202,6 +247,16 @@ $ consul partition list -format json -show-meta ### `delete` The `delete` subcommand sends a request to the server to remove the specified partition. +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 | + +#### Usage ```shell-session $ consul partition delete From 903c71618a0c7a2ea112d6664cdc1da9b73935a1 Mon Sep 17 00:00:00 2001 From: Jared Kirschner Date: Wed, 6 Apr 2022 15:18:54 -0700 Subject: [PATCH 3/6] docs: remove partition subcommand usage headings --- website/content/commands/partition.mdx | 33 ++------------------------ 1 file changed, 2 insertions(+), 31 deletions(-) diff --git a/website/content/commands/partition.mdx b/website/content/commands/partition.mdx index c6e1ed0196..c04e33295c 100644 --- a/website/content/commands/partition.mdx +++ b/website/content/commands/partition.mdx @@ -77,12 +77,6 @@ This subcommand has the following characteristics: | [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 | -#### Usage - -```shell-session -consul partition create -``` - The admin partition is created according to the values specified in the options. You can specify the following options: | Option | Description | Default | Required | @@ -107,7 +101,7 @@ $ consul partition create -name "webdev" -description "Partition for admin of we ### `write` -The `write` subcommand sends a request to the server to create a new admin partition or update an existing partition from its full definition. +The `write` subcommand sends a request to the server to create a new admin partition or update an existing partition from its full definition. You can specify an admin partition definition file or use values from `stdin`. This subcommand has the following characteristics: | Characteristic | Value | @@ -117,11 +111,6 @@ This subcommand has the following characteristics: | [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 | -#### Usage - -You can specify an admin partition definition file or use values from `stdin` -in either JSON or HCL format. - Use the following syntax to write from file: ```shell-session @@ -134,7 +123,7 @@ Use the following syntax to write from `stdin`: consul partition write - ``` -Refer to the [Admin Partition Definition](#partition-definition) section for details about the supported parameters. +The definition file or `stdin` values can be provided in JSON or HCL format. Refer to the [Admin Partition Definition](#admin-partition-definition) section for details about the supported parameters. You can specify the following options: @@ -168,12 +157,6 @@ This subcommand has the following characteristics: | [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 | -#### Usage - -```shell-session -consul partition read -``` - The admin partition is created according to the values specified in the options. You can specify the following options: | Option | Description | Default | Required | @@ -205,12 +188,6 @@ This subcommand has the following characteristics: | [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 | -#### Usage - -```shell-session -consul partition list -``` - The admin partition is created according to the values specified in the options. You can specify the following options: | Option | Description | Default | Required | @@ -256,12 +233,6 @@ This subcommand has the following characteristics: | [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 | -#### Usage - -```shell-session -$ consul partition delete -``` - In the following example, the `webdev-bu` partition is deleted: ```shell-session From 03924fdb3054257c1494f517098d7cdbefc1c57b Mon Sep 17 00:00:00 2001 From: Jared Kirschner Date: Thu, 24 Feb 2022 20:31:25 -0800 Subject: [PATCH 4/6] docs: restructure partition API characteristics The existing characteristics were restructured into a list. The corresponding CLI command characteristic was added. --- website/content/api-docs/admin-partitions.mdx | 148 ++++++++---------- 1 file changed, 61 insertions(+), 87 deletions(-) diff --git a/website/content/api-docs/admin-partitions.mdx b/website/content/api-docs/admin-partitions.mdx index 4d87bde4d7..6d8124debc 100644 --- a/website/content/api-docs/admin-partitions.mdx +++ b/website/content/api-docs/admin-partitions.mdx @@ -4,6 +4,8 @@ page_title: Admin Partition - HTTP API description: The /partition endpoints allow for managing Consul Enterprise Admin Partitions. --- +@include 'http_api_and_cli_characteristics_links.mdx' + # Admin Partition - HTTP API @@ -13,23 +15,18 @@ The functionality described here is available only in ## Create a Partition -This endpoint creates a new Partition. +This endpoint creates a new partition and has the following characteristics: -| Method | Path | Produces | -| ------ | ------------ | ------------------ | -| `PUT` | `/partition` | `application/json` | - -The table below shows this endpoint's support for -[blocking queries](/api-docs/features/blocking), -[consistency modes](/api-docs/features/consistency), -[agent caching](/api-docs/features/caching), and -[required ACLs](/api#authentication). - -| Blocking Queries | Consistency Modes | Agent Caching | ACL Required | -| ---------------- | ----------------- | ------------- | ---------------- | -| `NO` | `none` | `none` | `operator:write` | - -The corresponding CLI command is [`consul partition create`](/commands/partition#create). +| Characteristic | Value | +| -------------- | ----- | +| [HTTP Method] | `PUT` | +| [URL Path] | `/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 | ### JSON Request Body Schema @@ -69,25 +66,18 @@ $ curl ---request PUT \ ## Read a Partition -This endpoint reads a Partition with the given name. +This endpoint reads a partition with the given name and has the following characteristics: -| Method | Path | Produces | -| ------ | ------------------ | ------------------ | -| `GET` | `/partition/:name` | `application/json` | - -The table below shows this endpoint's support for -[blocking queries](/api-docs/features/blocking), -[consistency modes](/api-docs/features/consistency), -[agent caching](/api-docs/features/caching), and -[required ACLs](/api#authentication). - -| Blocking Queries | Consistency Modes | Agent Caching | ACL Required | -| ---------------- | ----------------- | ------------- | ------------------------------------- | -| `NO` | `consistent` | `none` | `operator:read` or `none`1 | - -1 A non-anonymous token can read its own partition. - -The corresponding CLI command is [`consul partition read`](/commands/partition#read). +| Characteristic | Value | +| -------------- | ----- | +| [HTTP Method] | `GET` | +| [URL Path] | `/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 | ### Path Parameters @@ -100,7 +90,7 @@ $ curl --header "X-Consul-Token: b23b3cad-5ea1-4413-919e-c76884b9ad60" \ http://127.0.0.1:8500/v1/partition/na-west ``` -### SampleResponse +### Sample Response ```json { @@ -113,23 +103,18 @@ $ curl --header "X-Consul-Token: b23b3cad-5ea1-4413-919e-c76884b9ad60" \ ## Update a Partition -This endpoint updates a Partition description. +This endpoint updates a partition description and has the following characteristics: -| Method | Path | Produces | -| ------ | ------------------ | ------------------ | -| `PUT` | `/partition/:name` | `application/json` | - -The table below shows this endpoint's support for -[blocking queries](/api-docs/features/blocking), -[consistency modes](/api-docs/features/consistency), -[agent caching](/api-docs/features/caching), and -[required ACLs](/api#authentication). - -| Blocking Queries | Consistency Modes | Agent Caching | ACL Required | -| ---------------- | ----------------- | ------------- | ---------------- | -| `NO` | `none` | `none` | `operator:write` | - -The corresponding CLI command is [`consul partition write`](/commands/partition#write). +| Characteristic | Value | +| -------------- | ----- | +| [HTTP Method] | `PUT` | +| [URL Path] | `/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 | ### Path Parameters @@ -173,31 +158,25 @@ $ curl --request PUT \ ## Delete a Partition -This endpoint marks a Partition for deletion. Once marked Consul will +This endpoint marks a partition for deletion. Once marked Consul will deleted all the associated partitioned data in the background. Only once -all associated data has been deleted will the Partition actually disappear. +all associated data has been deleted will the partition actually disappear. Until then, further reads can be performed on the partition and a `DeletedAt` -field will now be populated with the timestamp of when the Partition was +field will now be populated with the timestamp of when the partition was marked for deletion. -| Method | Path | Produces | -| -------- | ------------------ | -------- | -| `DELETE` | `/partition/:name` | N/A | +This endpoint has the following characteristics: -This endpoint will return no data. Success or failure is indicated by the status -code returned. - -The table below shows this endpoint's support for -[blocking queries](/api-docs/features/blocking), -[consistency modes](/api-docs/features/consistency), -[agent caching](/api-docs/features/caching), and -[required ACLs](/api#authentication). - -| Blocking Queries | Consistency Modes | Agent Caching | ACL Required | -| ---------------- | ----------------- | ------------- | ---------------- | -| `NO` | `none` | `none` | `operator:write` | - -The corresponding CLI command is [`consul partition delete`](/commands/partition#delete). +| Characteristic | Value | +| -------------- | ----- | +| [HTTP Method] | `DELETE` | +| [URL Path] | `/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 | ### Path Parameters @@ -225,23 +204,18 @@ $ curl --request DELETE \ ## List all Partitions -This endpoint lists all the Partitions. +This endpoint lists all the partitions and has the following characteristics: -| Method | Path | Produces | -| ------ | ------------- | ------------------ | -| `GET` | `/partitions` | `application/json` | - -The table below shows this endpoint's support for -[blocking queries](/api-docs/features/blocking), -[consistency modes](/api-docs/features/consistency), -[agent caching](/api-docs/features/caching), and -[required ACLs](/api#authentication). - -| Blocking Queries | Consistency Modes | Agent Caching | ACL Required | -| ---------------- | ----------------- | ------------- | --------------- | -| `NO` | `consistent` | `none` | `operator:read` | - -The corresponding CLI command is [`consul partition list`](/commands/partition#list). +| Characteristic | Value | +| -------------- | ----- | +| [HTTP Method] | `GET` | +| [URL Path] | `/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 | ### Sample Request From 6add1039b3930a14155b551e1489145b1223844c Mon Sep 17 00:00:00 2001 From: Jared Kirschner Date: Wed, 20 Jul 2022 15:56:31 -0700 Subject: [PATCH 5/6] docs: adjust HTTP API/CLI characteristics tables --- website/content/api-docs/admin-partitions.mdx | 70 +++++++++---------- website/content/commands/partition.mdx | 30 ++++---- ...http_api_and_cli_characteristics_links.mdx | 11 ++- 3 files changed, 54 insertions(+), 57 deletions(-) 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 From 51f0a64b6bd07d0b9ac4a94e58becf3dd1d3d1c4 Mon Sep 17 00:00:00 2001 From: Jared Kirschner Date: Mon, 25 Jul 2022 15:31:07 -0700 Subject: [PATCH 6/6] docs: remove unnecessary partition CLI cmd info --- website/content/commands/partition.mdx | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/website/content/commands/partition.mdx b/website/content/commands/partition.mdx index df9f4067f5..5b9fed9a39 100644 --- a/website/content/commands/partition.mdx +++ b/website/content/commands/partition.mdx @@ -74,8 +74,6 @@ This subcommand has the following characteristics: | -------------- | ----- | | [Required ACLs] | `operator:write` | | 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: @@ -108,8 +106,6 @@ This subcommand has the following characteristics: | -------------- | ----- | | [Required ACLs] | `operator:write` | | 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: @@ -154,8 +150,6 @@ This subcommand has the following characteristics: | -------------- | ----- | | [Required ACLs] | `operator:read`; however, a non-anonymous token can always read its own partition | | 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: @@ -185,8 +179,6 @@ This subcommand has the following characteristics: | -------------- | ----- | | [Required ACLs] | `operator:read` | | 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: @@ -230,8 +222,6 @@ This subcommand has the following characteristics: | -------------- | ----- | | [Required ACLs] | `operator:write` | | 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: