tdsds.com/gitea
1
1
Fork 0
mirror of https://github.com/go-gitea/gitea synced 2025-07-28 05:08:37 +00:00
Code Releases Activity

Add a login/login-name/username disambiguation to affected endpoint parameters and response/request models (#34901)

Browse Source 
Issue: [link](https://github.com/go-gitea/gitea/issues/9637)

Changes introduced: I have clarified the problematic terms (`login`,
`login_name`, and `username`) in all affected endpoints.

The changes were made to relevant:
- HTTP endpoint parameters' descriptions 
- response/request models' fields
This commit is contained in:
AlexMaryW
2025-06-30 06:17:45 +02:00
committed by GitHub
parent 662db4a69c
commit f74a13610d
27 changed files with 131 additions and 112 deletions
Download Patch File Download Diff File Expand all files Collapse all files

119
templates/swagger/v1_json.tmpl generated
View File

@@ -766,7 +766,7 @@
},
{
"type": "string",
"description": "user's login name to search for",
"description": "identifier of the user, provided by the external authenticator",
"name": "login_name",
"in": "query"
},
@@ -842,7 +842,7 @@
"parameters": [
{
"type": "string",
"description": "username of user to delete",
"description": "username of the user to delete",
"name": "username",
"in": "path",
"required": true
@@ -884,7 +884,7 @@
"parameters": [
{
"type": "string",
"description": "username of user to edit",
"description": "username of the user whose data is to be edited",
"name": "username",
"in": "path",
"required": true
@@ -926,7 +926,7 @@
"parameters": [
{
"type": "string",
"description": "username of user",
"description": "username of the user whose badges are to be listed",
"name": "username",
"in": "path",
"required": true
@@ -956,7 +956,7 @@
"parameters": [
{
"type": "string",
"description": "username of user",
"description": "username of the user to whom a badge is to be added",
"name": "username",
"in": "path",
"required": true
@@ -990,7 +990,7 @@
"parameters": [
{
"type": "string",
"description": "username of user",
"description": "username of the user whose badge is to be deleted",
"name": "username",
"in": "path",
"required": true
@@ -1032,7 +1032,7 @@
"parameters": [
{
"type": "string",
"description": "username of the user",
"description": "username of the user who is to receive a public key",
"name": "username",
"in": "path",
"required": true
@@ -1071,7 +1071,7 @@
"parameters": [
{
"type": "string",
"description": "username of user",
"description": "username of the user whose public key is to be deleted",
"name": "username",
"in": "path",
"required": true
@@ -1114,7 +1114,7 @@
"parameters": [
{
"type": "string",
"description": "username of the user that will own the created organization",
"description": "username of the user who will own the created organization",
"name": "username",
"in": "path",
"required": true
@@ -1154,7 +1154,7 @@
"parameters": [
{
"type": "string",
"description": "existing username of user",
"description": "current username of the user",
"name": "username",
"in": "path",
"required": true
@@ -1197,7 +1197,7 @@
"parameters": [
{
"type": "string",
"description": "username of the user. This user will own the created repository",
"description": "username of the user who will own the created repository",
"name": "username",
"in": "path",
"required": true
@@ -2716,7 +2716,7 @@
},
{
"type": "string",
"description": "user to check",
"description": "username of the user to check",
"name": "username",
"in": "path",
"required": true
@@ -2747,7 +2747,7 @@
},
{
"type": "string",
"description": "user to block",
"description": "username of the user to block",
"name": "username",
"in": "path",
"required": true
@@ -2787,7 +2787,7 @@
},
{
"type": "string",
"description": "user to unblock",
"description": "username of the user to unblock",
"name": "username",
"in": "path",
"required": true
@@ -3258,7 +3258,7 @@
},
{
"type": "string",
"description": "username of the user",
"description": "username of the user to check for an organization membership",
"name": "username",
"in": "path",
"required": true
@@ -3295,7 +3295,7 @@
},
{
"type": "string",
"description": "username of the user",
"description": "username of the user to remove from the organization",
"name": "username",
"in": "path",
"required": true
@@ -3369,7 +3369,7 @@
},
{
"type": "string",
"description": "username of the user",
"description": "username of the user to check for a public organization membership",
"name": "username",
"in": "path",
"required": true
@@ -3403,7 +3403,7 @@
},
{
"type": "string",
"description": "username of the user",
"description": "username of the user whose membership is to be publicized",
"name": "username",
"in": "path",
"required": true
@@ -3440,7 +3440,7 @@
},
{
"type": "string",
"description": "username of the user",
"description": "username of the user whose membership is to be concealed",
"name": "username",
"in": "path",
"required": true
@@ -6930,7 +6930,7 @@
},
{
"type": "string",
"description": "username of the collaborator",
"description": "username of the user to check for being a collaborator",
"name": "collaborator",
"in": "path",
"required": true
@@ -6974,7 +6974,7 @@
},
{
"type": "string",
"description": "username of the collaborator to add",
"description": "username of the user to add or update as a collaborator",
"name": "collaborator",
"in": "path",
"required": true
@@ -7074,7 +7074,7 @@
},
{
"type": "string",
"description": "username of the collaborator",
"description": "username of the collaborator whose permissions are to be obtained",
"name": "collaborator",
"in": "path",
"required": true
@@ -11951,7 +11951,7 @@
},
{
"type": "string",
"description": "user to subscribe",
"description": "username of the user to subscribe the issue to",
"name": "user",
"in": "path",
"required": true
@@ -12009,7 +12009,7 @@
},
{
"type": "string",
"description": "user witch unsubscribe",
"description": "username of the user to unsubscribe from an issue",
"name": "user",
"in": "path",
"required": true
@@ -16821,7 +16821,7 @@
},
{
"type": "string",
"description": "username of user",
"description": "username of the user whose tracked times are to be listed",
"name": "user",
"in": "path",
"required": true
@@ -17844,7 +17844,7 @@
},
{
"type": "string",
"description": "username of the member to list",
"description": "username of the user whose data is to be listed",
"name": "username",
"in": "path",
"required": true
@@ -17879,7 +17879,7 @@
},
{
"type": "string",
"description": "username of the user to add",
"description": "username of the user to add to a team",
"name": "username",
"in": "path",
"required": true
@@ -17917,7 +17917,7 @@
},
{
"type": "string",
"description": "username of the user to remove",
"description": "username of the user to remove from a team",
"name": "username",
"in": "path",
"required": true
@@ -18896,7 +18896,7 @@
"parameters": [
{
"type": "string",
"description": "user to check",
"description": "username of the user to check",
"name": "username",
"in": "path",
"required": true
@@ -18920,7 +18920,7 @@
"parameters": [
{
"type": "string",
"description": "user to block",
"description": "username of the user to block",
"name": "username",
"in": "path",
"required": true
@@ -18953,7 +18953,7 @@
"parameters": [
{
"type": "string",
"description": "user to unblock",
"description": "username of the user to unblock",
"name": "username",
"in": "path",
"required": true
@@ -19115,7 +19115,7 @@
"parameters": [
{
"type": "string",
"description": "username of followed user",
"description": "username of the user to check for authenticated followers",
"name": "username",
"in": "path",
"required": true
@@ -19139,7 +19139,7 @@
"parameters": [
{
"type": "string",
"description": "username of user to follow",
"description": "username of the user to follow",
"name": "username",
"in": "path",
"required": true
@@ -19166,7 +19166,7 @@
"parameters": [
{
"type": "string",
"description": "username of user to unfollow",
"description": "username of the user to unfollow",
"name": "username",
"in": "path",
"required": true
@@ -20120,7 +20120,7 @@
"parameters": [
{
"type": "string",
"description": "username of user to get",
"description": "username of the user whose data is to be listed",
"name": "username",
"in": "path",
"required": true
@@ -20149,7 +20149,7 @@
"parameters": [
{
"type": "string",
"description": "username of user",
"description": "username of the user whose activity feeds are to be listed",
"name": "username",
"in": "path",
"required": true
@@ -20203,7 +20203,7 @@
"parameters": [
{
"type": "string",
"description": "username of user",
"description": "username of the user whose followers are to be listed",
"name": "username",
"in": "path",
"required": true
@@ -20244,7 +20244,7 @@
"parameters": [
{
"type": "string",
"description": "username of user",
"description": "username of the user whose followed users are to be listed",
"name": "username",
"in": "path",
"required": true
@@ -20282,14 +20282,14 @@
"parameters": [
{
"type": "string",
"description": "username of following user",
"description": "username of the following user",
"name": "username",
"in": "path",
"required": true
},
{
"type": "string",
"description": "username of followed user",
"description": "username of the followed user",
"name": "target",
"in": "path",
"required": true
@@ -20318,7 +20318,7 @@
"parameters": [
{
"type": "string",
"description": "username of user",
"description": "username of the user whose GPG key list is to be obtained",
"name": "username",
"in": "path",
"required": true
@@ -20359,7 +20359,7 @@
"parameters": [
{
"type": "string",
"description": "username of user to get",
"description": "username of the user whose heatmap is to be obtained",
"name": "username",
"in": "path",
"required": true
@@ -20388,7 +20388,7 @@
"parameters": [
{
"type": "string",
"description": "username of user",
"description": "username of the user whose public keys are to be listed",
"name": "username",
"in": "path",
"required": true
@@ -20435,7 +20435,7 @@
"parameters": [
{
"type": "string",
"description": "username of user",
"description": "username of the user whose organizations are to be listed",
"name": "username",
"in": "path",
"required": true
@@ -20476,7 +20476,7 @@
"parameters": [
{
"type": "string",
"description": "username of user",
"description": "username of the user whose permissions are to be obtained",
"name": "username",
"in": "path",
"required": true
@@ -20515,7 +20515,7 @@
"parameters": [
{
"type": "string",
"description": "username of user",
"description": "username of the user whose owned repos are to be listed",
"name": "username",
"in": "path",
"required": true
@@ -20556,7 +20556,7 @@
"parameters": [
{
"type": "string",
"description": "username of user",
"description": "username of the user whose starred repos are to be listed",
"name": "username",
"in": "path",
"required": true
@@ -20600,7 +20600,7 @@
"parameters": [
{
"type": "string",
"description": "username of the user",
"description": "username of the user whose watched repos are to be listed",
"name": "username",
"in": "path",
"required": true
@@ -20641,7 +20641,7 @@
"parameters": [
{
"type": "string",
"description": "username of user",
"description": "username of to user whose access tokens are to be listed",
"name": "username",
"in": "path",
"required": true
@@ -20683,7 +20683,7 @@
"parameters": [
{
"type": "string",
"description": "username of user",
"description": "username of the user whose token is to be created",
"name": "username",
"in": "path",
"required": true
@@ -20722,7 +20722,7 @@
"parameters": [
{
"type": "string",
"description": "username of user",
"description": "username of the user whose token is to be deleted",
"name": "username",
"in": "path",
"required": true
@@ -21523,7 +21523,7 @@
"x-go-name": "Time"
},
"user_name": {
"description": "User who spent the time (optional)",
"description": "username of the user who spent the time working on the issue (optional)",
"type": "string",
"x-go-name": "User"
}
@@ -23058,6 +23058,7 @@
"x-go-name": "RepoAdminChangeTeamAccess"
},
"username": {
"description": "username of the organization",
"type": "string",
"x-go-name": "UserName"
},
@@ -23508,7 +23509,9 @@
"x-go-name": "FullName"
},
"login_name": {
"description": "identifier of the user, provided by the external authenticator (if configured)",
"type": "string",
"default": "empty",
"x-go-name": "LoginName"
},
"must_change_password": {
@@ -23533,6 +23536,7 @@
"x-go-name": "SourceID"
},
"username": {
"description": "username of the user",
"type": "string",
"x-go-name": "Username"
},
@@ -24518,7 +24522,9 @@
"x-go-name": "Location"
},
"login_name": {
"description": "identifier of the user, provided by the external authenticator (if configured)",
"type": "string",
"default": "empty",
"x-go-name": "LoginName"
},
"max_repo_creation": {
@@ -24577,6 +24583,7 @@
"x-go-name": "UserID"
},
"username": {
"description": "username of the user",
"type": "string",
"x-go-name": "UserName"
},
@@ -26301,7 +26308,7 @@
"x-go-name": "RepoAdminChangeTeamAccess"
},
"username": {
"description": "deprecated",
"description": "username of the organization\ndeprecated",
"type": "string",
"x-go-name": "UserName"
},
@@ -26545,6 +26552,7 @@
"x-go-name": "Name"
},
"username": {
"description": "username of the user",
"type": "string",
"x-go-name": "UserName"
}
@@ -28008,6 +28016,7 @@
"x-go-name": "UserID"
},
"user_name": {
"description": "username of the user",
"type": "string",
"x-go-name": "UserName"
}
@@ -28249,12 +28258,12 @@
"x-go-name": "Location"
},
"login": {
"description": "the user's username",
"description": "login of the user, same as `username`",
"type": "string",
"x-go-name": "UserName"
},
"login_name": {
"description": "the user's authentication sign-in name.",
"description": "identifier of the user, provided by the external authenticator (if configured)",
"type": "string",
"default": "empty",
"x-go-name": "LoginName"