Merge pull request 'Improve Swagger documentation for user endpoints' (#6050) from JakobDev/forgejo:userswagger into forgejo

Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/6050
Reviewed-by: Otto <otto@codeberg.org>
This commit is contained in:
Otto 2024-11-28 20:42:19 +00:00
commit 48b91fa31a
24 changed files with 704 additions and 3 deletions

View file

@ -17318,6 +17318,12 @@
"responses": {
"200": {
"$ref": "#/responses/User"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
}
}
}
@ -17335,6 +17341,12 @@
"responses": {
"200": {
"$ref": "#/responses/RegistrationToken"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
}
}
}
@ -17378,6 +17390,12 @@
"400": {
"$ref": "#/responses/error"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
},
"404": {
"$ref": "#/responses/notFound"
}
@ -17411,6 +17429,12 @@
"400": {
"$ref": "#/responses/error"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
},
"404": {
"$ref": "#/responses/notFound"
}
@ -17448,6 +17472,12 @@
"400": {
"$ref": "#/responses/error"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
},
"404": {
"$ref": "#/responses/notFound"
}
@ -17480,6 +17510,12 @@
"400": {
"$ref": "#/responses/error"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
},
"404": {
"$ref": "#/responses/notFound"
}
@ -17523,6 +17559,12 @@
"400": {
"$ref": "#/responses/error"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
},
"404": {
"$ref": "#/responses/notFound"
}
@ -17566,6 +17608,12 @@
"400": {
"$ref": "#/responses/error"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
},
"404": {
"$ref": "#/responses/notFound"
}
@ -17599,6 +17647,12 @@
"400": {
"$ref": "#/responses/error"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
},
"404": {
"$ref": "#/responses/notFound"
}
@ -17632,6 +17686,12 @@
"responses": {
"200": {
"$ref": "#/responses/OAuth2ApplicationList"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
}
}
},
@ -17660,6 +17720,12 @@
},
"400": {
"$ref": "#/responses/error"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
}
}
}
@ -17688,6 +17754,12 @@
"200": {
"$ref": "#/responses/OAuth2Application"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
},
"404": {
"$ref": "#/responses/notFound"
}
@ -17716,6 +17788,12 @@
"204": {
"$ref": "#/responses/empty"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
},
"404": {
"$ref": "#/responses/notFound"
}
@ -17752,6 +17830,12 @@
"200": {
"$ref": "#/responses/OAuth2Application"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
},
"404": {
"$ref": "#/responses/notFound"
}
@ -17780,6 +17864,12 @@
"responses": {
"204": {
"$ref": "#/responses/empty"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
}
}
},
@ -17795,6 +17885,12 @@
"responses": {
"204": {
"$ref": "#/responses/empty"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
}
}
}
@ -17822,6 +17918,12 @@
"204": {
"$ref": "#/responses/empty"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
},
"404": {
"$ref": "#/responses/notFound"
},
@ -17844,6 +17946,12 @@
"responses": {
"200": {
"$ref": "#/responses/EmailList"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
}
}
},
@ -17869,6 +17977,12 @@
"201": {
"$ref": "#/responses/EmailList"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
},
"422": {
"$ref": "#/responses/validationError"
}
@ -17896,6 +18010,12 @@
"204": {
"$ref": "#/responses/empty"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
},
"404": {
"$ref": "#/responses/notFound"
}
@ -17929,6 +18049,12 @@
"responses": {
"200": {
"$ref": "#/responses/UserList"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
}
}
}
@ -17960,6 +18086,12 @@
"responses": {
"200": {
"$ref": "#/responses/UserList"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
}
}
}
@ -17984,6 +18116,12 @@
"204": {
"$ref": "#/responses/empty"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
},
"404": {
"$ref": "#/responses/notFound"
}
@ -18008,6 +18146,9 @@
"204": {
"$ref": "#/responses/empty"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
},
@ -18035,6 +18176,12 @@
"204": {
"$ref": "#/responses/empty"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
},
"404": {
"$ref": "#/responses/notFound"
}
@ -18055,6 +18202,12 @@
"200": {
"$ref": "#/responses/string"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
},
"404": {
"$ref": "#/responses/notFound"
}
@ -18078,6 +18231,12 @@
"201": {
"$ref": "#/responses/GPGKey"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
},
"404": {
"$ref": "#/responses/notFound"
},
@ -18114,6 +18273,12 @@
"responses": {
"200": {
"$ref": "#/responses/GPGKeyList"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
}
}
},
@ -18142,6 +18307,12 @@
"201": {
"$ref": "#/responses/GPGKey"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
},
"404": {
"$ref": "#/responses/notFound"
},
@ -18175,6 +18346,12 @@
"200": {
"$ref": "#/responses/GPGKey"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
},
"404": {
"$ref": "#/responses/notFound"
}
@ -18203,6 +18380,9 @@
"204": {
"$ref": "#/responses/empty"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
},
@ -18239,6 +18419,12 @@
"responses": {
"200": {
"$ref": "#/responses/HookList"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
}
}
},
@ -18267,6 +18453,12 @@
"responses": {
"201": {
"$ref": "#/responses/Hook"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
}
}
}
@ -18294,6 +18486,12 @@
"responses": {
"200": {
"$ref": "#/responses/Hook"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
}
}
},
@ -18319,6 +18517,12 @@
"responses": {
"204": {
"$ref": "#/responses/empty"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
}
}
},
@ -18354,6 +18558,12 @@
"responses": {
"200": {
"$ref": "#/responses/Hook"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
}
}
}
@ -18391,6 +18601,12 @@
"responses": {
"200": {
"$ref": "#/responses/PublicKeyList"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
}
}
},
@ -18419,6 +18635,12 @@
"201": {
"$ref": "#/responses/PublicKey"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
},
"422": {
"$ref": "#/responses/validationError"
}
@ -18449,6 +18671,12 @@
"200": {
"$ref": "#/responses/PublicKey"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
},
"404": {
"$ref": "#/responses/notFound"
}
@ -18477,6 +18705,9 @@
"204": {
"$ref": "#/responses/empty"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
},
@ -18513,6 +18744,12 @@
"responses": {
"200": {
"$ref": "#/responses/BlockedUserList"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
}
}
}
@ -18545,6 +18782,12 @@
"200": {
"$ref": "#/responses/OrganizationList"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
},
"404": {
"$ref": "#/responses/notFound"
}
@ -18565,6 +18808,9 @@
"200": {
"$ref": "#/responses/QuotaInfo"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
}
@ -18599,6 +18845,9 @@
"200": {
"$ref": "#/responses/QuotaUsedArtifactList"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
}
@ -18633,6 +18882,9 @@
"200": {
"$ref": "#/responses/QuotaUsedAttachmentList"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
}
@ -18653,6 +18905,9 @@
"200": {
"$ref": "#/responses/boolean"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
},
@ -18690,6 +18945,9 @@
"200": {
"$ref": "#/responses/QuotaUsedPackageList"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
}
@ -18730,6 +18988,12 @@
"200": {
"$ref": "#/responses/RepositoryList"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
},
"422": {
"$ref": "#/responses/validationError"
}
@ -18764,6 +19028,12 @@
"400": {
"$ref": "#/responses/error"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
},
"409": {
"description": "The repository with the same name already exists."
},
@ -18789,6 +19059,12 @@
"responses": {
"200": {
"$ref": "#/responses/UserSettings"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
}
}
},
@ -18813,6 +19089,12 @@
"responses": {
"200": {
"$ref": "#/responses/UserSettings"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
}
}
}
@ -18844,6 +19126,12 @@
"responses": {
"200": {
"$ref": "#/responses/RepositoryList"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
}
}
}
@ -18875,6 +19163,12 @@
"204": {
"$ref": "#/responses/empty"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
},
"404": {
"$ref": "#/responses/notFound"
}
@ -18906,6 +19200,12 @@
"204": {
"$ref": "#/responses/empty"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
},
"404": {
"$ref": "#/responses/notFound"
}
@ -18937,6 +19237,12 @@
"204": {
"$ref": "#/responses/empty"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
},
"404": {
"$ref": "#/responses/notFound"
}
@ -18973,6 +19279,12 @@
"responses": {
"200": {
"$ref": "#/responses/StopWatchList"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
}
}
}
@ -19004,6 +19316,12 @@
"responses": {
"200": {
"$ref": "#/responses/RepositoryList"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
}
}
}
@ -19035,6 +19353,12 @@
"responses": {
"200": {
"$ref": "#/responses/TeamList"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
}
}
}
@ -19080,6 +19404,12 @@
"responses": {
"200": {
"$ref": "#/responses/TrackedTimeList"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
}
}
}
@ -19107,6 +19437,12 @@
"204": {
"$ref": "#/responses/empty"
},
"401": {
"$ref": "#/responses/unauthorized"
},
"403": {
"$ref": "#/responses/forbidden"
},
"404": {
"$ref": "#/responses/notFound"
},
@ -19729,6 +20065,9 @@
},
"403": {
"$ref": "#/responses/forbidden"
},
"404": {
"$ref": "#/responses/notFound"
}
}
},
@ -19769,6 +20108,9 @@
},
"403": {
"$ref": "#/responses/forbidden"
},
"404": {
"$ref": "#/responses/notFound"
}
}
}
@ -19915,6 +20257,20 @@
},
"x-go-package": "code.gitea.io/gitea/services/context"
},
"APIUnauthorizedError": {
"type": "object",
"properties": {
"message": {
"type": "string",
"x-go-name": "Message"
},
"url": {
"type": "string",
"x-go-name": "URL"
}
},
"x-go-package": "code.gitea.io/gitea/services/context"
},
"APIValidationError": {
"type": "object",
"properties": {
@ -28495,6 +28851,12 @@
"type": "string"
}
},
"unauthorized": {
"description": "APIUnauthorizedError is a unauthorized error response",
"schema": {
"$ref": "#/definitions/APIUnauthorizedError"
}
},
"validationError": {
"description": "APIValidationError is error format response related to input validation",
"schema": {