Synchronizing API and documentation updates

This commit is contained in:
gitnexbot
2025-07-01 00:05:14 +00:00
parent 7174da2f95
commit 81fe381fa4
28 changed files with 196 additions and 188 deletions
+1 -1
View File
@@ -5,4 +5,4 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**created** | [**Date**](Date.md) | | [optional]
**time** | **Long** | time in seconds |
**userName** | **String** | User who spent the time (optional) | [optional]
**userName** | **String** | username of the user who spent the time working on the issue (optional) | [optional]
+22 -22
View File
@@ -95,7 +95,7 @@ Token.setApiKey("YOUR API KEY");
//Token.setApiKeyPrefix("Token");
AdminApi apiInstance = new AdminApi();
String username = "username_example"; // String | username of user
String username = "username_example"; // String | username of the user to whom a badge is to be added
UserBadgeOption body = new UserBadgeOption(); // UserBadgeOption |
try {
Void result = apiInstance.adminAddUserBadges(username, body);
@@ -110,7 +110,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| username of user |
**username** | **String**| username of the user to whom a badge is to be added |
**body** | [**UserBadgeOption**](UserBadgeOption.md)| | [optional]
### Return type
@@ -361,7 +361,7 @@ Token.setApiKey("YOUR API KEY");
AdminApi apiInstance = new AdminApi();
CreateOrgOption body = new CreateOrgOption(); // CreateOrgOption |
String username = "username_example"; // String | username of the user that will own the created organization
String username = "username_example"; // String | username of the user who will own the created organization
try {
Organization result = apiInstance.adminCreateOrg(body, username);
System.out.println(result);
@@ -376,7 +376,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**CreateOrgOption**](CreateOrgOption.md)| |
**username** | **String**| username of the user that will own the created organization |
**username** | **String**| username of the user who will own the created organization |
### Return type
@@ -449,7 +449,7 @@ Token.setApiKey("YOUR API KEY");
//Token.setApiKeyPrefix("Token");
AdminApi apiInstance = new AdminApi();
String username = "username_example"; // String | username of the user
String username = "username_example"; // String | username of the user who is to receive a public key
CreateKeyOption body = new CreateKeyOption(); // CreateKeyOption |
try {
PublicKey result = apiInstance.adminCreatePublicKey(username, body);
@@ -464,7 +464,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| username of the user |
**username** | **String**| username of the user who is to receive a public key |
**body** | [**CreateKeyOption**](CreateKeyOption.md)| | [optional]
### Return type
@@ -539,7 +539,7 @@ Token.setApiKey("YOUR API KEY");
AdminApi apiInstance = new AdminApi();
CreateRepoOption body = new CreateRepoOption(); // CreateRepoOption |
String username = "username_example"; // String | username of the user. This user will own the created repository
String username = "username_example"; // String | username of the user who will own the created repository
try {
Repository result = apiInstance.adminCreateRepo(body, username);
System.out.println(result);
@@ -554,7 +554,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**CreateRepoOption**](CreateRepoOption.md)| |
**username** | **String**| username of the user. This user will own the created repository |
**username** | **String**| username of the user who will own the created repository |
### Return type
@@ -1149,7 +1149,7 @@ Token.setApiKey("YOUR API KEY");
//Token.setApiKeyPrefix("Token");
AdminApi apiInstance = new AdminApi();
String username = "username_example"; // String | username of user to delete
String username = "username_example"; // String | username of the user to delete
Boolean purge = true; // Boolean | purge the user from the system completely
try {
Void result = apiInstance.adminDeleteUser(username, purge);
@@ -1164,7 +1164,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| username of user to delete |
**username** | **String**| username of the user to delete |
**purge** | **Boolean**| purge the user from the system completely | [optional]
### Return type
@@ -1238,7 +1238,7 @@ Token.setApiKey("YOUR API KEY");
//Token.setApiKeyPrefix("Token");
AdminApi apiInstance = new AdminApi();
String username = "username_example"; // String | username of user
String username = "username_example"; // String | username of the user whose badge is to be deleted
UserBadgeOption body = new UserBadgeOption(); // UserBadgeOption |
try {
Void result = apiInstance.adminDeleteUserBadges(username, body);
@@ -1253,7 +1253,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| username of user |
**username** | **String**| username of the user whose badge is to be deleted |
**body** | [**UserBadgeOption**](UserBadgeOption.md)| | [optional]
### Return type
@@ -1327,7 +1327,7 @@ Token.setApiKey("YOUR API KEY");
//Token.setApiKeyPrefix("Token");
AdminApi apiInstance = new AdminApi();
String username = "username_example"; // String | username of user
String username = "username_example"; // String | username of the user whose public key is to be deleted
Long id = 789L; // Long | id of the key to delete
try {
Void result = apiInstance.adminDeleteUserPublicKey(username, id);
@@ -1342,7 +1342,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| username of user |
**username** | **String**| username of the user whose public key is to be deleted |
**id** | **Long**| id of the key to delete |
### Return type
@@ -1505,7 +1505,7 @@ Token.setApiKey("YOUR API KEY");
//Token.setApiKeyPrefix("Token");
AdminApi apiInstance = new AdminApi();
String username = "username_example"; // String | username of user to edit
String username = "username_example"; // String | username of the user whose data is to be edited
EditUserOption body = new EditUserOption(); // EditUserOption |
try {
User result = apiInstance.adminEditUser(username, body);
@@ -1520,7 +1520,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| username of user to edit |
**username** | **String**| username of the user whose data is to be edited |
**body** | [**EditUserOption**](EditUserOption.md)| | [optional]
### Return type
@@ -2033,7 +2033,7 @@ Token.setApiKey("YOUR API KEY");
//Token.setApiKeyPrefix("Token");
AdminApi apiInstance = new AdminApi();
String username = "username_example"; // String | username of user
String username = "username_example"; // String | username of the user whose badges are to be listed
try {
List<Badge> result = apiInstance.adminListUserBadges(username);
System.out.println(result);
@@ -2047,7 +2047,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| username of user |
**username** | **String**| username of the user whose badges are to be listed |
### Return type
@@ -2121,7 +2121,7 @@ Token.setApiKey("YOUR API KEY");
AdminApi apiInstance = new AdminApi();
RenameUserOption body = new RenameUserOption(); // RenameUserOption |
String username = "username_example"; // String | existing username of user
String username = "username_example"; // String | current username of the user
try {
Void result = apiInstance.adminRenameUser(body, username);
System.out.println(result);
@@ -2136,7 +2136,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**RenameUserOption**](RenameUserOption.md)| |
**username** | **String**| existing username of user |
**username** | **String**| current username of the user |
### Return type
@@ -2301,7 +2301,7 @@ Token.setApiKey("YOUR API KEY");
AdminApi apiInstance = new AdminApi();
Long sourceId = 789L; // Long | ID of the user's login source to search for
String loginName = "loginName_example"; // String | user's login name to search for
String loginName = "loginName_example"; // String | identifier of the user, provided by the external authenticator
Integer page = 56; // Integer | page number of results to return (1-based)
Integer limit = 56; // Integer | page size of results
try {
@@ -2318,7 +2318,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**sourceId** | **Long**| ID of the user&#x27;s login source to search for | [optional]
**loginName** | **String**| user&#x27;s login name to search for | [optional]
**loginName** | **String**| identifier of the user, provided by the external authenticator | [optional]
**page** | **Integer**| page number of results to return (1-based) | [optional]
**limit** | **Integer**| page size of results | [optional]
+1 -1
View File
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
**fullName** | **String** | | [optional]
**location** | **String** | | [optional]
**repoAdminChangeTeamAccess** | **Boolean** | | [optional]
**username** | **String** | |
**username** | **String** | username of the organization |
**visibility** | [**VisibilityEnum**](#VisibilityEnum) | possible values are &#x60;public&#x60; (default), &#x60;limited&#x60; or &#x60;private&#x60; | [optional]
**website** | **String** | | [optional]
+2 -2
View File
@@ -6,11 +6,11 @@ Name | Type | Description | Notes
**createdAt** | [**Date**](Date.md) | For explicitly setting the user creation timestamp. Useful when users are migrated from other systems. When omitted, the user&#x27;s creation timestamp will be set to \&quot;now\&quot;. | [optional]
**email** | **String** | |
**fullName** | **String** | | [optional]
**loginName** | **String** | | [optional]
**loginName** | **String** | identifier of the user, provided by the external authenticator (if configured) | [optional]
**mustChangePassword** | **Boolean** | | [optional]
**password** | **String** | | [optional]
**restricted** | **Boolean** | | [optional]
**sendNotify** | **Boolean** | | [optional]
**sourceId** | **Long** | | [optional]
**username** | **String** | |
**username** | **String** | username of the user |
**visibility** | **String** | | [optional]
+1 -1
View File
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
**email** | **String** | | [optional]
**fullName** | **String** | | [optional]
**location** | **String** | | [optional]
**loginName** | **String** | |
**loginName** | **String** | identifier of the user, provided by the external authenticator (if configured) |
**maxRepoCreation** | **Long** | | [optional]
**mustChangePassword** | **Boolean** | | [optional]
**password** | **String** | | [optional]
+1 -1
View File
@@ -6,5 +6,5 @@ Name | Type | Description | Notes
**email** | **String** | | [optional]
**primary** | **Boolean** | | [optional]
**userId** | **Long** | | [optional]
**username** | **String** | | [optional]
**username** | **String** | username of the user | [optional]
**verified** | **Boolean** | | [optional]
+4 -4
View File
@@ -228,7 +228,7 @@ IssueApi apiInstance = new IssueApi();
String owner = "owner_example"; // String | owner of the repo
String repo = "repo_example"; // String | name of the repo
Long index = 789L; // Long | index of the issue
String user = "user_example"; // String | user to subscribe
String user = "user_example"; // String | username of the user to subscribe the issue to
try {
Void result = apiInstance.issueAddSubscription(owner, repo, index, user);
System.out.println(result);
@@ -245,7 +245,7 @@ Name | Type | Description | Notes
**owner** | **String**| owner of the repo |
**repo** | **String**| name of the repo |
**index** | **Long**| index of the issue |
**user** | **String**| user to subscribe |
**user** | **String**| username of the user to subscribe the issue to |
### Return type
@@ -2258,7 +2258,7 @@ IssueApi apiInstance = new IssueApi();
String owner = "owner_example"; // String | owner of the repo
String repo = "repo_example"; // String | name of the repo
Long index = 789L; // Long | index of the issue
String user = "user_example"; // String | user witch unsubscribe
String user = "user_example"; // String | username of the user to unsubscribe from an issue
try {
Void result = apiInstance.issueDeleteSubscription(owner, repo, index, user);
System.out.println(result);
@@ -2275,7 +2275,7 @@ Name | Type | Description | Notes
**owner** | **String**| owner of the repo |
**repo** | **String**| name of the repo |
**index** | **Long**| index of the issue |
**user** | **String**| user witch unsubscribe |
**user** | **String**| username of the user to unsubscribe from an issue |
### Return type
+1 -1
View File
@@ -11,6 +11,6 @@ Name | Type | Description | Notes
**location** | **String** | | [optional]
**name** | **String** | | [optional]
**repoAdminChangeTeamAccess** | **Boolean** | | [optional]
**username** | **String** | deprecated | [optional]
**username** | **String** | username of the organization deprecated | [optional]
**visibility** | **String** | | [optional]
**website** | **String** | | [optional]
+26 -26
View File
@@ -1216,7 +1216,7 @@ Token.setApiKey("YOUR API KEY");
OrganizationApi apiInstance = new OrganizationApi();
Long id = 789L; // Long | id of the team
String username = "username_example"; // String | username of the user to add
String username = "username_example"; // String | username of the user to add to a team
try {
Void result = apiInstance.orgAddTeamMember(id, username);
System.out.println(result);
@@ -1231,7 +1231,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **Long**| id of the team |
**username** | **String**| username of the user to add |
**username** | **String**| username of the user to add to a team |
### Return type
@@ -1396,7 +1396,7 @@ Token.setApiKey("YOUR API KEY");
OrganizationApi apiInstance = new OrganizationApi();
String org = "org_example"; // String | name of the organization
String username = "username_example"; // String | username of the user
String username = "username_example"; // String | username of the user whose membership is to be concealed
try {
Void result = apiInstance.orgConcealMember(org, username);
System.out.println(result);
@@ -1411,7 +1411,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**org** | **String**| name of the organization |
**username** | **String**| username of the user |
**username** | **String**| username of the user whose membership is to be concealed |
### Return type
@@ -2278,7 +2278,7 @@ Token.setApiKey("YOUR API KEY");
OrganizationApi apiInstance = new OrganizationApi();
String org = "org_example"; // String | name of the organization
String username = "username_example"; // String | username of the user
String username = "username_example"; // String | username of the user to remove from the organization
try {
Void result = apiInstance.orgDeleteMember(org, username);
System.out.println(result);
@@ -2293,7 +2293,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**org** | **String**| name of the organization |
**username** | **String**| username of the user |
**username** | **String**| username of the user to remove from the organization |
### Return type
@@ -3341,7 +3341,7 @@ Token.setApiKey("YOUR API KEY");
//Token.setApiKeyPrefix("Token");
OrganizationApi apiInstance = new OrganizationApi();
String username = "username_example"; // String | username of user
String username = "username_example"; // String | username of the user whose permissions are to be obtained
String org = "org_example"; // String | name of the organization
try {
OrganizationPermissions result = apiInstance.orgGetUserPermissions(username, org);
@@ -3356,7 +3356,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| username of user |
**username** | **String**| username of the user whose permissions are to be obtained |
**org** | **String**| name of the organization |
### Return type
@@ -3431,7 +3431,7 @@ Token.setApiKey("YOUR API KEY");
OrganizationApi apiInstance = new OrganizationApi();
String org = "org_example"; // String | name of the organization
String username = "username_example"; // String | username of the user
String username = "username_example"; // String | username of the user to check for an organization membership
try {
Void result = apiInstance.orgIsMember(org, username);
System.out.println(result);
@@ -3446,7 +3446,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**org** | **String**| name of the organization |
**username** | **String**| username of the user |
**username** | **String**| username of the user to check for an organization membership |
### Return type
@@ -3520,7 +3520,7 @@ Token.setApiKey("YOUR API KEY");
OrganizationApi apiInstance = new OrganizationApi();
String org = "org_example"; // String | name of the organization
String username = "username_example"; // String | username of the user
String username = "username_example"; // String | username of the user to check for a public organization membership
try {
Void result = apiInstance.orgIsPublicMember(org, username);
System.out.println(result);
@@ -3535,7 +3535,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**org** | **String**| name of the organization |
**username** | **String**| username of the user |
**username** | **String**| username of the user to check for a public organization membership |
### Return type
@@ -4430,7 +4430,7 @@ Token.setApiKey("YOUR API KEY");
OrganizationApi apiInstance = new OrganizationApi();
Long id = 789L; // Long | id of the team
String username = "username_example"; // String | username of the member to list
String username = "username_example"; // String | username of the user whose data is to be listed
try {
User result = apiInstance.orgListTeamMember(id, username);
System.out.println(result);
@@ -4445,7 +4445,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **Long**| id of the team |
**username** | **String**| username of the member to list |
**username** | **String**| username of the user whose data is to be listed |
### Return type
@@ -4882,7 +4882,7 @@ Token.setApiKey("YOUR API KEY");
//Token.setApiKeyPrefix("Token");
OrganizationApi apiInstance = new OrganizationApi();
String username = "username_example"; // String | username of user
String username = "username_example"; // String | username of the user whose organizations are to be listed
Integer page = 56; // Integer | page number of results to return (1-based)
Integer limit = 56; // Integer | page size of results
try {
@@ -4898,7 +4898,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| username of user |
**username** | **String**| username of the user whose organizations are to be listed |
**page** | **Integer**| page number of results to return (1-based) | [optional]
**limit** | **Integer**| page size of results | [optional]
@@ -4974,7 +4974,7 @@ Token.setApiKey("YOUR API KEY");
OrganizationApi apiInstance = new OrganizationApi();
String org = "org_example"; // String | name of the organization
String username = "username_example"; // String | username of the user
String username = "username_example"; // String | username of the user whose membership is to be publicized
try {
Void result = apiInstance.orgPublicizeMember(org, username);
System.out.println(result);
@@ -4989,7 +4989,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**org** | **String**| name of the organization |
**username** | **String**| username of the user |
**username** | **String**| username of the user whose membership is to be publicized |
### Return type
@@ -5063,7 +5063,7 @@ Token.setApiKey("YOUR API KEY");
OrganizationApi apiInstance = new OrganizationApi();
Long id = 789L; // Long | id of the team
String username = "username_example"; // String | username of the user to remove
String username = "username_example"; // String | username of the user to remove from a team
try {
Void result = apiInstance.orgRemoveTeamMember(id, username);
System.out.println(result);
@@ -5078,7 +5078,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **Long**| id of the team |
**username** | **String**| username of the user to remove |
**username** | **String**| username of the user to remove from a team |
### Return type
@@ -5334,7 +5334,7 @@ Token.setApiKey("YOUR API KEY");
OrganizationApi apiInstance = new OrganizationApi();
String org = "org_example"; // String | name of the organization
String username = "username_example"; // String | user to block
String username = "username_example"; // String | username of the user to block
String note = "note_example"; // String | optional note for the block
try {
Void result = apiInstance.organizationBlockUser(org, username, note);
@@ -5350,7 +5350,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**org** | **String**| name of the organization |
**username** | **String**| user to block |
**username** | **String**| username of the user to block |
**note** | **String**| optional note for the block | [optional]
### Return type
@@ -5425,7 +5425,7 @@ Token.setApiKey("YOUR API KEY");
OrganizationApi apiInstance = new OrganizationApi();
String org = "org_example"; // String | name of the organization
String username = "username_example"; // String | user to check
String username = "username_example"; // String | username of the user to check
try {
Void result = apiInstance.organizationCheckUserBlock(org, username);
System.out.println(result);
@@ -5440,7 +5440,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**org** | **String**| name of the organization |
**username** | **String**| user to check |
**username** | **String**| username of the user to check |
### Return type
@@ -5605,7 +5605,7 @@ Token.setApiKey("YOUR API KEY");
OrganizationApi apiInstance = new OrganizationApi();
String org = "org_example"; // String | name of the organization
String username = "username_example"; // String | user to unblock
String username = "username_example"; // String | username of the user to unblock
try {
Void result = apiInstance.organizationUnblockUser(org, username);
System.out.println(result);
@@ -5620,7 +5620,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**org** | **String**| name of the organization |
**username** | **String**| user to unblock |
**username** | **String**| username of the user to unblock |
### Return type
+1 -1
View File
@@ -5,4 +5,4 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**email** | **String** | | [optional]
**name** | **String** | Full name of the commit author | [optional]
**username** | **String** | | [optional]
**username** | **String** | username of the user | [optional]
+8 -8
View File
@@ -3469,7 +3469,7 @@ Token.setApiKey("YOUR API KEY");
RepositoryApi apiInstance = new RepositoryApi();
String owner = "owner_example"; // String | owner of the repo
String repo = "repo_example"; // String | name of the repo
String collaborator = "collaborator_example"; // String | username of the collaborator to add
String collaborator = "collaborator_example"; // String | username of the user to add or update as a collaborator
AddCollaboratorOption body = new AddCollaboratorOption(); // AddCollaboratorOption |
try {
Void result = apiInstance.repoAddCollaborator(owner, repo, collaborator, body);
@@ -3486,7 +3486,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**owner** | **String**| owner of the repo |
**repo** | **String**| name of the repo |
**collaborator** | **String**| username of the collaborator to add |
**collaborator** | **String**| username of the user to add or update as a collaborator |
**body** | [**AddCollaboratorOption**](AddCollaboratorOption.md)| | [optional]
### Return type
@@ -4108,7 +4108,7 @@ Token.setApiKey("YOUR API KEY");
RepositoryApi apiInstance = new RepositoryApi();
String owner = "owner_example"; // String | owner of the repo
String repo = "repo_example"; // String | name of the repo
String collaborator = "collaborator_example"; // String | username of the collaborator
String collaborator = "collaborator_example"; // String | username of the user to check for being a collaborator
try {
Void result = apiInstance.repoCheckCollaborator(owner, repo, collaborator);
System.out.println(result);
@@ -4124,7 +4124,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**owner** | **String**| owner of the repo |
**repo** | **String**| name of the repo |
**collaborator** | **String**| username of the collaborator |
**collaborator** | **String**| username of the user to check for being a collaborator |
### Return type
@@ -12129,7 +12129,7 @@ Token.setApiKey("YOUR API KEY");
RepositoryApi apiInstance = new RepositoryApi();
String owner = "owner_example"; // String | owner of the repo
String repo = "repo_example"; // String | name of the repo
String collaborator = "collaborator_example"; // String | username of the collaborator
String collaborator = "collaborator_example"; // String | username of the collaborator whose permissions are to be obtained
try {
RepoCollaboratorPermission result = apiInstance.repoGetRepoPermissions(owner, repo, collaborator);
System.out.println(result);
@@ -12145,7 +12145,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**owner** | **String**| owner of the repo |
**repo** | **String**| name of the repo |
**collaborator** | **String**| username of the collaborator |
**collaborator** | **String**| username of the collaborator whose permissions are to be obtained |
### Return type
@@ -17865,7 +17865,7 @@ Token.setApiKey("YOUR API KEY");
RepositoryApi apiInstance = new RepositoryApi();
String owner = "owner_example"; // String | owner of the repo
String repo = "repo_example"; // String | name of the repo
String user = "user_example"; // String | username of user
String user = "user_example"; // String | username of the user whose tracked times are to be listed
try {
List<TrackedTime> result = apiInstance.userTrackedTimes(owner, repo, user);
System.out.println(result);
@@ -17881,7 +17881,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**owner** | **String**| owner of the repo |
**repo** | **String**| name of the repo |
**user** | **String**| username of user |
**user** | **String**| username of the user whose tracked times are to be listed |
### Return type
+1 -1
View File
@@ -9,4 +9,4 @@ Name | Type | Description | Notes
**issueId** | **Long** | deprecated (only for backwards compatibility) | [optional]
**time** | **Long** | Time in seconds | [optional]
**userId** | **Long** | deprecated (only for backwards compatibility) | [optional]
**userName** | **String** | | [optional]
**userName** | **String** | username of the user | [optional]
+2 -2
View File
@@ -17,8 +17,8 @@ Name | Type | Description | Notes
**language** | **String** | User locale | [optional]
**lastLogin** | [**Date**](Date.md) | | [optional]
**location** | **String** | the user&#x27;s location | [optional]
**login** | **String** | the user&#x27;s username | [optional]
**loginName** | **String** | the user&#x27;s authentication sign-in name. | [optional]
**login** | **String** | login of the user, same as &#x60;username&#x60; | [optional]
**loginName** | **String** | identifier of the user, provided by the external authenticator (if configured) | [optional]
**prohibitLogin** | **Boolean** | Is user login prohibited | [optional]
**restricted** | **Boolean** | Is user restricted | [optional]
**sourceId** | **Long** | The ID of the user&#x27;s Authentication Source | [optional]
+42 -42
View File
@@ -1630,7 +1630,7 @@ Token.setApiKey("YOUR API KEY");
//Token.setApiKeyPrefix("Token");
UserApi apiInstance = new UserApi();
String username = "username_example"; // String | user to block
String username = "username_example"; // String | username of the user to block
String note = "note_example"; // String | optional note for the block
try {
Void result = apiInstance.userBlockUser(username, note);
@@ -1645,7 +1645,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| user to block |
**username** | **String**| username of the user to block |
**note** | **String**| optional note for the block | [optional]
### Return type
@@ -1719,8 +1719,8 @@ Token.setApiKey("YOUR API KEY");
//Token.setApiKeyPrefix("Token");
UserApi apiInstance = new UserApi();
String username = "username_example"; // String | username of following user
String target = "target_example"; // String | username of followed user
String username = "username_example"; // String | username of the following user
String target = "target_example"; // String | username of the followed user
try {
Void result = apiInstance.userCheckFollowing(username, target);
System.out.println(result);
@@ -1734,8 +1734,8 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| username of following user |
**target** | **String**| username of followed user |
**username** | **String**| username of the following user |
**target** | **String**| username of the followed user |
### Return type
@@ -1808,7 +1808,7 @@ Token.setApiKey("YOUR API KEY");
//Token.setApiKeyPrefix("Token");
UserApi apiInstance = new UserApi();
String username = "username_example"; // String | user to check
String username = "username_example"; // String | username of the user to check
try {
Void result = apiInstance.userCheckUserBlock(username);
System.out.println(result);
@@ -1822,7 +1822,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| user to check |
**username** | **String**| username of the user to check |
### Return type
@@ -2152,7 +2152,7 @@ Token.setApiKey("YOUR API KEY");
//Token.setApiKeyPrefix("Token");
UserApi apiInstance = new UserApi();
String username = "username_example"; // String | username of user
String username = "username_example"; // String | username of the user whose token is to be created
CreateAccessTokenOption body = new CreateAccessTokenOption(); // CreateAccessTokenOption |
try {
AccessToken result = apiInstance.userCreateToken(username, body);
@@ -2167,7 +2167,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| username of user |
**username** | **String**| username of the user whose token is to be created |
**body** | [**CreateAccessTokenOption**](CreateAccessTokenOption.md)| | [optional]
### Return type
@@ -2241,7 +2241,7 @@ Token.setApiKey("YOUR API KEY");
//Token.setApiKeyPrefix("Token");
UserApi apiInstance = new UserApi();
String username = "username_example"; // String | username of followed user
String username = "username_example"; // String | username of the user to check for authenticated followers
try {
Void result = apiInstance.userCurrentCheckFollowing(username);
System.out.println(result);
@@ -2255,7 +2255,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| username of followed user |
**username** | **String**| username of the user to check for authenticated followers |
### Return type
@@ -2417,7 +2417,7 @@ Token.setApiKey("YOUR API KEY");
//Token.setApiKeyPrefix("Token");
UserApi apiInstance = new UserApi();
String username = "username_example"; // String | username of user to unfollow
String username = "username_example"; // String | username of the user to unfollow
try {
Void result = apiInstance.userCurrentDeleteFollow(username);
System.out.println(result);
@@ -2431,7 +2431,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| username of user to unfollow |
**username** | **String**| username of the user to unfollow |
### Return type
@@ -3740,7 +3740,7 @@ Token.setApiKey("YOUR API KEY");
//Token.setApiKeyPrefix("Token");
UserApi apiInstance = new UserApi();
String username = "username_example"; // String | username of user to follow
String username = "username_example"; // String | username of the user to follow
try {
Void result = apiInstance.userCurrentPutFollow(username);
System.out.println(result);
@@ -3754,7 +3754,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| username of user to follow |
**username** | **String**| username of the user to follow |
### Return type
@@ -4009,7 +4009,7 @@ Token.setApiKey("YOUR API KEY");
//Token.setApiKeyPrefix("Token");
UserApi apiInstance = new UserApi();
String username = "username_example"; // String | username of user
String username = "username_example"; // String | username of the user whose token is to be deleted
String token = "token_example"; // String | token to be deleted, identified by ID and if not available by name
try {
Void result = apiInstance.userDeleteAccessToken(username, token);
@@ -4024,7 +4024,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| username of user |
**username** | **String**| username of the user whose token is to be deleted |
**token** | **String**| token to be deleted, identified by ID and if not available by name |
### Return type
@@ -4531,7 +4531,7 @@ Token.setApiKey("YOUR API KEY");
//Token.setApiKeyPrefix("Token");
UserApi apiInstance = new UserApi();
String username = "username_example"; // String | username of user to get
String username = "username_example"; // String | username of the user whose data is to be listed
try {
User result = apiInstance.userGet(username);
System.out.println(result);
@@ -4545,7 +4545,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| username of user to get |
**username** | **String**| username of the user whose data is to be listed |
### Return type
@@ -4701,7 +4701,7 @@ Token.setApiKey("YOUR API KEY");
//Token.setApiKeyPrefix("Token");
UserApi apiInstance = new UserApi();
String username = "username_example"; // String | username of user to get
String username = "username_example"; // String | username of the user whose heatmap is to be obtained
try {
List<UserHeatmapData> result = apiInstance.userGetHeatmapData(username);
System.out.println(result);
@@ -4715,7 +4715,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| username of user to get |
**username** | **String**| username of the user whose heatmap is to be obtained |
### Return type
@@ -5223,7 +5223,7 @@ Token.setApiKey("YOUR API KEY");
//Token.setApiKeyPrefix("Token");
UserApi apiInstance = new UserApi();
String username = "username_example"; // String | username of user
String username = "username_example"; // String | username of to user whose access tokens are to be listed
Integer page = 56; // Integer | page number of results to return (1-based)
Integer limit = 56; // Integer | page size of results
try {
@@ -5239,7 +5239,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| username of user |
**username** | **String**| username of to user whose access tokens are to be listed |
**page** | **Integer**| page number of results to return (1-based) | [optional]
**limit** | **Integer**| page size of results | [optional]
@@ -5314,7 +5314,7 @@ Token.setApiKey("YOUR API KEY");
//Token.setApiKeyPrefix("Token");
UserApi apiInstance = new UserApi();
String username = "username_example"; // String | username of user
String username = "username_example"; // String | username of the user whose activity feeds are to be listed
Boolean onlyPerformedBy = true; // Boolean | if true, only show actions performed by the requested user
Date date = new Date(); // Date | the date of the activities to be found
Integer page = 56; // Integer | page number of results to return (1-based)
@@ -5332,7 +5332,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| username of user |
**username** | **String**| username of the user whose activity feeds are to be listed |
**onlyPerformedBy** | **Boolean**| if true, only show actions performed by the requested user | [optional]
**date** | **Date**| the date of the activities to be found | [optional]
**page** | **Integer**| page number of results to return (1-based) | [optional]
@@ -5581,7 +5581,7 @@ Token.setApiKey("YOUR API KEY");
//Token.setApiKeyPrefix("Token");
UserApi apiInstance = new UserApi();
String username = "username_example"; // String | username of user
String username = "username_example"; // String | username of the user whose followers are to be listed
Integer page = 56; // Integer | page number of results to return (1-based)
Integer limit = 56; // Integer | page size of results
try {
@@ -5597,7 +5597,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| username of user |
**username** | **String**| username of the user whose followers are to be listed |
**page** | **Integer**| page number of results to return (1-based) | [optional]
**limit** | **Integer**| page size of results | [optional]
@@ -5672,7 +5672,7 @@ Token.setApiKey("YOUR API KEY");
//Token.setApiKeyPrefix("Token");
UserApi apiInstance = new UserApi();
String username = "username_example"; // String | username of user
String username = "username_example"; // String | username of the user whose followed users are to be listed
Integer page = 56; // Integer | page number of results to return (1-based)
Integer limit = 56; // Integer | page size of results
try {
@@ -5688,7 +5688,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| username of user |
**username** | **String**| username of the user whose followed users are to be listed |
**page** | **Integer**| page number of results to return (1-based) | [optional]
**limit** | **Integer**| page size of results | [optional]
@@ -5763,7 +5763,7 @@ Token.setApiKey("YOUR API KEY");
//Token.setApiKeyPrefix("Token");
UserApi apiInstance = new UserApi();
String username = "username_example"; // String | username of user
String username = "username_example"; // String | username of the user whose GPG key list is to be obtained
Integer page = 56; // Integer | page number of results to return (1-based)
Integer limit = 56; // Integer | page size of results
try {
@@ -5779,7 +5779,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| username of user |
**username** | **String**| username of the user whose GPG key list is to be obtained |
**page** | **Integer**| page number of results to return (1-based) | [optional]
**limit** | **Integer**| page size of results | [optional]
@@ -5943,7 +5943,7 @@ Token.setApiKey("YOUR API KEY");
//Token.setApiKeyPrefix("Token");
UserApi apiInstance = new UserApi();
String username = "username_example"; // String | username of user
String username = "username_example"; // String | username of the user whose public keys are to be listed
String fingerprint = "fingerprint_example"; // String | fingerprint of the key
Integer page = 56; // Integer | page number of results to return (1-based)
Integer limit = 56; // Integer | page size of results
@@ -5960,7 +5960,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| username of user |
**username** | **String**| username of the user whose public keys are to be listed |
**fingerprint** | **String**| fingerprint of the key | [optional]
**page** | **Integer**| page number of results to return (1-based) | [optional]
**limit** | **Integer**| page size of results | [optional]
@@ -6036,7 +6036,7 @@ Token.setApiKey("YOUR API KEY");
//Token.setApiKeyPrefix("Token");
UserApi apiInstance = new UserApi();
String username = "username_example"; // String | username of user
String username = "username_example"; // String | username of the user whose owned repos are to be listed
Integer page = 56; // Integer | page number of results to return (1-based)
Integer limit = 56; // Integer | page size of results
try {
@@ -6052,7 +6052,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| username of user |
**username** | **String**| username of the user whose owned repos are to be listed |
**page** | **Integer**| page number of results to return (1-based) | [optional]
**limit** | **Integer**| page size of results | [optional]
@@ -6127,7 +6127,7 @@ Token.setApiKey("YOUR API KEY");
//Token.setApiKeyPrefix("Token");
UserApi apiInstance = new UserApi();
String username = "username_example"; // String | username of user
String username = "username_example"; // String | username of the user whose starred repos are to be listed
Integer page = 56; // Integer | page number of results to return (1-based)
Integer limit = 56; // Integer | page size of results
try {
@@ -6143,7 +6143,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| username of user |
**username** | **String**| username of the user whose starred repos are to be listed |
**page** | **Integer**| page number of results to return (1-based) | [optional]
**limit** | **Integer**| page size of results | [optional]
@@ -6218,7 +6218,7 @@ Token.setApiKey("YOUR API KEY");
//Token.setApiKeyPrefix("Token");
UserApi apiInstance = new UserApi();
String username = "username_example"; // String | username of the user
String username = "username_example"; // String | username of the user whose watched repos are to be listed
Integer page = 56; // Integer | page number of results to return (1-based)
Integer limit = 56; // Integer | page size of results
try {
@@ -6234,7 +6234,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| username of the user |
**username** | **String**| username of the user whose watched repos are to be listed |
**page** | **Integer**| page number of results to return (1-based) | [optional]
**limit** | **Integer**| page size of results | [optional]
@@ -6491,7 +6491,7 @@ Token.setApiKey("YOUR API KEY");
//Token.setApiKeyPrefix("Token");
UserApi apiInstance = new UserApi();
String username = "username_example"; // String | user to unblock
String username = "username_example"; // String | username of the user to unblock
try {
Void result = apiInstance.userUnblockUser(username);
System.out.println(result);
@@ -6505,7 +6505,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| user to unblock |
**username** | **String**| username of the user to unblock |
### Return type
@@ -28,7 +28,7 @@ public interface AdminApi {
/**
* Add a badge to a user
*
* @param username username of user (required)
* @param username username of the user to whom a badge is to be added (required)
* @param body (optional)
* @return Call&lt;Void&gt;
*/
@@ -62,7 +62,7 @@ public interface AdminApi {
* Create an organization
*
* @param body (required)
* @param username username of the user that will own the created organization (required)
* @param username username of the user who will own the created organization (required)
* @return Call&lt;Organization&gt;
*/
@Headers({"Content-Type:application/json"})
@@ -73,7 +73,7 @@ public interface AdminApi {
/**
* Add a public key on behalf of a user
*
* @param username username of the user (required)
* @param username username of the user who is to receive a public key (required)
* @param body (optional)
* @return Call&lt;PublicKey&gt;
*/
@@ -86,7 +86,7 @@ public interface AdminApi {
* Create a repository on behalf of a user
*
* @param body (required)
* @param username username of the user. This user will own the created repository (required)
* @param username username of the user who will own the created repository (required)
* @return Call&lt;Repository&gt;
*/
@Headers({"Content-Type:application/json"})
@@ -155,7 +155,7 @@ public interface AdminApi {
/**
* Delete a user
*
* @param username username of user to delete (required)
* @param username username of the user to delete (required)
* @param purge purge the user from the system completely (optional)
* @return Call&lt;Void&gt;
*/
@@ -167,7 +167,7 @@ public interface AdminApi {
/**
* Remove a badge from a user
*
* @param username username of user (required)
* @param username username of the user whose badge is to be deleted (required)
* @param body (optional)
* @return Call&lt;Void&gt;
*/
@@ -179,7 +179,7 @@ public interface AdminApi {
/**
* Delete a user&#x27;s public key
*
* @param username username of user (required)
* @param username username of the user whose public key is to be deleted (required)
* @param id id of the key to delete (required)
* @return Call&lt;Void&gt;
*/
@@ -202,7 +202,7 @@ public interface AdminApi {
/**
* Edit an existing user
*
* @param username username of user to edit (required)
* @param username username of the user whose data is to be edited (required)
* @param body (optional)
* @return Call&lt;User&gt;
*/
@@ -267,7 +267,7 @@ public interface AdminApi {
/**
* List a user&#x27;s badges
*
* @param username username of user (required)
* @param username username of the user whose badges are to be listed (required)
* @return Call&lt;List&lt;Badge&gt;&gt;
*/
@GET("admin/users/{username}/badges")
@@ -277,7 +277,7 @@ public interface AdminApi {
* Rename a user
*
* @param body (required)
* @param username existing username of user (required)
* @param username current username of the user (required)
* @return Call&lt;Void&gt;
*/
@Headers({"Content-Type:application/json"})
@@ -303,7 +303,7 @@ public interface AdminApi {
* Search users according filter conditions
*
* @param sourceId ID of the user&#x27;s login source to search for (optional)
* @param loginName user&#x27;s login name to search for (optional)
* @param loginName identifier of the user, provided by the external authenticator (optional)
* @param page page number of results to return (1-based) (optional)
* @param limit page size of results (optional)
* @return Call&lt;List&lt;User&gt;&gt;
@@ -57,7 +57,7 @@ public interface IssueApi {
* @param owner owner of the repo (required)
* @param repo name of the repo (required)
* @param index index of the issue (required)
* @param user user to subscribe (required)
* @param user username of the user to subscribe the issue to (required)
* @return Call&lt;Void&gt;
*/
@PUT("repos/{owner}/{repo}/issues/{index}/subscriptions/{user}")
@@ -405,7 +405,7 @@ public interface IssueApi {
* @param owner owner of the repo (required)
* @param repo name of the repo (required)
* @param index index of the issue (required)
* @param user user witch unsubscribe (required)
* @param user username of the user to unsubscribe from an issue (required)
* @return Call&lt;Void&gt;
*/
@DELETE("repos/{owner}/{repo}/issues/{index}/subscriptions/{user}")
@@ -199,7 +199,7 @@ public interface OrganizationApi {
* Add a team member
*
* @param id id of the team (required)
* @param username username of the user to add (required)
* @param username username of the user to add to a team (required)
* @return Call&lt;Void&gt;
*/
@PUT("teams/{id}/members/{username}")
@@ -224,7 +224,7 @@ public interface OrganizationApi {
* Conceal a user&#x27;s membership
*
* @param org name of the organization (required)
* @param username username of the user (required)
* @param username username of the user whose membership is to be concealed (required)
* @return Call&lt;Void&gt;
*/
@DELETE("orgs/{org}/public_members/{username}")
@@ -330,7 +330,7 @@ public interface OrganizationApi {
* Remove a member from an organization
*
* @param org name of the organization (required)
* @param username username of the user (required)
* @param username username of the user to remove from the organization (required)
* @return Call&lt;Void&gt;
*/
@DELETE("orgs/{org}/members/{username}")
@@ -462,7 +462,7 @@ public interface OrganizationApi {
/**
* Get user permissions in organization
*
* @param username username of user (required)
* @param username username of the user whose permissions are to be obtained (required)
* @param org name of the organization (required)
* @return Call&lt;OrganizationPermissions&gt;
*/
@@ -474,7 +474,7 @@ public interface OrganizationApi {
* Check if a user is a member of an organization
*
* @param org name of the organization (required)
* @param username username of the user (required)
* @param username username of the user to check for an organization membership (required)
* @return Call&lt;Void&gt;
*/
@GET("orgs/{org}/members/{username}")
@@ -485,7 +485,7 @@ public interface OrganizationApi {
* Check if a user is a public member of an organization
*
* @param org name of the organization (required)
* @param username username of the user (required)
* @param username username of the user to check for a public organization membership (required)
* @return Call&lt;Void&gt;
*/
@GET("orgs/{org}/public_members/{username}")
@@ -623,7 +623,7 @@ public interface OrganizationApi {
* List a particular member of team
*
* @param id id of the team (required)
* @param username username of the member to list (required)
* @param username username of the user whose data is to be listed (required)
* @return Call&lt;User&gt;
*/
@GET("teams/{id}/members/{username}")
@@ -689,7 +689,7 @@ public interface OrganizationApi {
/**
* List a user&#x27;s organizations
*
* @param username username of user (required)
* @param username username of the user whose organizations are to be listed (required)
* @param page page number of results to return (1-based) (optional)
* @param limit page size of results (optional)
* @return Call&lt;List&lt;Organization&gt;&gt;
@@ -704,7 +704,7 @@ public interface OrganizationApi {
* Publicize a user&#x27;s membership
*
* @param org name of the organization (required)
* @param username username of the user (required)
* @param username username of the user whose membership is to be publicized (required)
* @return Call&lt;Void&gt;
*/
@PUT("orgs/{org}/public_members/{username}")
@@ -715,7 +715,7 @@ public interface OrganizationApi {
* Remove a team member
*
* @param id id of the team (required)
* @param username username of the user to remove (required)
* @param username username of the user to remove from a team (required)
* @return Call&lt;Void&gt;
*/
@DELETE("teams/{id}/members/{username}")
@@ -753,7 +753,7 @@ public interface OrganizationApi {
* Block a user
*
* @param org name of the organization (required)
* @param username user to block (required)
* @param username username of the user to block (required)
* @param note optional note for the block (optional)
* @return Call&lt;Void&gt;
*/
@@ -767,7 +767,7 @@ public interface OrganizationApi {
* Check if a user is blocked by the organization
*
* @param org name of the organization (required)
* @param username user to check (required)
* @param username username of the user to check (required)
* @return Call&lt;Void&gt;
*/
@GET("orgs/{org}/blocks/{username}")
@@ -792,7 +792,7 @@ public interface OrganizationApi {
* Unblock a user
*
* @param org name of the organization (required)
* @param username user to unblock (required)
* @param username username of the user to unblock (required)
* @return Call&lt;Void&gt;
*/
@DELETE("orgs/{org}/blocks/{username}")
@@ -639,7 +639,7 @@ public interface RepositoryApi {
*
* @param owner owner of the repo (required)
* @param repo name of the repo (required)
* @param collaborator username of the collaborator to add (required)
* @param collaborator username of the user to add or update as a collaborator (required)
* @param body (optional)
* @return Call&lt;Void&gt;
*/
@@ -743,7 +743,7 @@ public interface RepositoryApi {
*
* @param owner owner of the repo (required)
* @param repo name of the repo (required)
* @param collaborator username of the collaborator (required)
* @param collaborator username of the user to check for being a collaborator (required)
* @return Call&lt;Void&gt;
*/
@GET("repos/{owner}/{repo}/collaborators/{collaborator}")
@@ -2109,7 +2109,8 @@ public interface RepositoryApi {
*
* @param owner owner of the repo (required)
* @param repo name of the repo (required)
* @param collaborator username of the collaborator (required)
* @param collaborator username of the collaborator whose permissions are to be obtained
* (required)
* @return Call&lt;RepoCollaboratorPermission&gt;
*/
@GET("repos/{owner}/{repo}/collaborators/{collaborator}/permission")
@@ -3082,7 +3083,7 @@ public interface RepositoryApi {
*
* @param owner owner of the repo (required)
* @param repo name of the repo (required)
* @param user username of user (required)
* @param user username of the user whose tracked times are to be listed (required)
* @return Call&lt;List&lt;TrackedTime&gt;&gt;
*/
@GET("repos/{owner}/{repo}/times/{user}")
@@ -229,7 +229,7 @@ public interface UserApi {
/**
* Block a user
*
* @param username user to block (required)
* @param username username of the user to block (required)
* @param note optional note for the block (optional)
* @return Call&lt;Void&gt;
*/
@@ -240,8 +240,8 @@ public interface UserApi {
/**
* Check if one user is following another user
*
* @param username username of following user (required)
* @param target username of followed user (required)
* @param username username of the following user (required)
* @param target username of the followed user (required)
* @return Call&lt;Void&gt;
*/
@GET("users/{username}/following/{target}")
@@ -252,7 +252,7 @@ public interface UserApi {
/**
* Check if a user is blocked by the authenticated user
*
* @param username user to check (required)
* @param username username of the user to check (required)
* @return Call&lt;Void&gt;
*/
@GET("user/blocks/{username}")
@@ -290,7 +290,7 @@ public interface UserApi {
/**
* Create an access token
*
* @param username username of user (required)
* @param username username of the user whose token is to be created (required)
* @param body (optional)
* @return Call&lt;AccessToken&gt;
*/
@@ -303,7 +303,7 @@ public interface UserApi {
/**
* Check whether a user is followed by the authenticated user
*
* @param username username of followed user (required)
* @param username username of the user to check for authenticated followers (required)
* @return Call&lt;Void&gt;
*/
@GET("user/following/{username}")
@@ -323,7 +323,7 @@ public interface UserApi {
/**
* Unfollow a user
*
* @param username username of user to unfollow (required)
* @param username username of the user to unfollow (required)
* @return Call&lt;Void&gt;
*/
@DELETE("user/following/{username}")
@@ -479,7 +479,7 @@ public interface UserApi {
/**
* Follow a user
*
* @param username username of user to follow (required)
* @param username username of the user to follow (required)
* @return Call&lt;Void&gt;
*/
@PUT("user/following/{username}")
@@ -517,7 +517,7 @@ public interface UserApi {
/**
* delete an access token
*
* @param username username of user (required)
* @param username username of the user whose token is to be deleted (required)
* @param token token to be deleted, identified by ID and if not available by name (required)
* @return Call&lt;Void&gt;
*/
@@ -576,7 +576,7 @@ public interface UserApi {
/**
* Get a user
*
* @param username username of user to get (required)
* @param username username of the user whose data is to be listed (required)
* @return Call&lt;User&gt;
*/
@GET("users/{username}")
@@ -593,7 +593,7 @@ public interface UserApi {
/**
* Get a user&#x27;s heatmap
*
* @param username username of user to get (required)
* @param username username of the user whose heatmap is to be obtained (required)
* @return Call&lt;List&lt;UserHeatmapData&gt;&gt;
*/
@GET("users/{username}/heatmap")
@@ -650,7 +650,7 @@ public interface UserApi {
/**
* List the authenticated user&#x27;s access tokens
*
* @param username username of user (required)
* @param username username of to user whose access tokens are to be listed (required)
* @param page page number of results to return (1-based) (optional)
* @param limit page size of results (optional)
* @return Call&lt;List&lt;AccessToken&gt;&gt;
@@ -664,7 +664,7 @@ public interface UserApi {
/**
* List a user&#x27;s activity feeds
*
* @param username username of user (required)
* @param username username of the user whose activity feeds are to be listed (required)
* @param onlyPerformedBy if true, only show actions performed by the requested user (optional)
* @param date the date of the activities to be found (optional)
* @param page page number of results to return (1-based) (optional)
@@ -701,7 +701,7 @@ public interface UserApi {
/**
* List the given user&#x27;s followers
*
* @param username username of user (required)
* @param username username of the user whose followers are to be listed (required)
* @param page page number of results to return (1-based) (optional)
* @param limit page size of results (optional)
* @return Call&lt;List&lt;User&gt;&gt;
@@ -715,7 +715,7 @@ public interface UserApi {
/**
* List the users that the given user is following
*
* @param username username of user (required)
* @param username username of the user whose followed users are to be listed (required)
* @param page page number of results to return (1-based) (optional)
* @param limit page size of results (optional)
* @return Call&lt;List&lt;User&gt;&gt;
@@ -729,7 +729,7 @@ public interface UserApi {
/**
* List the given user&#x27;s GPG keys
*
* @param username username of user (required)
* @param username username of the user whose GPG key list is to be obtained (required)
* @param page page number of results to return (1-based) (optional)
* @param limit page size of results (optional)
* @return Call&lt;List&lt;GPGKey&gt;&gt;
@@ -754,7 +754,7 @@ public interface UserApi {
/**
* List the given user&#x27;s public keys
*
* @param username username of user (required)
* @param username username of the user whose public keys are to be listed (required)
* @param fingerprint fingerprint of the key (optional)
* @param page page number of results to return (1-based) (optional)
* @param limit page size of results (optional)
@@ -770,7 +770,7 @@ public interface UserApi {
/**
* List the repos owned by the given user
*
* @param username username of user (required)
* @param username username of the user whose owned repos are to be listed (required)
* @param page page number of results to return (1-based) (optional)
* @param limit page size of results (optional)
* @return Call&lt;List&lt;Repository&gt;&gt;
@@ -784,7 +784,7 @@ public interface UserApi {
/**
* The repos that the given user has starred
*
* @param username username of user (required)
* @param username username of the user whose starred repos are to be listed (required)
* @param page page number of results to return (1-based) (optional)
* @param limit page size of results (optional)
* @return Call&lt;List&lt;Repository&gt;&gt;
@@ -798,7 +798,7 @@ public interface UserApi {
/**
* List the repositories watched by a user
*
* @param username username of the user (required)
* @param username username of the user whose watched repos are to be listed (required)
* @param page page number of results to return (1-based) (optional)
* @param limit page size of results (optional)
* @return Call&lt;List&lt;Repository&gt;&gt;
@@ -839,7 +839,7 @@ public interface UserApi {
/**
* Unblock a user
*
* @param username user to unblock (required)
* @param username username of the user to unblock (required)
* @return Call&lt;Void&gt;
*/
@DELETE("user/blocks/{username}")
@@ -76,11 +76,11 @@ public class AddTimeOption implements Serializable {
}
/**
* User who spent the time (optional)
* username of the user who spent the time working on the issue (optional)
*
* @return userName
*/
@Schema(description = "User who spent the time (optional)")
@Schema(description = "username of the user who spent the time working on the issue (optional)")
public String getUserName() {
return userName;
}
@@ -200,11 +200,11 @@ public class CreateOrgOption implements Serializable {
}
/**
* Get username
* username of the organization
*
* @return username
*/
@Schema(required = true, description = "")
@Schema(required = true, description = "username of the organization")
public String getUsername() {
return username;
}
@@ -33,7 +33,7 @@ public class CreateUserOption implements Serializable {
private String fullName = null;
@SerializedName("login_name")
private String loginName = null;
private String loginName = "empty";
@SerializedName("must_change_password")
private Boolean mustChangePassword = null;
@@ -124,11 +124,13 @@ public class CreateUserOption implements Serializable {
}
/**
* Get loginName
* identifier of the user, provided by the external authenticator (if configured)
*
* @return loginName
*/
@Schema(description = "")
@Schema(
description =
"identifier of the user, provided by the external authenticator (if configured)")
public String getLoginName() {
return loginName;
}
@@ -238,11 +240,11 @@ public class CreateUserOption implements Serializable {
}
/**
* Get username
* username of the user
*
* @return username
*/
@Schema(required = true, description = "")
@Schema(required = true, description = "username of the user")
public String getUsername() {
return username;
}
@@ -50,7 +50,7 @@ public class EditUserOption implements Serializable {
private String location = null;
@SerializedName("login_name")
private String loginName = null;
private String loginName = "empty";
@SerializedName("max_repo_creation")
private Long maxRepoCreation = null;
@@ -253,11 +253,14 @@ public class EditUserOption implements Serializable {
}
/**
* Get loginName
* identifier of the user, provided by the external authenticator (if configured)
*
* @return loginName
*/
@Schema(required = true, description = "")
@Schema(
required = true,
description =
"identifier of the user, provided by the external authenticator (if configured)")
public String getLoginName() {
return loginName;
}
@@ -100,11 +100,11 @@ public class Email implements Serializable {
}
/**
* Get username
* username of the user
*
* @return username
*/
@Schema(description = "")
@Schema(description = "username of the user")
public String getUsername() {
return username;
}
@@ -213,11 +213,11 @@ public class Organization implements Serializable {
}
/**
* deprecated
* username of the organization deprecated
*
* @return username
*/
@Schema(description = "deprecated")
@Schema(description = "username of the organization deprecated")
public String getUsername() {
return username;
}
@@ -75,11 +75,11 @@ public class PayloadUser implements Serializable {
}
/**
* Get username
* username of the user
*
* @return username
*/
@Schema(description = "")
@Schema(description = "username of the user")
public String getUsername() {
return username;
}
@@ -164,11 +164,11 @@ public class TrackedTime implements Serializable {
}
/**
* Get userName
* username of the user
*
* @return userName
*/
@Schema(description = "")
@Schema(description = "username of the user")
public String getUserName() {
return userName;
}
@@ -361,11 +361,11 @@ public class User implements Serializable {
}
/**
* the user&#x27;s username
* login of the user, same as &#x60;username&#x60;
*
* @return login
*/
@Schema(description = "the user's username")
@Schema(description = "login of the user, same as `username`")
public String getLogin() {
return login;
}
@@ -380,11 +380,13 @@ public class User implements Serializable {
}
/**
* the user&#x27;s authentication sign-in name.
* identifier of the user, provided by the external authenticator (if configured)
*
* @return loginName
*/
@Schema(description = "the user's authentication sign-in name.")
@Schema(
description =
"identifier of the user, provided by the external authenticator (if configured)")
public String getLoginName() {
return loginName;
}