mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2026-02-19 01:27:55 -05:00
fix: correct malformed CreateTeamOption example (#11093)
The example was not a valid map, which caused issues with some openapi yaml converters. I gave the two options proper values and also added them to the other team structs so the examples are identical. Also sorted them as they are enumerated in the [unit model definition](https://codeberg.org/forgejo/forgejo/src/branch/forgejo/models/unit/unit.go), which is why the diff is a bit ugly. Fixes #9881 Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/11093 Reviewed-by: Gusted <gusted@noreply.codeberg.org> Co-authored-by: Florian Pallas <mail@fpallas.com> Co-committed-by: Florian Pallas <mail@fpallas.com>
This commit is contained in:
parent
5589182c54
commit
cf17b5fad9
2 changed files with 19 additions and 4 deletions
|
|
@ -17,7 +17,7 @@ type Team struct {
|
|||
//
|
||||
// Deprecated: This variable should be replaced by UnitsMap and will be dropped in later versions.
|
||||
Units []string `json:"units"`
|
||||
// example: {"repo.code":"read","repo.issues":"write","repo.ext_issues":"none","repo.wiki":"admin","repo.pulls":"owner","repo.releases":"none","repo.projects":"none","repo.ext_wiki":"none"}
|
||||
// example: {"repo.code":"read","repo.issues":"write","repo.ext_issues":"none","repo.pulls":"owner","repo.releases":"none","repo.wiki":"admin","repo.ext_wiki":"none","repo.projects":"none","repo.packages":"none","repo.actions":"none"}
|
||||
UnitsMap map[string]string `json:"units_map"`
|
||||
CanCreateOrgRepo bool `json:"can_create_org_repo"`
|
||||
}
|
||||
|
|
@ -34,7 +34,7 @@ type CreateTeamOption struct {
|
|||
//
|
||||
// Deprecated: This variable should be replaced by UnitsMap and will be dropped in later versions.
|
||||
Units []string `json:"units"`
|
||||
// example: {"repo.actions","repo.packages","repo.code":"read","repo.issues":"write","repo.ext_issues":"none","repo.wiki":"admin","repo.pulls":"owner","repo.releases":"none","repo.projects":"none","repo.ext_wiki":"none"}
|
||||
// example: {"repo.code":"read","repo.issues":"write","repo.ext_issues":"none","repo.pulls":"owner","repo.releases":"none","repo.wiki":"admin","repo.ext_wiki":"none","repo.projects":"none","repo.packages":"none","repo.actions":"none"}
|
||||
UnitsMap map[string]string `json:"units_map"`
|
||||
CanCreateOrgRepo bool `json:"can_create_org_repo"`
|
||||
}
|
||||
|
|
@ -51,7 +51,7 @@ type EditTeamOption struct {
|
|||
//
|
||||
// Deprecated: This variable should be replaced by UnitsMap and will be dropped in later versions.
|
||||
Units []string `json:"units"`
|
||||
// example: {"repo.code":"read","repo.issues":"write","repo.ext_issues":"none","repo.wiki":"admin","repo.pulls":"owner","repo.releases":"none","repo.projects":"none","repo.ext_wiki":"none"}
|
||||
// example: {"repo.code":"read","repo.issues":"write","repo.ext_issues":"none","repo.pulls":"owner","repo.releases":"none","repo.wiki":"admin","repo.ext_wiki":"none","repo.projects":"none","repo.packages":"none","repo.actions":"none"}
|
||||
UnitsMap map[string]string `json:"units_map"`
|
||||
CanCreateOrgRepo *bool `json:"can_create_org_repo"`
|
||||
}
|
||||
|
|
|
|||
17
templates/swagger/v1_json.tmpl
generated
17
templates/swagger/v1_json.tmpl
generated
|
|
@ -24540,7 +24540,18 @@
|
|||
"type": "string"
|
||||
},
|
||||
"x-go-name": "UnitsMap",
|
||||
"example": "{\"repo.actions\",\"repo.packages\",\"repo.code\":\"read\",\"repo.issues\":\"write\",\"repo.ext_issues\":\"none\",\"repo.wiki\":\"admin\",\"repo.pulls\":\"owner\",\"repo.releases\":\"none\",\"repo.projects\":\"none\",\"repo.ext_wiki\":\"none\"}"
|
||||
"example": {
|
||||
"repo.actions": "none",
|
||||
"repo.code": "read",
|
||||
"repo.ext_issues": "none",
|
||||
"repo.ext_wiki": "none",
|
||||
"repo.issues": "write",
|
||||
"repo.packages": "none",
|
||||
"repo.projects": "none",
|
||||
"repo.pulls": "owner",
|
||||
"repo.releases": "none",
|
||||
"repo.wiki": "admin"
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-go-package": "forgejo.org/modules/structs"
|
||||
|
|
@ -25608,10 +25619,12 @@
|
|||
},
|
||||
"x-go-name": "UnitsMap",
|
||||
"example": {
|
||||
"repo.actions": "none",
|
||||
"repo.code": "read",
|
||||
"repo.ext_issues": "none",
|
||||
"repo.ext_wiki": "none",
|
||||
"repo.issues": "write",
|
||||
"repo.packages": "none",
|
||||
"repo.projects": "none",
|
||||
"repo.pulls": "owner",
|
||||
"repo.releases": "none",
|
||||
|
|
@ -29350,10 +29363,12 @@
|
|||
},
|
||||
"x-go-name": "UnitsMap",
|
||||
"example": {
|
||||
"repo.actions": "none",
|
||||
"repo.code": "read",
|
||||
"repo.ext_issues": "none",
|
||||
"repo.ext_wiki": "none",
|
||||
"repo.issues": "write",
|
||||
"repo.packages": "none",
|
||||
"repo.projects": "none",
|
||||
"repo.pulls": "owner",
|
||||
"repo.releases": "none",
|
||||
|
|
|
|||
Loading…
Reference in a new issue