chore: DocEndpointTypeBoolean, DocEndpointTypeObject and DocEndpointT…

…ypeArray
vinyguedess · Jun 20, 2022 · a67f901 · a67f901
1 parent be77ea3
commit a67f901
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 8 deletions.
diff --git a/documentation.go b/documentation.go
@@ -29,6 +29,9 @@ const (
 const (
 	DocEndpointTypeString  DocEndpointType = "string"
 	DocEndpointTypeInteger DocEndpointType = "integer"
+	DocEndpointTypeBoolean DocEndpointType = "boolean"
+	DocEndpointTypeObject  DocEndpointType = "object"
+	DocEndpointTypeArray   DocEndpointType = "array"
 )
 
 type DocAppInfo struct {
@@ -84,7 +87,7 @@ type DocEndpointParameter struct {
 }
 
 type DocEndpointDefinition struct {
-	Type       string                          `json:"type"`
+	Type       DocEndpointType                 `json:"type"`
 	Properties map[string]DocEndpointParameter `json:"properties"`
 }
 
@@ -96,9 +99,9 @@ type DocEndpointParameterItem struct {
 }
 
 type DocEndpointSchema struct {
-	Type                 string `json:"type,omitempty"`
-	Ref                  string `json:"$ref,omitempty"`
-	AdditionalProperties bool   `json:"additionalProperties,omitempty"`
+	Type                 DocEndpointType `json:"type,omitempty"`
+	Ref                  string          `json:"$ref,omitempty"`
+	AdditionalProperties bool            `json:"additionalProperties,omitempty"`
 }
 
 func NewDocApp(title string, version string) DocApp {

diff --git a/documentation_test.go b/documentation_test.go
@@ -139,7 +139,7 @@ func Test_AddEndpointToDocs_EndpointDefinitions(t *testing.T) {
 			},
 			Definitions: map[string]DocEndpointDefinition{
 				"TestObject": {
-					Type: "object",
+					Type: DocEndpointTypeObject,
 					Properties: map[string]DocEndpointParameter{
 						"name": {
 							Type:     "string",
@@ -168,7 +168,7 @@ func Test_AddEndpointToDocs_EndpointDefinitions(t *testing.T) {
 					},
 					Definitions: map[string]DocEndpointDefinition{
 						"TestObject": {
-							Type: "object",
+							Type: DocEndpointTypeObject,
 							Properties: map[string]DocEndpointParameter{
 								"name": {
 									Type:     "string",
@@ -186,7 +186,7 @@ func Test_AddEndpointToDocs_EndpointDefinitions(t *testing.T) {
 		t,
 		map[string]DocEndpointDefinition{
 			"TestObject": {
-				Type: "object",
+				Type: DocEndpointTypeObject,
 				Properties: map[string]DocEndpointParameter{
 					"name": {
 						Type:     "string",

diff --git a/examples/swagger.go b/examples/swagger.go
@@ -68,7 +68,7 @@ func main() {
 			},
 			Definitions: map[string]geh.DocEndpointDefinition{
 				"TestObject": {
-					Type: "object",
+					Type: geh.DocEndpointTypeObject,
 					Properties: map[string]geh.DocEndpointParameter{
 						"name": {
 							Type:     geh.DocEndpointTypeString,