From f1f9ed485b156e9829e531a7e9ea4538cdcc0f8a Mon Sep 17 00:00:00 2001 From: Jeff Mitchell Date: Wed, 10 Oct 2018 11:56:50 -0400 Subject: [PATCH] Update website docs to reflect fix in #5495 --- .../source/api/system/generate-root.html.md | 25 +++---------------- .../source/api/system/replication-dr.html.md | 25 +++---------------- 2 files changed, 8 insertions(+), 42 deletions(-) diff --git a/website/source/api/system/generate-root.html.md b/website/source/api/system/generate-root.html.md index 02f5727a86..eda3efcc4f 100644 --- a/website/source/api/system/generate-root.html.md +++ b/website/source/api/system/generate-root.html.md @@ -51,12 +51,7 @@ encode the final root token, it will never be returned. ## Start Root Token Generation This endpoint initializes a new root generation attempt. Only a single root -generation attempt can take place at a time. One (and only one) of `otp` or -`pgp_key` are required. - -Note: `otp` can be empty, in which case an OTP of suitable length will be -generated for you, which is recommended. Future versions of Vault will remove -the need to set this parameter at all. +generation attempt can take place at a time. | Method | Path | Produces | | :------- | :--------------------------- | :--------------------- | @@ -64,27 +59,15 @@ the need to set this parameter at all. ### Parameters -- `otp` `(string: )` – Set, but leave this value blank, to - have Vault generate a suitable OTP and return it. - -- `pgp_key` `(string: )` – Specifies a base64-encoded PGP - public key. The raw bytes of the token will be encrypted with this value - before being returned to the final unseal key provider. - -### Sample Payload - -```json -{ - "otp": "" -} -``` +- `pgp_key` `(string: )` – Specifies a base64-encoded PGP public key. + The raw bytes of the token will be encrypted with this value before being + returned to the final unseal key provider. ### Sample Request ``` $ curl \ --request PUT \ - --data @payload.json \ http://127.0.0.1:8200/v1/sys/generate-root/attempt ``` diff --git a/website/source/api/system/replication-dr.html.md b/website/source/api/system/replication-dr.html.md index 7b5af94d3c..4535f37062 100644 --- a/website/source/api/system/replication-dr.html.md +++ b/website/source/api/system/replication-dr.html.md @@ -454,12 +454,7 @@ encode the final token, it will never be returned. ## Start Token Generation This endpoint initializes a new generation attempt. Only a single -generation attempt can take place at a time. One (and only one) of `otp` or -`pgp_key` are required. - -Note: `otp` can be empty, in which case an OTP of suitable length will be -generated for you, which is recommended. Future versions of Vault will remove -the need to set this parameter at all. +generation attempt can take place at a time. | Method | Path | Produces | | :------- | :--------------------------- | :--------------------- | @@ -467,27 +462,15 @@ the need to set this parameter at all. ### Parameters -- `otp` `(string: )` – Set, but leave this value blank, to - have Vault generate a suitable OTP and return it. - -- `pgp_key` `(string: )` – Specifies a base64-encoded PGP - public key. The raw bytes of the token will be encrypted with this value - before being returned to the final unseal key provider. - -### Sample Payload - -```json -{ - "otp": "" -} -``` +- `pgp_key` `(string: )` – Specifies a base64-encoded PGP public key. + The raw bytes of the token will be encrypted with this value before being + returned to the final unseal key provider. ### Sample Request ``` $ curl \ --request PUT \ - --data @payload.json \ http://127.0.0.1:8200/v1/sys/replication/dr/secondary/generate-operation-token/attempt ```