mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2025-10-15 19:42:04 +00:00
chore(api): update swagger method descripitons (#8728)
Speaking from personal experience, when exploring the API I find myself trying to parse the exact meaning of many descriptions for a while, and I also have to get used to many different kinds of inconsistencies and grammar issues. This PR improves a few of these. Some I tried to reword to make them easier to understand, for others I just improved consistency a little, like capitalization. This area needs more work, this PR just makes some progress. Anything that is improved in this one can be improved further in later PRs, so in review please focus on regressions if you find any. Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/8728 Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org> Co-authored-by: 0ko <0ko@noreply.codeberg.org> Co-committed-by: 0ko <0ko@noreply.codeberg.org>
This commit is contained in:
0ko
Gusted
parent
98e2a64e2d
commit
022ab86988
18 changed files with 113 additions and 113 deletions
82
templates/swagger/v1_json.tmpl
generated
82
templates/swagger/v1_json.tmpl
generated
|
|
@ -239,7 +239,7 @@
|
|||
"tags": [
|
||||
"admin"
|
||||
],
|
||||
"summary": "List all emails",
|
||||
"summary": "List all users' email addresses",
|
||||
"operationId": "adminGetAllEmails",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -273,7 +273,7 @@
|
|||
"tags": [
|
||||
"admin"
|
||||
],
|
||||
"summary": "Search all emails",
|
||||
"summary": "Search users' email addresses",
|
||||
"operationId": "adminSearchEmails",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -313,7 +313,7 @@
|
|||
"tags": [
|
||||
"admin"
|
||||
],
|
||||
"summary": "List system's webhooks",
|
||||
"summary": "List global (system) webhooks",
|
||||
"operationId": "adminListHooks",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -1220,7 +1220,7 @@
|
|||
"tags": [
|
||||
"admin"
|
||||
],
|
||||
"summary": "Create a user",
|
||||
"summary": "Create a user account",
|
||||
"operationId": "adminCreateUser",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -1255,7 +1255,7 @@
|
|||
"tags": [
|
||||
"admin"
|
||||
],
|
||||
"summary": "Delete a user",
|
||||
"summary": "Delete user account",
|
||||
"operationId": "adminDeleteUser",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -1342,7 +1342,7 @@
|
|||
"tags": [
|
||||
"admin"
|
||||
],
|
||||
"summary": "Add a public key on behalf of a user",
|
||||
"summary": "Add an SSH public key to user's account",
|
||||
"operationId": "adminCreatePublicKey",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -1381,7 +1381,7 @@
|
|||
"tags": [
|
||||
"admin"
|
||||
],
|
||||
"summary": "Delete a user's public key",
|
||||
"summary": "Remove a public key from user's account",
|
||||
"operationId": "adminDeleteUserPublicKey",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -2158,7 +2158,7 @@
|
|||
"tags": [
|
||||
"organization"
|
||||
],
|
||||
"summary": "Get list of organizations",
|
||||
"summary": "List all organizations",
|
||||
"operationId": "orgGetAll",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -2381,7 +2381,7 @@
|
|||
"tags": [
|
||||
"organization"
|
||||
],
|
||||
"summary": "List an organization's actions secrets",
|
||||
"summary": "List actions secrets of an organization",
|
||||
"operationId": "orgListActionsSecrets",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -2514,7 +2514,7 @@
|
|||
"tags": [
|
||||
"organization"
|
||||
],
|
||||
"summary": "Get an org-level variables list",
|
||||
"summary": "List variables of an organization",
|
||||
"operationId": "getOrgVariablesList",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -2558,7 +2558,7 @@
|
|||
"tags": [
|
||||
"organization"
|
||||
],
|
||||
"summary": "Get an org-level variable",
|
||||
"summary": "Get organization's variable by name",
|
||||
"operationId": "getOrgVariable",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -2598,7 +2598,7 @@
|
|||
"tags": [
|
||||
"organization"
|
||||
],
|
||||
"summary": "Update an org-level variable",
|
||||
"summary": "Update variable in organization",
|
||||
"operationId": "updateOrgVariable",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -2648,7 +2648,7 @@
|
|||
"tags": [
|
||||
"organization"
|
||||
],
|
||||
"summary": "Create an org-level variable",
|
||||
"summary": "Create a new variable in organization",
|
||||
"operationId": "createOrgVariable",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -2695,7 +2695,7 @@
|
|||
"tags": [
|
||||
"organization"
|
||||
],
|
||||
"summary": "Delete an org-level variable",
|
||||
"summary": "Delete organization's variable by name",
|
||||
"operationId": "deleteOrgVariable",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -2788,7 +2788,7 @@
|
|||
"tags": [
|
||||
"organization"
|
||||
],
|
||||
"summary": "Update Avatar",
|
||||
"summary": "Update an organization's avatar",
|
||||
"operationId": "orgUpdateAvatar",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -2822,7 +2822,7 @@
|
|||
"tags": [
|
||||
"organization"
|
||||
],
|
||||
"summary": "Delete Avatar",
|
||||
"summary": "Delete an organization's avatar. It will be replaced by a default one",
|
||||
"operationId": "orgDeleteAvatar",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -5730,7 +5730,7 @@
|
|||
"tags": [
|
||||
"repository"
|
||||
],
|
||||
"summary": "Update avatar",
|
||||
"summary": "Update a repository's avatar",
|
||||
"operationId": "repoUpdateAvatar",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -5771,7 +5771,7 @@
|
|||
"tags": [
|
||||
"repository"
|
||||
],
|
||||
"summary": "Delete avatar",
|
||||
"summary": "Delete a repository's avatar",
|
||||
"operationId": "repoDeleteAvatar",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -13690,7 +13690,7 @@
|
|||
"tags": [
|
||||
"repository"
|
||||
],
|
||||
"summary": "create review requests for a pull request",
|
||||
"summary": "Create review requests for a pull request",
|
||||
"operationId": "repoCreatePullReviewRequests",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -13743,7 +13743,7 @@
|
|||
"tags": [
|
||||
"repository"
|
||||
],
|
||||
"summary": "cancel review requests for a pull request",
|
||||
"summary": "Cancel review requests for a pull request",
|
||||
"operationId": "repoDeletePullReviewRequests",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -14558,7 +14558,7 @@
|
|||
"tags": [
|
||||
"repository"
|
||||
],
|
||||
"summary": "add a push mirror to the repository",
|
||||
"summary": "Set up a new push mirror in a repository",
|
||||
"operationId": "repoAddPushMirror",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -14702,7 +14702,7 @@
|
|||
"tags": [
|
||||
"repository"
|
||||
],
|
||||
"summary": "deletes a push mirror from a repository by remoteName",
|
||||
"summary": "Remove a push mirror from a repository by remoteName",
|
||||
"operationId": "repoDeletePushMirror",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -18026,12 +18026,12 @@
|
|||
"tags": [
|
||||
"repository"
|
||||
],
|
||||
"summary": "search topics via keyword",
|
||||
"summary": "Search for topics by keyword",
|
||||
"operationId": "topicSearch",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "keywords to search",
|
||||
"description": "keyword to search for",
|
||||
"name": "q",
|
||||
"in": "query",
|
||||
"required": true
|
||||
|
|
@ -18490,7 +18490,7 @@
|
|||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "creates a new OAuth2 application",
|
||||
"summary": "Creates a new OAuth2 application",
|
||||
"operationId": "userCreateOAuth2Application",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -18526,7 +18526,7 @@
|
|||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "get an OAuth2 Application",
|
||||
"summary": "Get an OAuth2 application",
|
||||
"operationId": "userGetOAuth2Application",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -18560,7 +18560,7 @@
|
|||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "delete an OAuth2 Application",
|
||||
"summary": "Delete an OAuth2 application",
|
||||
"operationId": "userDeleteOAuth2Application",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -18594,7 +18594,7 @@
|
|||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "update an OAuth2 Application, this includes regenerating the client secret",
|
||||
"summary": "Update an OAuth2 application, this includes regenerating the client secret",
|
||||
"operationId": "userUpdateOAuth2Application",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -18638,7 +18638,7 @@
|
|||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "Update Avatar",
|
||||
"summary": "Update avatar of the current user",
|
||||
"operationId": "userUpdateAvatar",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -18668,7 +18668,7 @@
|
|||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "Delete Avatar",
|
||||
"summary": "Delete avatar of the current user. It will be replaced by a default one",
|
||||
"operationId": "userDeleteAvatar",
|
||||
"responses": {
|
||||
"204": {
|
||||
|
|
@ -18691,7 +18691,7 @@
|
|||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "Blocks a user from the doer.",
|
||||
"summary": "Blocks a user from the doer",
|
||||
"operationId": "userBlockUser",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -18729,7 +18729,7 @@
|
|||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "List the authenticated user's email addresses",
|
||||
"summary": "List all email addresses of the current user",
|
||||
"operationId": "userListEmails",
|
||||
"responses": {
|
||||
"200": {
|
||||
|
|
@ -18750,7 +18750,7 @@
|
|||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "Add email addresses",
|
||||
"summary": "Add an email addresses to the current user's account",
|
||||
"operationId": "userAddEmail",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -18783,7 +18783,7 @@
|
|||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "Delete email addresses",
|
||||
"summary": "Delete email addresses from the current user's account",
|
||||
"operationId": "userDeleteEmail",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -19080,7 +19080,7 @@
|
|||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "Create a GPG key",
|
||||
"summary": "Add a GPG public key to current user's account",
|
||||
"operationId": "userCurrentPostGPGKey",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -19152,7 +19152,7 @@
|
|||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "Remove a GPG key",
|
||||
"summary": "Remove a GPG public key from current user's account",
|
||||
"operationId": "userCurrentDeleteGPGKey",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -19862,7 +19862,7 @@
|
|||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "Get user settings",
|
||||
"summary": "Get current user's account settings",
|
||||
"operationId": "getUserSettings",
|
||||
"responses": {
|
||||
"200": {
|
||||
|
|
@ -19883,7 +19883,7 @@
|
|||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "Update user settings",
|
||||
"summary": "Update settings in current user's account",
|
||||
"operationId": "updateUserSettings",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -20230,7 +20230,7 @@
|
|||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "Unblocks a user from the doer.",
|
||||
"summary": "Unblocks a user from the doer",
|
||||
"operationId": "userUnblockUser",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -20903,7 +20903,7 @@
|
|||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "Create an access token",
|
||||
"summary": "Generate an access token for the current user",
|
||||
"operationId": "userCreateToken",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -20945,7 +20945,7 @@
|
|||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "delete an access token",
|
||||
"summary": "Delete an access token from current user's account",
|
||||
"operationId": "userDeleteAccessToken",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue