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

VAULT-12144: add openapi responses for /sys/seal endpoints #18625

Merged
merged 4 commits into from
Mar 28, 2023

Conversation

dhuckins
Copy link
Contributor

@dhuckins dhuckins commented Jan 6, 2023

Path Operation response docs
/sys/seal UPDATE link
/sys/unseal UPDATE link docs
/sys/seal-status READ link
/sys/step-down N/A already done link

couldn't find any tests (at least not in the same package)

@dhuckins dhuckins added this to the 1.13.0-rc1 milestone Jan 6, 2023
@dhuckins dhuckins changed the title add openapi responses for /sys/seal endpoints VAULT-12144:add openapi responses for /sys/seal endpoints Jan 6, 2023
@dhuckins dhuckins changed the title VAULT-12144:add openapi responses for /sys/seal endpoints VAULT-12144: add openapi responses for /sys/seal endpoints Jan 6, 2023
@dhuckins dhuckins requested a review from a team January 6, 2023 21:52
@dhuckins dhuckins marked this pull request as ready for review January 6, 2023 21:52
@vercel
Copy link

vercel bot commented Jan 6, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
vault 🔄 Building (Inspect) Jan 6, 2023 at 9:58PM (UTC)

@@ -493,6 +499,77 @@ func (b *SystemBackend) rekeyPaths() []*framework.Path {
Operations: map[logical.Operation]framework.OperationHandler{
logical.UpdateOperation: &framework.PathOperation{
Summary: "Unseal the Vault.",
Responses: map[int][]framework.Response{
http.StatusOK: {{
// unseal returns `vault.SealStatusResponse` struct
Copy link
Contributor

Choose a reason for hiding this comment

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

I see warnings as a part of SealStatusResponse here. Should that get handled here too?

// unseal returns `vault.SealStatusResponse` struct
Fields: map[string]*framework.FieldSchema{
"type": {
Type: framework.TypeString,
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we want descriptions here? I believe it will affect code comments and intellisense when generating code

Copy link
Contributor

@AnPucel AnPucel left a comment

Choose a reason for hiding this comment

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

A few small comments, but looks good otherwise

@averche averche modified the milestones: 1.13.0-rc1, 1.14 Feb 13, 2023
@dhuckins dhuckins merged commit b4756f9 into main Mar 28, 2023
@dhuckins dhuckins deleted the dh/response-structures-sys-3-seal branch March 28, 2023 19:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants