diff options
author | Ethan Koenig <ethantkoenig@gmail.com> | 2017-11-12 23:02:25 -0800 |
---|---|---|
committer | Lauris BH <lauris@nix.lv> | 2017-11-13 09:02:25 +0200 |
commit | f26f4a7e01f9c380c261fa5bc21bd7e48f2f2f9f (patch) | |
tree | 39c2fc0abc5a10f80f8fa31b3bd57ec3604bf7fd /vendor/code.gitea.io/sdk/gitea/org.go | |
parent | 4287d100b39ff89e297ba8945e54fb5911226974 (diff) | |
download | gitea-f26f4a7e01f9c380c261fa5bc21bd7e48f2f2f9f.tar.gz gitea-f26f4a7e01f9c380c261fa5bc21bd7e48f2f2f9f.zip |
Update swagger documentation (#2899)
* Update swagger documentation
Add docs for missing endpoints
Add documentation for request parameters
Make parameter naming consistent
Fix response documentation
* Restore delete comments
Diffstat (limited to 'vendor/code.gitea.io/sdk/gitea/org.go')
-rw-r--r-- | vendor/code.gitea.io/sdk/gitea/org.go | 14 |
1 files changed, 4 insertions, 10 deletions
diff --git a/vendor/code.gitea.io/sdk/gitea/org.go b/vendor/code.gitea.io/sdk/gitea/org.go index ffdc2ffbea..d67d707e7b 100644 --- a/vendor/code.gitea.io/sdk/gitea/org.go +++ b/vendor/code.gitea.io/sdk/gitea/org.go @@ -10,8 +10,7 @@ import ( "fmt" ) -// Organization a group of some repositories, users and teams -// swagger:response Organization +// Organization represents an organization type Organization struct { ID int64 `json:"id"` UserName string `json:"username"` @@ -40,22 +39,17 @@ func (c *Client) GetOrg(orgname string) (*Organization, error) { return org, c.getParsedResponse("GET", fmt.Sprintf("/orgs/%s", orgname), nil, nil, org) } -// CreateOrgOption create one organization options -// swagger:parameters adminCreateOrg +// CreateOrgOption options for creating an organization type CreateOrgOption struct { - // in: body + // required: true UserName string `json:"username" binding:"Required"` - // in: body FullName string `json:"full_name"` - // in: body Description string `json:"description"` - // in: body Website string `json:"website"` - // in: body Location string `json:"location"` } -// EditOrgOption edit one organization options +// EditOrgOption options for editing an organization type EditOrgOption struct { FullName string `json:"full_name"` Description string `json:"description"` |