Merge pull request 'fix(api): Clarify and correct descriptions for quota calls' (#4945) from fnetx/quota-api-language into forgejo

Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/4945
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
This commit is contained in:
Otto 2024-08-13 15:37:53 +00:00
commit 69eb8f32cb
2 changed files with 8 additions and 8 deletions

View file

@ -220,7 +220,7 @@ func RemoveUserFromQuotaGroup(ctx *context.APIContext) {
// required: true // required: true
// - name: username // - name: username
// in: path // in: path
// description: username of the user to add to the quota group // description: username of the user to remove from the quota group
// type: string // type: string
// required: true // required: true
// responses: // responses:
@ -255,12 +255,12 @@ func SetUserQuotaGroups(ctx *context.APIContext) {
// parameters: // parameters:
// - name: username // - name: username
// in: path // in: path
// description: username of the user to add to the quota group // description: username of the user to modify the quota groups from
// type: string // type: string
// required: true // required: true
// - name: groups // - name: groups
// in: body // in: body
// description: quota group to remove a user from // description: list of groups that the user should be a member of
// schema: // schema:
// "$ref": "#/definitions/SetUserQuotaGroupsOptions" // "$ref": "#/definitions/SetUserQuotaGroupsOptions"
// required: true // required: true
@ -405,7 +405,7 @@ func RemoveRuleFromQuotaGroup(ctx *context.APIContext) {
// parameters: // parameters:
// - name: quotagroup // - name: quotagroup
// in: path // in: path
// description: quota group to add a rule to // description: quota group to remove a rule from
// type: string // type: string
// required: true // required: true
// - name: quotarule // - name: quotarule

View file

@ -670,7 +670,7 @@
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"description": "quota group to add a rule to", "description": "quota group to remove a rule from",
"name": "quotagroup", "name": "quotagroup",
"in": "path", "in": "path",
"required": true "required": true
@ -800,7 +800,7 @@
}, },
{ {
"type": "string", "type": "string",
"description": "username of the user to add to the quota group", "description": "username of the user to remove from the quota group",
"name": "username", "name": "username",
"in": "path", "in": "path",
"required": true "required": true
@ -1465,13 +1465,13 @@
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"description": "username of the user to add to the quota group", "description": "username of the user to modify the quota groups from",
"name": "username", "name": "username",
"in": "path", "in": "path",
"required": true "required": true
}, },
{ {
"description": "quota group to remove a user from", "description": "list of groups that the user should be a member of",
"name": "groups", "name": "groups",
"in": "body", "in": "body",
"required": true, "required": true,