From 8e40823fe1cf40cecb1e004be29fde5fdb875bdb Mon Sep 17 00:00:00 2001 From: Violet Hynes Date: Thu, 22 Jun 2023 13:39:47 -0400 Subject: [PATCH] Some small KV API docs improvements (#21395) --- website/content/api-docs/secret/cubbyhole.mdx | 2 +- website/content/api-docs/secret/kv/kv-v1.mdx | 16 +++++++++------- website/content/api-docs/secret/kv/kv-v2.mdx | 7 ++++--- 3 files changed, 14 insertions(+), 11 deletions(-) diff --git a/website/content/api-docs/secret/cubbyhole.mdx b/website/content/api-docs/secret/cubbyhole.mdx index 7361c95bb673..d41cef6bc842 100644 --- a/website/content/api-docs/secret/cubbyhole.mdx +++ b/website/content/api-docs/secret/cubbyhole.mdx @@ -105,7 +105,7 @@ This endpoint stores a secret at the specified location. - `path` `(string: )` – Specifies the path of the secrets to create/update. This is specified as part of the URL. -- `:key` `(string: "")` – Specifies a key, paired with an associated value, to +- `:key` `(string: "")` – Specifies a key in the payload, paired with an associated value, to be held at the given location. Multiple key/value pairs can be specified, and all will be returned on a read operation. diff --git a/website/content/api-docs/secret/kv/kv-v1.mdx b/website/content/api-docs/secret/kv/kv-v1.mdx index 8ef9e6a0dcaa..5eb970ae13c8 100644 --- a/website/content/api-docs/secret/kv/kv-v1.mdx +++ b/website/content/api-docs/secret/kv/kv-v1.mdx @@ -1,14 +1,16 @@ --- layout: api page_title: KV - Secrets Engines - HTTP API -description: This is the API documentation for the Vault KV secrets engine. +description: This is the API documentation for the Vault KV secrets engine, version 1. --- # KV Secrets Engine - Version 1 (API) This is the API documentation for the Vault KV secrets engine. For general -information about the usage and operation of the kv secrets engine, please -see the [Vault kv documentation](/vault/docs/secrets/kv). +information about the usage and operation of the version 1 KV secrets engine, please +see the [Vault KV documentation](/vault/docs/secrets/kv/kv-v1). For information +about the differences between KV version 1 and version 2, please [see the KV overview +documentation](/vault/docs/secrets/kv). ~> Note: This documentation assumes the kv secrets engine is enabled at the `/secret` path in Vault. Since it is possible to enable secrets engines at any @@ -53,7 +55,7 @@ $ curl \ _Note_: the `lease_duration` field, which will be populated if a "ttl" field was included in the data, is advisory. No lease is created. This is a way for writers to indicate how often a given value should be re-read by the client. -See the [Vault KV secrets engine documentation](/vault/docs/secrets/kv) +See the [Vault KV secrets engine documentation](/vault/docs/secrets/kv/kv-v1#ttls) for more details. ## List Secrets @@ -62,7 +64,7 @@ This endpoint returns a list of key names at the specified location. Folders are suffixed with `/`. The input must be a folder; list on a file will not return a value. Note that no policy-based filtering is performed on keys; do not encode sensitive information in key names. The values themselves are not accessible via -this command. +this API. | Method | Path | | :----- | :-------------- | @@ -116,11 +118,11 @@ policy granting the `update` capability. - `path` `(string: )` – Specifies the path of the secrets to create/update. This is specified as part of the URL. -- `:key` `(string: "")` – Specifies a key, paired with an associated value, to +- `:key` `(string: "")` – Specifies a key in the payload, paired with an associated value, to be held at the given location. Multiple key/value pairs can be specified, and all will be returned on a read operation. A key called `ttl` will trigger some special behavior. See the [Vault KV secrets engine - documentation](/vault/docs/secrets/kv) for details. + documentation](/vault/docs/secrets/kv/kv-v1#ttls) for details. ### Sample Payload diff --git a/website/content/api-docs/secret/kv/kv-v2.mdx b/website/content/api-docs/secret/kv/kv-v2.mdx index 9f0fdf0f82ae..50c4b84580e2 100644 --- a/website/content/api-docs/secret/kv/kv-v2.mdx +++ b/website/content/api-docs/secret/kv/kv-v2.mdx @@ -1,14 +1,15 @@ --- layout: api page_title: KV - Secrets Engines - HTTP API -description: This is the API documentation for the Vault KV secrets engine. +description: This is the API documentation for the Vault KV secrets engine, version 2. --- # KV Secrets Engine - Version 2 (API) This is the API documentation for the Vault KV secrets engine while running in -versioned mode. For general information about the usage and operation of the kv -secrets engine, please see the [Vault kv +versioned mode. For general information about the usage and operation of the version 2 +KV secrets engine, please see the [Vault KV documentation](/vault/docs/secrets/kv/kv-v2). +For information about the differences between KV version 1 and version 2, please [see the KV overview documentation](/vault/docs/secrets/kv). ## Configure the KV Engine