2024-05-07 03:59:49 -04:00
|
|
|
// Copyright 2024 The Forgejo Authors. All rights reserved.
|
2017-11-13 02:02:25 -05:00
|
|
|
// Copyright 2017 The Gitea Authors. All rights reserved.
|
2022-11-27 13:20:29 -05:00
|
|
|
// SPDX-License-Identifier: MIT
|
2017-11-13 02:02:25 -05:00
|
|
|
|
|
|
|
package swagger
|
|
|
|
|
|
|
|
import (
|
2024-05-07 03:59:49 -04:00
|
|
|
ffed "code.gitea.io/gitea/modules/forgefed"
|
2019-05-11 06:21:34 -04:00
|
|
|
api "code.gitea.io/gitea/modules/structs"
|
2021-04-06 15:44:05 -04:00
|
|
|
"code.gitea.io/gitea/services/forms"
|
2017-11-13 02:02:25 -05:00
|
|
|
)
|
|
|
|
|
|
|
|
// not actually a response, just a hack to get go-swagger to include definitions
|
|
|
|
// of the various XYZOption structs
|
|
|
|
|
2018-05-31 07:13:55 -04:00
|
|
|
// parameterBodies
|
2017-11-13 02:02:25 -05:00
|
|
|
// swagger:response parameterBodies
|
|
|
|
type swaggerParameterBodies struct {
|
2024-05-07 03:59:49 -04:00
|
|
|
// in:body
|
|
|
|
ForgeLike ffed.ForgeLike
|
|
|
|
|
2018-06-12 10:59:22 -04:00
|
|
|
// in:body
|
2017-11-13 02:02:25 -05:00
|
|
|
AddCollaboratorOption api.AddCollaboratorOption
|
|
|
|
|
2024-01-05 07:45:10 -05:00
|
|
|
// in:body
|
|
|
|
ReplaceFlagsOption api.ReplaceFlagsOption
|
|
|
|
|
2018-06-12 10:59:22 -04:00
|
|
|
// in:body
|
2017-11-13 02:02:25 -05:00
|
|
|
CreateEmailOption api.CreateEmailOption
|
2018-06-12 10:59:22 -04:00
|
|
|
// in:body
|
2017-11-13 02:02:25 -05:00
|
|
|
DeleteEmailOption api.DeleteEmailOption
|
|
|
|
|
2018-06-12 10:59:22 -04:00
|
|
|
// in:body
|
2017-11-13 02:02:25 -05:00
|
|
|
CreateHookOption api.CreateHookOption
|
2018-06-12 10:59:22 -04:00
|
|
|
// in:body
|
|
|
|
EditHookOption api.EditHookOption
|
2017-11-13 02:02:25 -05:00
|
|
|
|
2019-04-17 01:31:08 -04:00
|
|
|
// in:body
|
|
|
|
EditGitHookOption api.EditGitHookOption
|
|
|
|
|
2018-06-12 10:59:22 -04:00
|
|
|
// in:body
|
2017-11-13 02:02:25 -05:00
|
|
|
CreateIssueOption api.CreateIssueOption
|
2018-06-12 10:59:22 -04:00
|
|
|
// in:body
|
|
|
|
EditIssueOption api.EditIssueOption
|
2018-07-16 08:43:00 -04:00
|
|
|
// in:body
|
|
|
|
EditDeadlineOption api.EditDeadlineOption
|
2017-11-13 02:02:25 -05:00
|
|
|
|
2018-06-12 10:59:22 -04:00
|
|
|
// in:body
|
2017-11-13 02:02:25 -05:00
|
|
|
CreateIssueCommentOption api.CreateIssueCommentOption
|
2018-06-12 10:59:22 -04:00
|
|
|
// in:body
|
|
|
|
EditIssueCommentOption api.EditIssueCommentOption
|
2023-03-28 13:23:25 -04:00
|
|
|
// in:body
|
|
|
|
IssueMeta api.IssueMeta
|
2017-11-13 02:02:25 -05:00
|
|
|
|
2018-06-12 10:59:22 -04:00
|
|
|
// in:body
|
2017-11-13 02:02:25 -05:00
|
|
|
IssueLabelsOption api.IssueLabelsOption
|
|
|
|
|
[FEAT] allow setting the update date on issues and comments
This field adds the possibility to set the update date when modifying
an issue through the API.
A 'NoAutoDate' in-memory field is added in the Issue struct.
If the update_at field is set, NoAutoDate is set to true and the
Issue's UpdatedUnix field is filled.
That information is passed down to the functions that actually updates
the database, which have been modified to not auto update dates if
requested.
A guard is added to the 'EditIssue' API call, to checks that the
udpate_at date is between the issue's creation date and the current
date (to avoid 'malicious' changes). It also limits the new feature
to project's owners and admins.
(cherry picked from commit c524d33402c76bc4cccea2806f289e08a009baae)
Add a SetIssueUpdateDate() function in services/issue.go
That function is used by some API calls to set the NoAutoDate and
UpdatedUnix fields of an Issue if an updated_at date is provided.
(cherry picked from commit f061caa6555e0c9e922ee1e73dd2e4337360e9fe)
Add an updated_at field to the API calls related to Issue's Labels.
The update date is applied to the issue's comment created to inform
about the modification of the issue's labels.
(cherry picked from commit ea36cf80f58f0ab20c565a8f5d063b90fd741f97)
Add an updated_at field to the API call for issue's attachment creation
The update date is applied to the issue's comment created to inform
about the modification of the issue's content, and is set as the
asset creation date.
(cherry picked from commit 96150971ca31b97e97e84d5f5eb95a177cc44e2e)
Checking Issue changes, with and without providing an updated_at date
Those unit tests are added:
- TestAPIEditIssueWithAutoDate
- TestAPIEditIssueWithNoAutoDate
- TestAPIAddIssueLabelsWithAutoDate
- TestAPIAddIssueLabelsWithNoAutoDate
- TestAPICreateIssueAttachmentWithAutoDate
- TestAPICreateIssueAttachmentWithNoAutoDate
(cherry picked from commit 4926a5d7a28581003545256632213bf4136b193d)
Add an updated_at field to the API call for issue's comment creation
The update date is used as the comment creation date, and is applied to
the issue as the update creation date.
(cherry picked from commit 76c8faecdc6cba48ca4fe07d1a916d1f1a4b37b4)
Add an updated_at field to the API call for issue's comment edition
The update date is used as the comment update date, and is applied to
the issue as an update date.
(cherry picked from commit cf787ad7fdb8e6273fdc35d7b5cc164b400207e9)
Add an updated_at field to the API call for comment's attachment creation
The update date is applied to the comment, and is set as the asset
creation date.
(cherry picked from commit 1e4ff424d39db7a4256cd9abf9c58b8d3e1b5c14)
Checking Comment changes, with and without providing an updated_at date
Those unit tests are added:
- TestAPICreateCommentWithAutoDate
- TestAPICreateCommentWithNoAutoDate
- TestAPIEditCommentWithAutoDate
- TestAPIEditCommentWithNoAutoDate
- TestAPICreateCommentAttachmentWithAutoDate
- TestAPICreateCommentAttachmentWithNoAutoDate
(cherry picked from commit da932152f1deb3039a399516a51c8b6757059c91)
Pettier code to set the update time of comments
Now uses sess.AllCols().NoAutoToime().SetExpr("updated_unix", ...)
XORM is smart enough to compose one single SQL UPDATE which all
columns + updated_unix.
(cherry picked from commit 1f6a42808dd739c0c2e49e6b7ae2967f120f43c2)
Issue edition: Keep the max of the milestone and issue update dates.
When editing an issue via the API, an updated_at date can be provided.
If the EditIssue call changes the issue's milestone, the milestone's
update date is to be changed accordingly, but only with a greater
value.
This ensures that a milestone's update date is the max of all issue's
update dates.
(cherry picked from commit 8f22ea182e6b49e933dc6534040160dd739ff18a)
Rewrite the 'AutoDate' tests using subtests
Also add a test to check the permissions to set a date, and a test
to check update dates on milestones.
The tests related to 'AutoDate' are:
- TestAPIEditIssueAutoDate
- TestAPIAddIssueLabelsAutoDate
- TestAPIEditIssueMilestoneAutoDate
- TestAPICreateIssueAttachmentAutoDate
- TestAPICreateCommentAutoDate
- TestAPIEditCommentWithDate
- TestAPICreateCommentAttachmentAutoDate
(cherry picked from commit 961fd13c551b3e50040acb7c914a00ead92de63f)
(cherry picked from commit d52f4eea44692ee773010cb66a69a603663947d5)
(cherry picked from commit 3540ea2a43155ca8cf5ab1a4a246babfb829db16)
Conflicts:
services/issue/issue.go
https://codeberg.org/forgejo/forgejo/pulls/1415
(cherry picked from commit 56720ade008c09122d825959171aa5346d645987)
Conflicts:
routers/api/v1/repo/issue_label.go
https://codeberg.org/forgejo/forgejo/pulls/1462
(cherry picked from commit 47c78927d6c7e7a50298fa67efad1e73723a0981)
(cherry picked from commit 2030f3b965cde401976821083c3250b404954ecc)
(cherry picked from commit f02aeb76981cd688ceaf6613f142a8a725be1437)
Conflicts:
routers/api/v1/repo/issue_attachment.go
routers/api/v1/repo/issue_comment_attachment.go
https://codeberg.org/forgejo/forgejo/pulls/1575
(cherry picked from commit d072525b35e44faf7ff87143c0e52b8ba8a625c8)
(cherry picked from commit 8424d0ab3df75ac3ffa30f42d398e22995ada5e7)
(cherry picked from commit 5cc62caec788b54afd9da5b9193ce06ee8ec562b)
(cherry picked from commit d6300d5dcd01c7ddc65d8b0f326f9c19cb53b58e)
[FEAT] allow setting the update date on issues and comments (squash) apply the 'update_at' value to the cross-ref comments (#1676)
[this is a follow-up to PR #764]
When a comment of issue A referencing issue B is added with a forced 'updated_at' date, that date has to be applied to the comment created in issue B.
-----
Comment:
While trying my 'RoundUp migration script', I found that this case was forgotten in PR #764 - my apologies...
I'll try to write a functional test, base on models/issues/issue_xref_test.go
Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/1676
Co-authored-by: fluzz <fluzz@freedroid.org>
Co-committed-by: fluzz <fluzz@freedroid.org>
(cherry picked from commit ac4f727f63a2dd746dd84a31ebf7f70d5b5d7c52)
(cherry picked from commit 5110476ee9010ba8cdca0e0f37f765f8800e9fe1)
(cherry picked from commit 77ba6be1dab4f6f3678d79a394da56e6447ebbe1)
(cherry picked from commit 9c8337b5c442cfd72d97597c2089e776f42828b7)
(cherry picked from commit 1d689eb686f0f7df09c7861b3faf9d8683cb933b)
(cherry picked from commit 511c519c875a4c4e65c02ef0c4e3b941f4da4371)
(cherry picked from commit 2f0b4a8f610837d34844bb79cda1360ab23b6b1c)
(cherry picked from commit fdd4da111c449322901a0acf6d0857eac4716581)
[FEAT] allow setting the update date on issues and comments (squash) do not use token= query param
See https://codeberg.org/forgejo/forgejo/commit/33439b733a
(cherry picked from commit c5139a75b9e4af612a628171bd4f63a24860c272)
(cherry picked from commit c7b572c35d3e9e22017fd74045bcdc1109bd06df)
(cherry picked from commit aec7503ff6dd177980f3d9f367122ffc2fec8986)
(cherry picked from commit 87c65f2a490faeccb85088fa0981dd50f7199eb8)
(cherry picked from commit bd47ee33c20e53ae616a7e53d63c3b51809585fb)
(cherry picked from commit f3dbd90a747c14fb1b5b4271db6c10abbf86d586)
2023-10-09 13:07:47 -04:00
|
|
|
// in:body
|
|
|
|
DeleteLabelsOption api.DeleteLabelsOption
|
|
|
|
|
2018-06-12 10:59:22 -04:00
|
|
|
// in:body
|
2017-11-13 02:02:25 -05:00
|
|
|
CreateKeyOption api.CreateKeyOption
|
|
|
|
|
2023-03-14 03:45:21 -04:00
|
|
|
// in:body
|
|
|
|
RenameUserOption api.RenameUserOption
|
|
|
|
|
2018-06-12 10:59:22 -04:00
|
|
|
// in:body
|
2017-11-13 02:02:25 -05:00
|
|
|
CreateLabelOption api.CreateLabelOption
|
2018-06-12 10:59:22 -04:00
|
|
|
// in:body
|
|
|
|
EditLabelOption api.EditLabelOption
|
2017-11-13 02:02:25 -05:00
|
|
|
|
2023-03-24 02:12:23 -04:00
|
|
|
// in:body
|
|
|
|
MarkupOption api.MarkupOption
|
2018-06-12 10:59:22 -04:00
|
|
|
// in:body
|
2017-11-13 02:02:25 -05:00
|
|
|
MarkdownOption api.MarkdownOption
|
|
|
|
|
2018-06-12 10:59:22 -04:00
|
|
|
// in:body
|
2017-11-13 02:02:25 -05:00
|
|
|
CreateMilestoneOption api.CreateMilestoneOption
|
2018-06-12 10:59:22 -04:00
|
|
|
// in:body
|
|
|
|
EditMilestoneOption api.EditMilestoneOption
|
2017-11-13 02:02:25 -05:00
|
|
|
|
2018-06-12 10:59:22 -04:00
|
|
|
// in:body
|
2017-11-13 02:02:25 -05:00
|
|
|
CreateOrgOption api.CreateOrgOption
|
2018-06-12 10:59:22 -04:00
|
|
|
// in:body
|
|
|
|
EditOrgOption api.EditOrgOption
|
2017-11-13 02:02:25 -05:00
|
|
|
|
2018-06-12 10:59:22 -04:00
|
|
|
// in:body
|
2017-11-13 02:02:25 -05:00
|
|
|
CreatePullRequestOption api.CreatePullRequestOption
|
2018-06-12 10:59:22 -04:00
|
|
|
// in:body
|
|
|
|
EditPullRequestOption api.EditPullRequestOption
|
2019-02-08 03:08:38 -05:00
|
|
|
// in:body
|
2021-04-06 15:44:05 -04:00
|
|
|
MergePullRequestOption forms.MergePullRequestForm
|
2017-11-13 02:02:25 -05:00
|
|
|
|
2018-06-12 10:59:22 -04:00
|
|
|
// in:body
|
2017-11-13 02:02:25 -05:00
|
|
|
CreateReleaseOption api.CreateReleaseOption
|
2018-06-12 10:59:22 -04:00
|
|
|
// in:body
|
|
|
|
EditReleaseOption api.EditReleaseOption
|
2017-11-13 02:02:25 -05:00
|
|
|
|
2018-06-12 10:59:22 -04:00
|
|
|
// in:body
|
2017-11-13 02:02:25 -05:00
|
|
|
CreateRepoOption api.CreateRepoOption
|
2018-06-12 10:59:22 -04:00
|
|
|
// in:body
|
2019-05-30 11:09:05 -04:00
|
|
|
EditRepoOption api.EditRepoOption
|
|
|
|
// in:body
|
2020-01-31 10:49:04 -05:00
|
|
|
TransferRepoOption api.TransferRepoOption
|
|
|
|
// in:body
|
2017-11-13 02:02:25 -05:00
|
|
|
CreateForkOption api.CreateForkOption
|
2021-07-05 11:29:08 -04:00
|
|
|
// in:body
|
|
|
|
GenerateRepoOption api.GenerateRepoOption
|
2017-11-13 02:02:25 -05:00
|
|
|
|
2018-06-12 10:59:22 -04:00
|
|
|
// in:body
|
2017-11-13 02:02:25 -05:00
|
|
|
CreateStatusOption api.CreateStatusOption
|
|
|
|
|
2018-06-12 10:59:22 -04:00
|
|
|
// in:body
|
2017-11-13 02:02:25 -05:00
|
|
|
CreateTeamOption api.CreateTeamOption
|
2018-06-12 10:59:22 -04:00
|
|
|
// in:body
|
|
|
|
EditTeamOption api.EditTeamOption
|
2017-11-13 02:02:25 -05:00
|
|
|
|
2018-06-12 10:59:22 -04:00
|
|
|
// in:body
|
2017-11-13 02:02:25 -05:00
|
|
|
AddTimeOption api.AddTimeOption
|
|
|
|
|
2018-06-12 10:59:22 -04:00
|
|
|
// in:body
|
2017-11-13 02:02:25 -05:00
|
|
|
CreateUserOption api.CreateUserOption
|
2019-04-17 12:06:35 -04:00
|
|
|
|
2018-06-12 10:59:22 -04:00
|
|
|
// in:body
|
|
|
|
EditUserOption api.EditUserOption
|
2017-11-13 02:02:25 -05:00
|
|
|
|
2018-06-12 10:59:22 -04:00
|
|
|
// in:body
|
2018-03-05 20:22:16 -05:00
|
|
|
EditAttachmentOptions api.EditAttachmentOptions
|
2019-04-17 12:06:35 -04:00
|
|
|
|
2023-05-29 05:41:35 -04:00
|
|
|
// in:body
|
|
|
|
ChangeFilesOptions api.ChangeFilesOptions
|
|
|
|
|
2019-04-17 12:06:35 -04:00
|
|
|
// in:body
|
|
|
|
CreateFileOptions api.CreateFileOptions
|
|
|
|
|
|
|
|
// in:body
|
|
|
|
UpdateFileOptions api.UpdateFileOptions
|
|
|
|
|
|
|
|
// in:body
|
|
|
|
DeleteFileOptions api.DeleteFileOptions
|
2019-09-03 11:46:24 -04:00
|
|
|
|
2019-12-23 21:33:52 -05:00
|
|
|
// in:body
|
|
|
|
CommitDateOptions api.CommitDateOptions
|
|
|
|
|
2019-09-03 11:46:24 -04:00
|
|
|
// in:body
|
|
|
|
RepoTopicOptions api.RepoTopicOptions
|
2019-12-31 03:21:21 -05:00
|
|
|
|
|
|
|
// in:body
|
|
|
|
EditReactionOption api.EditReactionOption
|
2020-02-12 18:19:35 -05:00
|
|
|
|
2020-05-29 14:16:20 -04:00
|
|
|
// in:body
|
|
|
|
CreateBranchRepoOption api.CreateBranchRepoOption
|
|
|
|
|
2020-02-12 18:19:35 -05:00
|
|
|
// in:body
|
|
|
|
CreateBranchProtectionOption api.CreateBranchProtectionOption
|
|
|
|
|
|
|
|
// in:body
|
|
|
|
EditBranchProtectionOption api.EditBranchProtectionOption
|
2020-02-29 01:19:32 -05:00
|
|
|
|
|
|
|
// in:body
|
|
|
|
CreateOAuth2ApplicationOptions api.CreateOAuth2ApplicationOptions
|
2020-05-01 20:20:51 -04:00
|
|
|
|
|
|
|
// in:body
|
|
|
|
CreatePullReviewOptions api.CreatePullReviewOptions
|
|
|
|
|
|
|
|
// in:body
|
|
|
|
CreatePullReviewComment api.CreatePullReviewComment
|
|
|
|
|
2024-01-09 06:49:18 -05:00
|
|
|
// in:body
|
|
|
|
CreatePullReviewCommentOptions api.CreatePullReviewCommentOptions
|
|
|
|
|
2020-05-01 20:20:51 -04:00
|
|
|
// in:body
|
|
|
|
SubmitPullReviewOptions api.SubmitPullReviewOptions
|
2020-09-10 18:29:19 -04:00
|
|
|
|
2021-02-11 12:32:25 -05:00
|
|
|
// in:body
|
|
|
|
DismissPullReviewOptions api.DismissPullReviewOptions
|
|
|
|
|
2020-09-10 18:29:19 -04:00
|
|
|
// in:body
|
|
|
|
MigrateRepoOptions api.MigrateRepoOptions
|
2020-10-20 14:18:25 -04:00
|
|
|
|
|
|
|
// in:body
|
|
|
|
PullReviewRequestOptions api.PullReviewRequestOptions
|
2021-06-17 12:04:10 -04:00
|
|
|
|
|
|
|
// in:body
|
|
|
|
CreateTagOption api.CreateTagOption
|
2021-06-23 15:58:44 -04:00
|
|
|
|
2024-06-14 12:56:10 -04:00
|
|
|
// in:body
|
|
|
|
CreateTagProtectionOption api.CreateTagProtectionOption
|
|
|
|
|
|
|
|
// in:body
|
|
|
|
EditTagProtectionOption api.EditTagProtectionOption
|
|
|
|
|
2021-08-01 16:44:15 -04:00
|
|
|
// in:body
|
|
|
|
CreateAccessTokenOption api.CreateAccessTokenOption
|
|
|
|
|
2021-06-23 15:58:44 -04:00
|
|
|
// in:body
|
|
|
|
UserSettingsOptions api.UserSettingsOptions
|
2021-10-24 23:43:40 -04:00
|
|
|
|
|
|
|
// in:body
|
|
|
|
CreateWikiPageOptions api.CreateWikiPageOptions
|
2022-07-30 12:45:59 -04:00
|
|
|
|
|
|
|
// in:body
|
|
|
|
CreatePushMirrorOption api.CreatePushMirrorOption
|
2023-06-29 19:22:55 -04:00
|
|
|
|
|
|
|
// in:body
|
|
|
|
UpdateUserAvatarOptions api.UpdateUserAvatarOption
|
|
|
|
|
|
|
|
// in:body
|
|
|
|
UpdateRepoAvatarOptions api.UpdateRepoAvatarOption
|
2023-08-21 23:20:34 -04:00
|
|
|
|
|
|
|
// in:body
|
2023-08-28 01:08:19 -04:00
|
|
|
CreateOrUpdateSecretOption api.CreateOrUpdateSecretOption
|
2024-03-28 16:40:35 -04:00
|
|
|
|
|
|
|
// in:body
|
|
|
|
CreateVariableOption api.CreateVariableOption
|
|
|
|
|
|
|
|
// in:body
|
|
|
|
UpdateVariableOption api.UpdateVariableOption
|
2024-06-28 01:17:11 -04:00
|
|
|
|
|
|
|
// in:body
|
|
|
|
DispatchWorkflowOption api.DispatchWorkflowOption
|
feat(quota): Humble beginnings of a quota engine
This is an implementation of a quota engine, and the API routes to
manage its settings. This does *not* contain any enforcement code: this
is just the bedrock, the engine itself.
The goal of the engine is to be flexible and future proof: to be nimble
enough to build on it further, without having to rewrite large parts of
it.
It might feel a little more complicated than necessary, because the goal
was to be able to support scenarios only very few Forgejo instances
need, scenarios the vast majority of mostly smaller instances simply do
not care about. The goal is to support both big and small, and for that,
we need a solid, flexible foundation.
There are thee big parts to the engine: counting quota use, setting
limits, and evaluating whether the usage is within the limits. Sounds
simple on paper, less so in practice!
Quota counting
==============
Quota is counted based on repo ownership, whenever possible, because
repo owners are in ultimate control over the resources they use: they
can delete repos, attachments, everything, even if they don't *own*
those themselves. They can clean up, and will always have the permission
and access required to do so. Would we count quota based on the owning
user, that could lead to situations where a user is unable to free up
space, because they uploaded a big attachment to a repo that has been
taken private since. It's both more fair, and much safer to count quota
against repo owners.
This means that if user A uploads an attachment to an issue opened
against organization O, that will count towards the quota of
organization O, rather than user A.
One's quota usage stats can be queried using the `/user/quota` API
endpoint. To figure out what's eating into it, the
`/user/repos?order_by=size`, `/user/quota/attachments`,
`/user/quota/artifacts`, and `/user/quota/packages` endpoints should be
consulted. There's also `/user/quota/check?subject=<...>` to check
whether the signed-in user is within a particular quota limit.
Quotas are counted based on sizes stored in the database.
Setting quota limits
====================
There are different "subjects" one can limit usage for. At this time,
only size-based limits are implemented, which are:
- `size:all`: As the name would imply, the total size of everything
Forgejo tracks.
- `size:repos:all`: The total size of all repositories (not including
LFS).
- `size:repos:public`: The total size of all public repositories (not
including LFS).
- `size:repos:private`: The total size of all private repositories (not
including LFS).
- `size:git:all`: The total size of all git data (including all
repositories, and LFS).
- `size:git:lfs`: The size of all git LFS data (either in private or
public repos).
- `size:assets:all`: The size of all assets tracked by Forgejo.
- `size:assets:attachments:all`: The size of all kinds of attachments
tracked by Forgejo.
- `size:assets:attachments:issues`: Size of all attachments attached to
issues, including issue comments.
- `size:assets:attachments:releases`: Size of all attachments attached
to releases. This does *not* include automatically generated archives.
- `size:assets:artifacts`: Size of all Action artifacts.
- `size:assets:packages:all`: Size of all Packages.
- `size:wiki`: Wiki size
Wiki size is currently not tracked, and the engine will always deem it
within quota.
These subjects are built into Rules, which set a limit on *all* subjects
within a rule. Thus, we can create a rule that says: "1Gb limit on all
release assets, all packages, and git LFS, combined". For a rule to
stand, the total sum of all subjects must be below the rule's limit.
Rules are in turn collected into groups. A group is just a name, and a
list of rules. For a group to stand, all of its rules must stand. Thus,
if we have a group with two rules, one that sets a combined 1Gb limit on
release assets, all packages, and git LFS, and another rule that sets a
256Mb limit on packages, if the user has 512Mb of packages, the group
will not stand, because the second rule deems it over quota. Similarly,
if the user has only 128Mb of packages, but 900Mb of release assets, the
group will not stand, because the combined size of packages and release
assets is over the 1Gb limit of the first rule.
Groups themselves are collected into Group Lists. A group list stands
when *any* of the groups within stand. This allows an administrator to
set conservative defaults, but then place select users into additional
groups that increase some aspect of their limits.
To top it off, it is possible to set the default quota groups a user
belongs to in `app.ini`. If there's no explicit assignment, the engine
will use the default groups. This makes it possible to avoid having to
assign each and every user a list of quota groups, and only those need
to be explicitly assigned who need a different set of groups than the
defaults.
If a user has any quota groups assigned to them, the default list will
not be considered for them.
The management APIs
===================
This commit contains the engine itself, its unit tests, and the quota
management APIs. It does not contain any enforcement.
The APIs are documented in-code, and in the swagger docs, and the
integration tests can serve as an example on how to use them.
Signed-off-by: Gergely Nagy <forgejo@gergo.csillger.hu>
2024-07-06 04:25:41 -04:00
|
|
|
|
|
|
|
// in:body
|
|
|
|
CreateQuotaGroupOptions api.CreateQuotaGroupOptions
|
|
|
|
|
|
|
|
// in:body
|
|
|
|
CreateQuotaRuleOptions api.CreateQuotaRuleOptions
|
|
|
|
|
|
|
|
// in:body
|
|
|
|
EditQuotaRuleOptions api.EditQuotaRuleOptions
|
|
|
|
|
|
|
|
// in:body
|
|
|
|
SetUserQuotaGroupsOptions api.SetUserQuotaGroupsOptions
|
2017-11-13 02:02:25 -05:00
|
|
|
}
|