From 6004b78b654b06095c57a2082dc5ceb676c2d3a7 Mon Sep 17 00:00:00 2001 From: Antoine GIRARD Date: Tue, 20 Aug 2019 00:53:59 +0200 Subject: [PATCH 1/3] []string are not enum by swagger definition --- modules/structs/org_team.go | 6 +++--- templates/swagger/v1_json.tmpl | 36 ++++++---------------------------- 2 files changed, 9 insertions(+), 33 deletions(-) diff --git a/modules/structs/org_team.go b/modules/structs/org_team.go index b8b5090225546..7b9a126938927 100644 --- a/modules/structs/org_team.go +++ b/modules/structs/org_team.go @@ -13,7 +13,7 @@ type Team struct { Organization *Organization `json:"organization"` // enum: none,read,write,admin,owner Permission string `json:"permission"` - // enum: repo.code,repo.issues,repo.ext_issues,repo.wiki,repo.pulls,repo.releases,repo.ext_wiki + // example: [repo.code,repo.issues,repo.ext_issues,repo.wiki,repo.pulls,repo.releases,repo.ext_wiki] Units []string `json:"units"` } @@ -24,7 +24,7 @@ type CreateTeamOption struct { Description string `json:"description" binding:"MaxSize(255)"` // enum: read,write,admin Permission string `json:"permission"` - // enum: repo.code,repo.issues,repo.ext_issues,repo.wiki,repo.pulls,repo.releases,repo.ext_wiki + // example: [repo.code,repo.issues,repo.ext_issues,repo.wiki,repo.pulls,repo.releases,repo.ext_wiki] Units []string `json:"units"` } @@ -35,6 +35,6 @@ type EditTeamOption struct { Description string `json:"description" binding:"MaxSize(255)"` // enum: read,write,admin Permission string `json:"permission"` - // enum: repo.code,repo.issues,repo.ext_issues,repo.wiki,repo.pulls,repo.releases,repo.ext_wiki + // example: [repo.code,repo.issues,repo.ext_issues,repo.wiki,repo.pulls,repo.releases,repo.ext_wiki] Units []string `json:"units"` } diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl index 2d5f8c5c9c253..da66eae7765e4 100644 --- a/templates/swagger/v1_json.tmpl +++ b/templates/swagger/v1_json.tmpl @@ -7664,19 +7664,11 @@ }, "units": { "type": "array", - "enum": [ - "repo.code", - "repo.issues", - "repo.ext_issues", - "repo.wiki", - "repo.pulls", - "repo.releases", - "repo.ext_wiki" - ], "items": { "type": "string" }, - "x-go-name": "Units" + "x-go-name": "Units", + "example": "[repo.code,repo.issues,repo.ext_issues,repo.wiki,repo.pulls,repo.releases,repo.ext_wiki]" } }, "x-go-package": "code.gitea.io/gitea/modules/structs" @@ -8198,19 +8190,11 @@ }, "units": { "type": "array", - "enum": [ - "repo.code", - "repo.issues", - "repo.ext_issues", - "repo.wiki", - "repo.pulls", - "repo.releases", - "repo.ext_wiki" - ], "items": { "type": "string" }, - "x-go-name": "Units" + "x-go-name": "Units", + "example": "[repo.code,repo.issues,repo.ext_issues,repo.wiki,repo.pulls,repo.releases,repo.ext_wiki]" } }, "x-go-package": "code.gitea.io/gitea/modules/structs" @@ -9749,19 +9733,11 @@ }, "units": { "type": "array", - "enum": [ - "repo.code", - "repo.issues", - "repo.ext_issues", - "repo.wiki", - "repo.pulls", - "repo.releases", - "repo.ext_wiki" - ], "items": { "type": "string" }, - "x-go-name": "Units" + "x-go-name": "Units", + "example": "[repo.code,repo.issues,repo.ext_issues,repo.wiki,repo.pulls,repo.releases,repo.ext_wiki]" } }, "x-go-package": "code.gitea.io/gitea/modules/structs" From 2bf4ef20f3aec803d386d1ad67fca040503658ee Mon Sep 17 00:00:00 2001 From: Antoine GIRARD Date: Fri, 23 Aug 2019 17:58:47 +0200 Subject: [PATCH 2/3] apply suggestion of @guillep2k --- modules/structs/org_team.go | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/structs/org_team.go b/modules/structs/org_team.go index 7b9a126938927..bea4a10ad494d 100644 --- a/modules/structs/org_team.go +++ b/modules/structs/org_team.go @@ -13,7 +13,7 @@ type Team struct { Organization *Organization `json:"organization"` // enum: none,read,write,admin,owner Permission string `json:"permission"` - // example: [repo.code,repo.issues,repo.ext_issues,repo.wiki,repo.pulls,repo.releases,repo.ext_wiki] + // example: ["repo.code","repo.issues","repo.ext_issues","repo.wiki","repo.pulls","repo.releases","repo.ext_wiki"] Units []string `json:"units"` } @@ -24,7 +24,7 @@ type CreateTeamOption struct { Description string `json:"description" binding:"MaxSize(255)"` // enum: read,write,admin Permission string `json:"permission"` - // example: [repo.code,repo.issues,repo.ext_issues,repo.wiki,repo.pulls,repo.releases,repo.ext_wiki] + // example: ["repo.code","repo.issues","repo.ext_issues","repo.wiki","repo.pulls","repo.releases","repo.ext_wiki"] Units []string `json:"units"` } @@ -35,6 +35,6 @@ type EditTeamOption struct { Description string `json:"description" binding:"MaxSize(255)"` // enum: read,write,admin Permission string `json:"permission"` - // example: [repo.code,repo.issues,repo.ext_issues,repo.wiki,repo.pulls,repo.releases,repo.ext_wiki] + // example: ["repo.code","repo.issues","repo.ext_issues","repo.wiki","repo.pulls","repo.releases","repo.ext_wiki"] Units []string `json:"units"` } From d69d8efeb2e2243e924242e0ce2f23a10608690f Mon Sep 17 00:00:00 2001 From: Antoine GIRARD Date: Fri, 23 Aug 2019 18:00:44 +0200 Subject: [PATCH 3/3] re-generate swagger file --- templates/swagger/v1_json.tmpl | 30 +++++++++++++++++++++++++++--- 1 file changed, 27 insertions(+), 3 deletions(-) diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl index da66eae7765e4..8df3230d16d0b 100644 --- a/templates/swagger/v1_json.tmpl +++ b/templates/swagger/v1_json.tmpl @@ -7668,7 +7668,15 @@ "type": "string" }, "x-go-name": "Units", - "example": "[repo.code,repo.issues,repo.ext_issues,repo.wiki,repo.pulls,repo.releases,repo.ext_wiki]" + "example": [ + "repo.code", + "repo.issues", + "repo.ext_issues", + "repo.wiki", + "repo.pulls", + "repo.releases", + "repo.ext_wiki" + ] } }, "x-go-package": "code.gitea.io/gitea/modules/structs" @@ -8194,7 +8202,15 @@ "type": "string" }, "x-go-name": "Units", - "example": "[repo.code,repo.issues,repo.ext_issues,repo.wiki,repo.pulls,repo.releases,repo.ext_wiki]" + "example": [ + "repo.code", + "repo.issues", + "repo.ext_issues", + "repo.wiki", + "repo.pulls", + "repo.releases", + "repo.ext_wiki" + ] } }, "x-go-package": "code.gitea.io/gitea/modules/structs" @@ -9737,7 +9753,15 @@ "type": "string" }, "x-go-name": "Units", - "example": "[repo.code,repo.issues,repo.ext_issues,repo.wiki,repo.pulls,repo.releases,repo.ext_wiki]" + "example": [ + "repo.code", + "repo.issues", + "repo.ext_issues", + "repo.wiki", + "repo.pulls", + "repo.releases", + "repo.ext_wiki" + ] } }, "x-go-package": "code.gitea.io/gitea/modules/structs"