From 09b073356df8ed47fe5eccfd7f8c16ef762a78c5 Mon Sep 17 00:00:00 2001 From: WUMUXIAN Date: Sat, 10 Mar 2018 17:15:24 +0800 Subject: [PATCH] Swagger: 1. Allow example value to be given based on the field type, previously it's a string. 2. Allow to give example values for Enum values. This is for the beego/bee pull request to work well. --- swagger/swagger.go | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/swagger/swagger.go b/swagger/swagger.go index 105d7fa4..a55676cd 100644 --- a/swagger/swagger.go +++ b/swagger/swagger.go @@ -122,6 +122,7 @@ type Schema struct { Items *Schema `json:"items,omitempty" yaml:"items,omitempty"` Properties map[string]Propertie `json:"properties,omitempty" yaml:"properties,omitempty"` Enum []interface{} `json:"enum,omitempty" yaml:"enum,omitempty"` + Example interface{} `json:"example,omitempty" yaml:"example,omitempty"` } // Propertie are taken from the JSON Schema definition but their definitions were adjusted to the Swagger Specification @@ -131,7 +132,7 @@ type Propertie struct { Description string `json:"description,omitempty" yaml:"description,omitempty"` Default interface{} `json:"default,omitempty" yaml:"default,omitempty"` Type string `json:"type,omitempty" yaml:"type,omitempty"` - Example string `json:"example,omitempty" yaml:"example,omitempty"` + Example interface{} `json:"example,omitempty" yaml:"example,omitempty"` Required []string `json:"required,omitempty" yaml:"required,omitempty"` Format string `json:"format,omitempty" yaml:"format,omitempty"` ReadOnly bool `json:"readOnly,omitempty" yaml:"readOnly,omitempty"`