added OpenAPI response objects for sys endpoints (#18633)

* added response objects for sys 3 section * Update vault/logical_system_paths.go Co-authored-by: Daniel Huckins <dhuckins@users.noreply.github.com> * Update vault/logical_raw.go Co-authored-by: Daniel Huckins <dhuckins@users.noreply.github.com> * Update vault/logical_system_paths.go Co-authored-by: Daniel Huckins <dhuckins@users.noreply.github.com> * Update vault/logical_system_quotas.go Co-authored-by: Daniel Huckins <dhuckins@users.noreply.github.com> * Update vault/logical_system_quotas.go Co-authored-by: Daniel Huckins <dhuckins@users.noreply.github.com> * Update vault/logical_system_quotas.go Co-authored-by: Daniel Huckins <dhuckins@users.noreply.github.com> * add tests and update based on reviews * added changelog file * finally got make fmt to work... * fixed copy pasta test case * updated based on review * Update vault/logical_system_quotas.go Co-authored-by: Anton Averchenkov <84287187+averche@users.noreply.github.com> * Update vault/logical_system_test.go Co-authored-by: Daniel Huckins <dhuckins@users.noreply.github.com> * Update vault/logical_system_test.go Co-authored-by: Daniel Huckins <dhuckins@users.noreply.github.com> --------- Co-authored-by: lursu <leland.ursu@hashicorp.com> Co-authored-by: Daniel Huckins <dhuckins@users.noreply.github.com> Co-authored-by: Anton Averchenkov <84287187+averche@users.noreply.github.com>
hashicorp · Feb 15, 2023 · 7c261eb · 7c261eb
1 parent 4d29d00
commit 7c261eb
Show file tree

Hide file tree

Showing 5 changed files with 404 additions and 12 deletions.
diff --git a/changelog/18633.txt b/changelog/18633.txt
@@ -0,0 +1,3 @@
+```release-note:improvement
+openapi: Add openapi response definitions to /sys defined endpoints.
+```
diff --git a/vault/logical_raw.go b/vault/logical_raw.go
@@ -5,6 +5,7 @@ import (
 	"context"
 	"encoding/base64"
 	"fmt"
+	"net/http"
 	"strings"
 
 	log "github.com/hashicorp/go-hclog"
@@ -315,23 +316,60 @@ func rawPaths(prefix string, r *RawBackend) []*framework.Path {
 			Operations: map[logical.Operation]framework.OperationHandler{
 				logical.ReadOperation: &framework.PathOperation{
 					Callback: r.handleRawRead,
-					Summary:  "Read the value of the key at the given path.",
+					Responses: map[int][]framework.Response{
+						http.StatusOK: {{
+							Description: "OK",
+							Fields: map[string]*framework.FieldSchema{
+								"value": {
+									Type:     framework.TypeString,
+									Required: true,
+								},
+							},
+						}},
+					},
+					Summary: "Read the value of the key at the given path.",
 				},
 				logical.UpdateOperation: &framework.PathOperation{
 					Callback: r.handleRawWrite,
-					Summary:  "Update the value of the key at the given path.",
+					Responses: map[int][]framework.Response{
+						http.StatusOK: {{
+							Description: "OK",
+						}},
+					},
+					Summary: "Update the value of the key at the given path.",
 				},
 				logical.CreateOperation: &framework.PathOperation{
 					Callback: r.handleRawWrite,
-					Summary:  "Create a key with value at the given path.",
+					Responses: map[int][]framework.Response{
+						http.StatusNoContent: {{
+							Description: "OK",
+						}},
+					},
+					Summary: "Create a key with value at the given path.",
 				},
 				logical.DeleteOperation: &framework.PathOperation{
 					Callback: r.handleRawDelete,
-					Summary:  "Delete the key with given path.",
+					Responses: map[int][]framework.Response{
+						http.StatusNoContent: {{
+							Description: "OK",
+						}},
+					},
+					Summary: "Delete the key with given path.",
 				},
 				logical.ListOperation: &framework.PathOperation{
 					Callback: r.handleRawList,
-					Summary:  "Return a list keys for a given path prefix.",
+					Responses: map[int][]framework.Response{
+						http.StatusOK: {{
+							Description: "OK",
+							Fields: map[string]*framework.FieldSchema{
+								"keys": {
+									Type:     framework.TypeStringSlice,
+									Required: true,
+								},
+							},
+						}},
+					},
+					Summary: "Return a list keys for a given path prefix.",
 				},
 			},