Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add initial ACME API documentation #20752

Merged
merged 5 commits into from
May 30, 2023
Merged

Conversation

cipherboy
Copy link
Contributor

@cipherboy cipherboy commented May 24, 2023

Adds documentation about the new ACME APIs in the PKI engine!

For ticket: VAULT-13857.

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
The required header `Cache-Control: no-store` is automatically set by
Vault in wrapGenericHandler(...).

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
Copy link
Contributor

@stevendpclark stevendpclark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great stuff 👍 I've added a bunch of nits, nothing serious.

website/content/api-docs/secret/pki.mdx Outdated Show resolved Hide resolved
website/content/api-docs/secret/pki.mdx Outdated Show resolved Hide resolved
website/content/api-docs/secret/pki.mdx Outdated Show resolved Hide resolved
website/content/api-docs/secret/pki.mdx Outdated Show resolved Hide resolved
website/content/api-docs/secret/pki.mdx Outdated Show resolved Hide resolved
website/content/api-docs/secret/pki.mdx Outdated Show resolved Hide resolved
website/content/api-docs/secret/pki.mdx Outdated Show resolved Hide resolved
website/content/api-docs/secret/pki.mdx Outdated Show resolved Hide resolved
specified,

- `new-account-required`, where new accounts are required to have EAB
but existing accounts can still be used, and
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sentence wasn't completed?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nah, it was just a continued list. item one, / item-two, and / item-three. :-)

website/content/api-docs/secret/pki.mdx Outdated Show resolved Hide resolved
cipherboy and others added 2 commits May 26, 2023 09:32
Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
@cipherboy cipherboy enabled auto-merge (squash) May 26, 2023 13:56
@cipherboy cipherboy disabled auto-merge May 26, 2023 13:57
Copy link
Contributor

@kitography kitography left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I only have tiny nits, this looks really great.

website/content/api-docs/secret/pki.mdx Outdated Show resolved Hide resolved

### List Unused ACME EAB Binding Tokens

This endpoint returns a list of all unused ACME binding tokens; once used,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is authed, right? (maybe say, "this authenticated endpoint")

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We usually only list unauthenticated endpoints; its assumed endpoints are authed by default. I've added a missing note to the Directories that it is unauthed from a Vault auth perspective though. :-) thanks!

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
@cipherboy cipherboy merged commit 5468518 into main May 30, 2023
@cipherboy cipherboy deleted the cipherboy-add-api-docs-for-acme branch May 30, 2023 15:01
@cipherboy
Copy link
Contributor Author

Thanks all!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants