feat: omit sub items if not existent

vinyguedess · Jun 20, 2022 · 604c3c2 · 604c3c2
1 parent b00fe25
commit 604c3c2
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 15 deletions.
diff --git a/documentation.go b/documentation.go
@@ -65,21 +65,21 @@ type DocEndpoint struct {
 
 type DocEndpointResponse struct {
 	Description string                          `json:"description"`
-	Schema      DocEndpointSchema               `json:"schema,omitempty"`
+	Schema      *DocEndpointSchema              `json:"schema,omitempty"`
 	Headers     map[string]DocEndpointParameter `json:"headers,omitempty"`
 }
 
 type DocEndpointParameter struct {
-	In          DocEndpointParameterIn   `json:"in,omitempty"`
-	Name        string                   `json:"name,omitempty"`
-	Description string                   `json:"description,omitempty"`
-	Required    bool                     `json:"required,omitempty"`
-	Type        DocEndpointType          `json:"type,omitempty"`
-	Enum        []string                 `json:"enum,omitempty"`
-	Format      string                   `json:"format,omitempty"`
-	Items       DocEndpointParameterItem `json:"items,omitempty"`
-	Schema      DocEndpointSchema        `json:"schema,omitempty"`
-	Example     string                   `json:"example,omitempty"`
+	In          DocEndpointParameterIn    `json:"in,omitempty"`
+	Name        string                    `json:"name,omitempty"`
+	Description string                    `json:"description,omitempty"`
+	Required    bool                      `json:"required,omitempty"`
+	Type        DocEndpointType           `json:"type,omitempty"`
+	Enum        []string                  `json:"enum,omitempty"`
+	Format      string                    `json:"format,omitempty"`
+	Items       *DocEndpointParameterItem `json:"items,omitempty"`
+	Schema      *DocEndpointSchema        `json:"schema,omitempty"`
+	Example     string                    `json:"example,omitempty"`
 }
 
 type DocEndpointDefinition struct {
@@ -88,7 +88,7 @@ type DocEndpointDefinition struct {
 }
 
 type DocEndpointParameterItem struct {
-	Type   DocEndpointType `json:"type,omitempty"`
+	Type   DocEndpointType `json:"type"`
 	Enum   []string        `json:"enum,omitempty"`
 	Format string          `json:"format,omitempty"`
 	Ref    string          `json:"$ref,omitempty"`

diff --git a/documentation_test.go b/documentation_test.go
@@ -132,7 +132,7 @@ func Test_AddEndpointToDocs_EndpointDefinitions(t *testing.T) {
 				{
 					In:   DocEndpointParameterInBody,
 					Name: "body",
-					Schema: DocEndpointSchema{
+					Schema: &DocEndpointSchema{
 						Ref: "#/definitions/TestObject",
 					},
 				},
@@ -161,7 +161,7 @@ func Test_AddEndpointToDocs_EndpointDefinitions(t *testing.T) {
 						{
 							In:   DocEndpointParameterInBody,
 							Name: "body",
-							Schema: DocEndpointSchema{
+							Schema: &DocEndpointSchema{
 								Ref: "#/definitions/TestObject",
 							},
 						},

diff --git a/examples/swagger.go b/examples/swagger.go
@@ -56,7 +56,7 @@ func main() {
 				{
 					Name: "body",
 					In:   geh.DocEndpointParameterInBody,
-					Schema: geh.DocEndpointSchema{
+					Schema: &geh.DocEndpointSchema{
 						Ref: "#/definitions/TestObject",
 					},
 				},