Output default as part of OpenAPI (#6222)

hashicorp · Feb 12, 2019 · 4a7544c · 4a7544c
1 parent 79a07dd
commit 4a7544c
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 0 deletions.
diff --git a/logical/framework/openapi.go b/logical/framework/openapi.go
@@ -155,6 +155,7 @@ type OASSchema struct {
 	Format           string                `json:"format,omitempty"`
 	Pattern          string                `json:"pattern,omitempty"`
 	Enum             []interface{}         `json:"enum,omitempty"`
+	Default          interface{}           `json:"default,omitempty"`
 	Example          interface{}           `json:"example,omitempty"`
 	Deprecated       bool                  `json:"deprecated,omitempty"`
 	Required         bool                  `json:"required,omitempty"`
@@ -263,6 +264,7 @@ func documentPath(p *Path, specialPaths *logical.Paths, backendType logical.Back
 					Type:             t.baseType,
 					Pattern:          t.pattern,
 					Enum:             field.AllowedValues,
+					Default:          field.Default,
 					DisplayName:      field.DisplayName,
 					DisplayValue:     field.DisplayValue,
 					DisplaySensitive: field.DisplaySensitive,
@@ -321,6 +323,7 @@ func documentPath(p *Path, specialPaths *logical.Paths, backendType logical.Back
 						Format:           openapiField.format,
 						Pattern:          openapiField.pattern,
 						Enum:             field.AllowedValues,
+						Default:          field.Default,
 						Required:         field.Required,
 						Deprecated:       field.Deprecated,
 						DisplayName:      field.DisplayName,

diff --git a/logical/framework/openapi_test.go b/logical/framework/openapi_test.go
@@ -326,6 +326,7 @@ func TestOpenAPI_Paths(t *testing.T) {
 				},
 				"name": {
 					Type:        TypeNameString,
+					Default:     "Larry",
 					Description: "the name",
 				},
 				"age": {

diff --git a/logical/framework/testdata/operations.json b/logical/framework/testdata/operations.json
@@ -85,6 +85,7 @@
                   "name": {
                     "type": "string",
                     "description": "the name",
+                    "default": "Larry",
                     "pattern": "\\w([\\w-.]*\\w)?"
                   }
                 }