status-im/consul
2
0
Fork 0
mirror of https://github.com/status-im/consul.git synced 2025-02-23 19:08:22 +00:00
Code Issues Projects Releases Wiki Activity

docs: adjust HTTP API/CLI characteristics tables

Browse Source
This commit is contained in:
Jared Kirschner 2022-07-20 15:56:31 -07:00
parent 03924fdb30
commit 6add1039b3
3 changed files with 54 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
website/content/api-docs/admin-partitions.mdx
View File

@ -19,14 +19,14 @@ This endpoint creates a new partition and has the following characteristics:
| Characteristic | Value | | Characteristic | Value |
| -------------- | ----- | | -------------- | ----- |
| [HTTP Method] | `PUT` | | HTTP method | `PUT` |
| [URL Path] | `/partition` | | URL path | `/v1/partition` |
| [Response Type] | `application/json` | | Response type | `application/json` |
| [Required ACLs] | `operator:write` | | [Required ACLs] | `operator:write` |
| Corresponding CLI Command | [`consul partition create`](/commands/partition#create) | | Corresponding CLI command | [`consul partition create`](/commands/partition#create) |
| [Consistency Modes] | N/A | | [Consistency modes] | N/A |
| [Blocking Queries] | N/A | | [Blocking queries] | N/A |
| [Agent Caching] | N/A | | [Agent caching] | N/A |
### JSON Request Body Schema ### JSON Request Body Schema
@ -70,14 +70,14 @@ This endpoint reads a partition with the given name and has the following charac
| Characteristic | Value | | Characteristic | Value |
| -------------- | ----- | | -------------- | ----- |
| [HTTP Method] | `GET` | | HTTP method | `GET` |
| [URL Path] | `/partition/:name` | | URL path | `/v1/partition/:name` |
| [Response Type] | `application/json` | | Response type | `application/json` |
| [Required ACLs] | `operator:read`; however, a non-anonymous token can always read its own partition | | [Required ACLs] | `operator:read`; however, a non-anonymous token can always read its own partition |
| Corresponding CLI Command | [`consul partition read`](/commands/partition#read) | | Corresponding CLI command | [`consul partition read`](/commands/partition#read) |
| [Consistency Modes] | `default`, `consistent` | | [Consistency modes] | `default`, `consistent` |
| [Blocking Queries] | no | | [Blocking queries] | No |
| [Agent Caching] | no | | [Agent caching] | No |
### Path Parameters ### Path Parameters
@ -107,14 +107,14 @@ This endpoint updates a partition description and has the following characterist
| Characteristic | Value | | Characteristic | Value |
| -------------- | ----- | | -------------- | ----- |
| [HTTP Method] | `PUT` | | HTTP method | `PUT` |
| [URL Path] | `/partition/:name` | | URL path | `/v1/partition/:name` |
| [Response Type] | `application/json` | | Response type | `application/json` |
| [Required ACLs] | `operator:write` | | [Required ACLs] | `operator:write` |
| Corresponding CLI Command | [`consul partition write`](/commands/partition#write) | | Corresponding CLI command | [`consul partition write`](/commands/partition#write) |
| [Consistency Modes] | N/A | | [Consistency modes] | N/A |
| [Blocking Queries] | N/A | | [Blocking queries] | N/A |
| [Agent Caching] | N/A | | [Agent caching] | N/A |
### Path Parameters ### Path Parameters
@ -169,14 +169,14 @@ This endpoint has the following characteristics:
| Characteristic | Value | | Characteristic | Value |
| -------------- | ----- | | -------------- | ----- |
| [HTTP Method] | `DELETE` | | HTTP method | `DELETE` |
| [URL Path] | `/partition/:name` | | URL path | `/v1/partition/:name` |
| [Response Type] | none; success or failure is indicated by the HTTP response status code | | Response type | none; success or failure is indicated by the HTTP response status code |
| [Required ACLs] | `operator:write` | | [Required ACLs] | `operator:write` |
| Corresponding CLI Command | [`consul partition delete`](/commands/partition#delete) | | Corresponding CLI command | [`consul partition delete`](/commands/partition#delete) |
| [Consistency Modes] | N/A | | [Consistency modes] | N/A |
| [Blocking Queries] | N/A | | [Blocking queries] | N/A |
| [Agent Caching] | N/A | | [Agent caching] | N/A |
### Path Parameters ### Path Parameters
@ -208,14 +208,14 @@ This endpoint lists all the partitions and has the following characteristics:
| Characteristic | Value | | Characteristic | Value |
| -------------- | ----- | | -------------- | ----- |
| [HTTP Method] | `GET` | | HTTP method | `GET` |
| [URL Path] | `/partitions` | | URL path | `/v1/partitions` |
| [Response Type] | `application/json` | | Response type | `application/json` |
| [Required ACLs] | `operator:read` | | [Required ACLs] | `operator:read` |
| Corresponding CLI Command | [`consul partition list`](/commands/partition#list) | | Corresponding CLI command | [`consul partition list`](/commands/partition#list) |
| [Consistency Modes] | `default`, `consistent` | | [Consistency modes] | `default`, `consistent` |
| [Blocking Queries] | no | | [Blocking queries] | No |
| [Agent Caching] | no | | [Agent caching] | No |
### Sample Request ### Sample Request

30
website/content/commands/partition.mdx
View File

@ -73,9 +73,9 @@ This subcommand has the following characteristics:
| Characteristic | Value | | Characteristic | Value |
| -------------- | ----- | | -------------- | ----- |
| [Required ACLs] | `operator:write` | | [Required ACLs] | `operator:write` |
| Corresponding HTTP API Endpoint | [\[PUT\] /partition](/api-docs/admin-partitions#create-a-partition) | | 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 | | [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 | | [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: 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 | | Characteristic | Value |
| -------------- | ----- | | -------------- | ----- |
| [Required ACLs] | `operator:write` | | [Required ACLs] | `operator:write` |
| Corresponding HTTP API Endpoint | [\[PUT\] /partition/:name](/api-docs/admin-partitions#update-a-partition) | | 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 | | [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 | | [Agent caching] | Not supported from commands, but may be from the corresponding HTTP API endpoint |
Use the following syntax to write from file: Use the following syntax to write from file:
@ -153,9 +153,9 @@ This subcommand has the following characteristics:
| Characteristic | Value | | Characteristic | Value |
| -------------- | ----- | | -------------- | ----- |
| [Required ACLs] | `operator:read`; however, a non-anonymous token can always read its own partition | | [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) | | 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 | | [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 | | [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: 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 | | Characteristic | Value |
| -------------- | ----- | | -------------- | ----- |
| [Required ACLs] | `operator:read` | | [Required ACLs] | `operator:read` |
| Corresponding HTTP API Endpoint | [\[GET\] /partitions](/api-docs/admin-partitions#list-all-partitions) | | 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 | | [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 | | [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: 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 | | Characteristic | Value |
| -------------- | ----- | | -------------- | ----- |
| [Required ACLs] | `operator:write` | | [Required ACLs] | `operator:write` |
| Corresponding HTTP API Endpoint | [\[DELETE\] /partitions](/api-docs/admin-partitions#delete-a-partition) | | 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 | | [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 | | [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: In the following example, the `webdev-bu` partition is deleted:

11
website/content/partials/http_api_and_cli_characteristics_links.mdx
View File

@ -1,9 +1,6 @@
<!-- list of reference-style links (must have have an empty line beneath) --> <!-- list of reference-style links (must have have an empty line beneath) -->
[HTTP Method]: /api-docs#http-methods [Required ACLs]: /docs/security/acl
[URL Path]: /api-docs#version-prefix [Blocking queries]: /api-docs/features/blocking
[Response Type]: /api-docs#formatted-json-output [Consistency modes]: /api-docs/features/consistency
[Required ACLs]: /docs/security/acl/acl-system [Agent caching]: /api-docs/features/caching
[Blocking Queries]: /api-docs/features/blocking
[Consistency Modes]: /api-docs/features/consistency
[Agent Caching]: /api-docs/features/caching