From 52d8faad2032af6be520319fb5eb071215f20e6b Mon Sep 17 00:00:00 2001 From: gitnexbot Date: Thu, 2 Jul 2026 00:02:13 +0000 Subject: [PATCH] Synchronizing API and documentation updates --- docs/AddCollaboratorOption.md | 2 +- docs/Attachment.md | 2 +- docs/BranchProtection.md | 2 +- docs/CombinedStatus.md | 2 +- docs/Commit.md | 2 +- docs/CommitDateOptions.md | 4 +-- docs/CommitMeta.md | 2 +- docs/CommitStatus.md | 2 +- docs/CommitUser.md | 2 +- docs/CreateBranchProtectionOption.md | 2 +- docs/CreateBranchRepoOption.md | 2 +- docs/CreateHookOption.md | 4 +-- docs/CreateIssueCommentOption.md | 2 +- docs/CreateLabelOption.md | 2 +- docs/CreateMilestoneOption.md | 4 +-- docs/CreateOrgOption.md | 2 +- docs/CreateRepoOption.md | 2 +- docs/CreateStatusOption.md | 2 +- docs/CreateTagOption.md | 2 +- docs/CreateTeamOption.md | 4 +-- docs/CreateUserOption.md | 2 +- docs/DeployKey.md | 2 +- docs/EditIssueCommentOption.md | 2 +- docs/EditOrgOption.md | 2 +- docs/EditTeamOption.md | 4 +-- docs/EditUserOption.md | 6 ++-- docs/Email.md | 2 +- docs/FileCommitResponse.md | 2 +- docs/GPGKey.md | 4 +-- docs/Hook.md | 4 +-- docs/Identity.md | 2 +- docs/MarkdownOption.md | 2 +- docs/MarkupOption.md | 2 +- docs/Milestone.md | 2 +- docs/ModelPackage.md | 2 +- docs/NotificationSubject.md | 4 +-- docs/Organization.md | 2 +- docs/PayloadCommit.md | 2 +- docs/PublicKey.md | 2 +- docs/PullRequest.md | 2 +- docs/Reaction.md | 2 +- docs/RepoCollaboratorPermission.md | 2 +- docs/Repository.md | 2 +- docs/StopWatch.md | 2 +- docs/TagProtection.md | 4 +-- docs/Team.md | 4 +-- docs/User.md | 2 +- .../v2/models/AddCollaboratorOption.java | 13 ++----- .../gitnex/tea4j/v2/models/Attachment.java | 4 +-- .../tea4j/v2/models/BranchProtection.java | 4 +-- .../tea4j/v2/models/CombinedStatus.java | 23 ++---------- .../org/gitnex/tea4j/v2/models/Commit.java | 4 +-- .../tea4j/v2/models/CommitDateOptions.java | 8 ++--- .../gitnex/tea4j/v2/models/CommitMeta.java | 4 +-- .../gitnex/tea4j/v2/models/CommitStatus.java | 26 ++------------ .../gitnex/tea4j/v2/models/CommitUser.java | 4 +-- .../models/CreateBranchProtectionOption.java | 4 +-- .../v2/models/CreateBranchRepoOption.java | 4 +-- .../tea4j/v2/models/CreateHookOption.java | 10 +++--- .../v2/models/CreateIssueCommentOption.java | 4 +-- .../tea4j/v2/models/CreateLabelOption.java | 4 +-- .../v2/models/CreateMilestoneOption.java | 10 +++--- .../tea4j/v2/models/CreateOrgOption.java | 7 +--- .../tea4j/v2/models/CreateRepoOption.java | 11 ++---- .../tea4j/v2/models/CreateStatusOption.java | 25 ++----------- .../tea4j/v2/models/CreateTagOption.java | 4 +-- .../tea4j/v2/models/CreateTeamOption.java | 23 +++++------- .../tea4j/v2/models/CreateUserOption.java | 13 ++----- .../org/gitnex/tea4j/v2/models/DeployKey.java | 4 +-- .../v2/models/EditIssueCommentOption.java | 4 +-- .../gitnex/tea4j/v2/models/EditOrgOption.java | 13 ++----- .../tea4j/v2/models/EditTeamOption.java | 18 ++++------ .../tea4j/v2/models/EditUserOption.java | 21 ++++------- .../org/gitnex/tea4j/v2/models/Email.java | 4 +-- .../tea4j/v2/models/FileCommitResponse.java | 4 +-- .../org/gitnex/tea4j/v2/models/GPGKey.java | 8 ++--- .../java/org/gitnex/tea4j/v2/models/Hook.java | 8 ++--- .../org/gitnex/tea4j/v2/models/Identity.java | 4 +-- .../tea4j/v2/models/MarkdownOption.java | 4 +-- .../gitnex/tea4j/v2/models/MarkupOption.java | 4 +-- .../org/gitnex/tea4j/v2/models/Milestone.java | 13 ++----- .../gitnex/tea4j/v2/models/ModelPackage.java | 4 +-- .../tea4j/v2/models/NotificationSubject.java | 35 ++++--------------- .../gitnex/tea4j/v2/models/Organization.java | 13 ++----- .../gitnex/tea4j/v2/models/PayloadCommit.java | 4 +-- .../org/gitnex/tea4j/v2/models/PublicKey.java | 4 +-- .../gitnex/tea4j/v2/models/PullRequest.java | 13 ++----- .../org/gitnex/tea4j/v2/models/Reaction.java | 4 +-- .../v2/models/RepoCollaboratorPermission.java | 13 ++----- .../gitnex/tea4j/v2/models/Repository.java | 13 ++----- .../org/gitnex/tea4j/v2/models/StopWatch.java | 4 +-- .../gitnex/tea4j/v2/models/TagProtection.java | 8 ++--- .../java/org/gitnex/tea4j/v2/models/Team.java | 15 ++++---- .../java/org/gitnex/tea4j/v2/models/User.java | 13 ++----- 94 files changed, 205 insertions(+), 374 deletions(-) diff --git a/docs/AddCollaboratorOption.md b/docs/AddCollaboratorOption.md index 55533c6..3bf6735 100644 --- a/docs/AddCollaboratorOption.md +++ b/docs/AddCollaboratorOption.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**permission** | [**PermissionEnum**](#PermissionEnum) | Permission level to grant the collaborator read RepoWritePermissionRead write RepoWritePermissionWrite admin RepoWritePermissionAdmin | [optional] +**permission** | [**PermissionEnum**](#PermissionEnum) | Permission level to grant the collaborator | [optional] ## Enum: PermissionEnum diff --git a/docs/Attachment.md b/docs/Attachment.md index a4e9b63..7c5a9a4 100644 --- a/docs/Attachment.md +++ b/docs/Attachment.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **browserDownloadUrl** | **String** | DownloadURL is the URL to download the attachment | [optional] -**createdAt** | [**Date**](Date.md) | | [optional] +**createdAt** | [**Date**](Date.md) | Created is the time when the attachment was uploaded | [optional] **downloadCount** | **Long** | DownloadCount is the number of times the attachment has been downloaded | [optional] **id** | **Long** | ID is the unique identifier for the attachment | [optional] **name** | **String** | Name is the filename of the attachment | [optional] diff --git a/docs/BranchProtection.md b/docs/BranchProtection.md index ff040df..cda4a82 100644 --- a/docs/BranchProtection.md +++ b/docs/BranchProtection.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **blockOnOfficialReviewRequests** | **Boolean** | | [optional] **blockOnOutdatedBranch** | **Boolean** | | [optional] **blockOnRejectedReviews** | **Boolean** | | [optional] -**branchName** | **String** | Deprecated: true | [optional] +**branchName** | **String** | | [optional] **bypassAllowlistTeams** | **List<String>** | | [optional] **bypassAllowlistUsernames** | **List<String>** | | [optional] **createdAt** | [**Date**](Date.md) | | [optional] diff --git a/docs/CombinedStatus.md b/docs/CombinedStatus.md index ada5e73..bdf5bdd 100644 --- a/docs/CombinedStatus.md +++ b/docs/CombinedStatus.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes **commitUrl** | **String** | CommitURL is the API URL for the commit | [optional] **repository** | [**Repository**](Repository.md) | | [optional] **sha** | **String** | SHA is the commit SHA this status applies to | [optional] -**state** | [**StateEnum**](#StateEnum) | State is the overall combined status state pending CommitStatusPending is for when the CommitStatus is Pending success CommitStatusSuccess is for when the CommitStatus is Success error CommitStatusError is for when the CommitStatus is Error failure CommitStatusFailure is for when the CommitStatus is Failure warning CommitStatusWarning is for when the CommitStatus is Warning skipped CommitStatusSkipped is for when CommitStatus is Skipped | [optional] +**state** | [**StateEnum**](#StateEnum) | State is the overall combined status state | [optional] **statuses** | [**List<CommitStatus>**](CommitStatus.md) | Statuses contains all individual commit statuses | [optional] **totalCount** | **Long** | TotalCount is the total number of statuses | [optional] **url** | **String** | URL is the API URL for this combined status | [optional] diff --git a/docs/Commit.md b/docs/Commit.md index 51ea378..40cee19 100644 --- a/docs/Commit.md +++ b/docs/Commit.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes **author** | [**User**](User.md) | | [optional] **commit** | [**RepoCommit**](RepoCommit.md) | | [optional] **committer** | [**User**](User.md) | | [optional] -**created** | [**Date**](Date.md) | | [optional] +**created** | [**Date**](Date.md) | Created is the time when the commit was created | [optional] **files** | [**List<CommitAffectedFiles>**](CommitAffectedFiles.md) | Files contains information about files affected by the commit | [optional] **htmlUrl** | **String** | HTMLURL is the web URL for viewing the commit | [optional] **parents** | [**List<CommitMeta>**](CommitMeta.md) | Parents contains the parent commit information | [optional] diff --git a/docs/CommitDateOptions.md b/docs/CommitDateOptions.md index 862c1b4..885494f 100644 --- a/docs/CommitDateOptions.md +++ b/docs/CommitDateOptions.md @@ -3,5 +3,5 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**author** | [**Date**](Date.md) | | [optional] -**committer** | [**Date**](Date.md) | | [optional] +**author** | [**Date**](Date.md) | Author is the author date for the commit | [optional] +**committer** | [**Date**](Date.md) | Committer is the committer date for the commit | [optional] diff --git a/docs/CommitMeta.md b/docs/CommitMeta.md index 8db9647..3684cb7 100644 --- a/docs/CommitMeta.md +++ b/docs/CommitMeta.md @@ -3,6 +3,6 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | [**Date**](Date.md) | | [optional] +**created** | [**Date**](Date.md) | Created is the time when the commit was created | [optional] **sha** | **String** | SHA is the commit SHA hash | [optional] **url** | **String** | URL is the API URL for the commit | [optional] diff --git a/docs/CommitStatus.md b/docs/CommitStatus.md index a044402..92076a5 100644 --- a/docs/CommitStatus.md +++ b/docs/CommitStatus.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **creator** | [**User**](User.md) | | [optional] **description** | **String** | Description provides a brief description of the status | [optional] **id** | **Long** | ID is the unique identifier for the commit status | [optional] -**status** | [**StatusEnum**](#StatusEnum) | State represents the status state (pending, success, error, failure) pending CommitStatusPending is for when the CommitStatus is Pending success CommitStatusSuccess is for when the CommitStatus is Success error CommitStatusError is for when the CommitStatus is Error failure CommitStatusFailure is for when the CommitStatus is Failure warning CommitStatusWarning is for when the CommitStatus is Warning skipped CommitStatusSkipped is for when CommitStatus is Skipped | [optional] +**status** | [**StatusEnum**](#StatusEnum) | State represents the status state (pending, success, error, failure) | [optional] **targetUrl** | **String** | TargetURL is the URL to link to for more details | [optional] **updatedAt** | [**Date**](Date.md) | | [optional] **url** | **String** | URL is the API URL for this status | [optional] diff --git a/docs/CommitUser.md b/docs/CommitUser.md index a1a2dff..6014621 100644 --- a/docs/CommitUser.md +++ b/docs/CommitUser.md @@ -4,5 +4,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **date** | **String** | Date is the commit date in string format | [optional] -**email** | **String** | | [optional] +**email** | **String** | Email is the person's email address | [optional] **name** | **String** | Name is the person's name | [optional] diff --git a/docs/CreateBranchProtectionOption.md b/docs/CreateBranchProtectionOption.md index a7d53c5..814edab 100644 --- a/docs/CreateBranchProtectionOption.md +++ b/docs/CreateBranchProtectionOption.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **blockOnOfficialReviewRequests** | **Boolean** | | [optional] **blockOnOutdatedBranch** | **Boolean** | | [optional] **blockOnRejectedReviews** | **Boolean** | | [optional] -**branchName** | **String** | Deprecated: true | [optional] +**branchName** | **String** | | [optional] **bypassAllowlistTeams** | **List<String>** | | [optional] **bypassAllowlistUsernames** | **List<String>** | | [optional] **dismissStaleApprovals** | **Boolean** | | [optional] diff --git a/docs/CreateBranchRepoOption.md b/docs/CreateBranchRepoOption.md index 4a6fec9..e500528 100644 --- a/docs/CreateBranchRepoOption.md +++ b/docs/CreateBranchRepoOption.md @@ -4,5 +4,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **newBranchName** | **String** | Name of the branch to create | -**oldBranchName** | **String** | Deprecated: true Name of the old branch to create from | [optional] +**oldBranchName** | **String** | Name of the old branch to create from | [optional] **oldRefName** | **String** | Name of the old branch/tag/commit to create from | [optional] diff --git a/docs/CreateHookOption.md b/docs/CreateHookOption.md index 6888bc9..4a1d7c7 100644 --- a/docs/CreateHookOption.md +++ b/docs/CreateHookOption.md @@ -3,13 +3,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**active** | **Boolean** | | [optional] +**active** | **Boolean** | Whether the webhook should be active upon creation | [optional] **authorizationHeader** | **String** | Authorization header to include in webhook requests | [optional] **branchFilter** | **String** | Branch filter pattern to determine which branches trigger the webhook | [optional] **config** | [**CreateHookOptionConfig**](CreateHookOptionConfig.md) | | **events** | **List<String>** | List of events that will trigger this webhook | [optional] **name** | **String** | Optional human-readable name for the webhook | [optional] -**type** | [**TypeEnum**](#TypeEnum) | | +**type** | [**TypeEnum**](#TypeEnum) | The type of the webhook to create | ## Enum: TypeEnum diff --git a/docs/CreateIssueCommentOption.md b/docs/CreateIssueCommentOption.md index be1071a..a71b306 100644 --- a/docs/CreateIssueCommentOption.md +++ b/docs/CreateIssueCommentOption.md @@ -3,4 +3,4 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**body** | **String** | | +**body** | **String** | Body is the comment text content | diff --git a/docs/CreateLabelOption.md b/docs/CreateLabelOption.md index 3cb7d32..f1eef9b 100644 --- a/docs/CreateLabelOption.md +++ b/docs/CreateLabelOption.md @@ -7,4 +7,4 @@ Name | Type | Description | Notes **description** | **String** | Description provides additional context about the label's purpose | [optional] **exclusive** | **Boolean** | | [optional] **isArchived** | **Boolean** | | [optional] -**name** | **String** | | +**name** | **String** | Name is the display name for the new label | diff --git a/docs/CreateMilestoneOption.md b/docs/CreateMilestoneOption.md index f2c41d5..037418d 100644 --- a/docs/CreateMilestoneOption.md +++ b/docs/CreateMilestoneOption.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **description** | **String** | Description provides details about the milestone | [optional] -**dueOn** | [**Date**](Date.md) | | [optional] -**state** | [**StateEnum**](#StateEnum) | | [optional] +**dueOn** | [**Date**](Date.md) | Deadline is the due date for the milestone | [optional] +**state** | [**StateEnum**](#StateEnum) | State indicates the initial state of the milestone | [optional] **title** | **String** | Title is the title of the new milestone | [optional] diff --git a/docs/CreateOrgOption.md b/docs/CreateOrgOption.md index e240649..aad12ad 100644 --- a/docs/CreateOrgOption.md +++ b/docs/CreateOrgOption.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **location** | **String** | The location of the organization | [optional] **repoAdminChangeTeamAccess** | **Boolean** | Whether repository administrators can change team access | [optional] **username** | **String** | username of the organization | -**visibility** | [**VisibilityEnum**](#VisibilityEnum) | possible values are `public` (default), `limited` or `private` public UserVisibilityPublic limited UserVisibilityLimited private UserVisibilityPrivate | [optional] +**visibility** | [**VisibilityEnum**](#VisibilityEnum) | possible values are `public` (default), `limited` or `private` | [optional] **website** | **String** | The website URL of the organization | [optional] diff --git a/docs/CreateRepoOption.md b/docs/CreateRepoOption.md index 41f6dd2..669e445 100644 --- a/docs/CreateRepoOption.md +++ b/docs/CreateRepoOption.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **issueLabels** | **String** | Label-Set to use | [optional] **license** | **String** | License to use | [optional] **name** | **String** | Name of the repository to create | -**objectFormatName** | [**ObjectFormatNameEnum**](#ObjectFormatNameEnum) | ObjectFormatName of the underlying git repository, empty string for default (sha1) sha1 ObjectFormatSHA1 sha256 ObjectFormatSHA256 | [optional] +**objectFormatName** | [**ObjectFormatNameEnum**](#ObjectFormatNameEnum) | ObjectFormatName of the underlying git repository, empty string for default (sha1) | [optional] **_private** | **Boolean** | Whether the repository is private | [optional] **readme** | **String** | Readme of the repository to create | [optional] **template** | **Boolean** | Whether the repository is template | [optional] diff --git a/docs/CreateStatusOption.md b/docs/CreateStatusOption.md index 667b37a..b79694a 100644 --- a/docs/CreateStatusOption.md +++ b/docs/CreateStatusOption.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **context** | **String** | Context is the unique context identifier for the status | [optional] **description** | **String** | Description provides a brief description of the status | [optional] -**state** | [**StateEnum**](#StateEnum) | State represents the status state to set (pending, success, error, failure) pending CommitStatusPending is for when the CommitStatus is Pending success CommitStatusSuccess is for when the CommitStatus is Success error CommitStatusError is for when the CommitStatus is Error failure CommitStatusFailure is for when the CommitStatus is Failure warning CommitStatusWarning is for when the CommitStatus is Warning skipped CommitStatusSkipped is for when CommitStatus is Skipped | [optional] +**state** | [**StateEnum**](#StateEnum) | State represents the status state to set (pending, success, error, failure) | [optional] **targetUrl** | **String** | TargetURL is the URL to link to for more details | [optional] diff --git a/docs/CreateTagOption.md b/docs/CreateTagOption.md index efaa798..46bc292 100644 --- a/docs/CreateTagOption.md +++ b/docs/CreateTagOption.md @@ -4,5 +4,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **message** | **String** | The message to associate with the tag | [optional] -**tagName** | **String** | | +**tagName** | **String** | The name of the tag to create | **target** | **String** | The target commit SHA or branch name for the tag | [optional] diff --git a/docs/CreateTeamOption.md b/docs/CreateTeamOption.md index 6959cec..c2bc8e1 100644 --- a/docs/CreateTeamOption.md +++ b/docs/CreateTeamOption.md @@ -8,9 +8,9 @@ Name | Type | Description | Notes **includesAllRepositories** | **Boolean** | Whether the team has access to all repositories in the organization | [optional] **name** | **String** | | **permission** | [**PermissionEnum**](#PermissionEnum) | | [optional] -**units** | **List<String>** | | [optional] +**units** | **List<String>** | Deprecated: This variable should be replaced by UnitsMap and will be dropped in later versions. | [optional] **unitsMap** | **Map<String, String>** | | [optional] -**visibility** | [**VisibilityEnum**](#VisibilityEnum) | Team visibility within the organization. Defaults to \"private\". public TeamVisibilityPublic limited TeamVisibilityLimited private TeamVisibilityPrivate | [optional] +**visibility** | [**VisibilityEnum**](#VisibilityEnum) | Team visibility within the organization. Defaults to \"private\". | [optional] ## Enum: PermissionEnum diff --git a/docs/CreateUserOption.md b/docs/CreateUserOption.md index edbce0b..4a302d4 100644 --- a/docs/CreateUserOption.md +++ b/docs/CreateUserOption.md @@ -13,7 +13,7 @@ Name | Type | Description | Notes **sendNotify** | **Boolean** | Whether to send welcome notification email to the user | [optional] **sourceId** | **Long** | The authentication source ID to associate with the user | [optional] **username** | **String** | username of the user | -**visibility** | [**VisibilityEnum**](#VisibilityEnum) | User visibility level: public, limited, or private public UserVisibilityPublic limited UserVisibilityLimited private UserVisibilityPrivate | [optional] +**visibility** | [**VisibilityEnum**](#VisibilityEnum) | User visibility level: public, limited, or private | [optional] ## Enum: VisibilityEnum diff --git a/docs/DeployKey.md b/docs/DeployKey.md index cc0612a..8f3e39f 100644 --- a/docs/DeployKey.md +++ b/docs/DeployKey.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**createdAt** | [**Date**](Date.md) | | [optional] +**createdAt** | [**Date**](Date.md) | Created is the time when the deploy key was added | [optional] **fingerprint** | **String** | Fingerprint is the key's fingerprint | [optional] **id** | **Long** | ID is the unique identifier for the deploy key | [optional] **key** | **String** | Key contains the actual SSH key content | [optional] diff --git a/docs/EditIssueCommentOption.md b/docs/EditIssueCommentOption.md index cb69191..91e1b4c 100644 --- a/docs/EditIssueCommentOption.md +++ b/docs/EditIssueCommentOption.md @@ -3,4 +3,4 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**body** | **String** | | +**body** | **String** | Body is the updated comment text content | diff --git a/docs/EditOrgOption.md b/docs/EditOrgOption.md index 9a6d7e5..ba8b6d8 100644 --- a/docs/EditOrgOption.md +++ b/docs/EditOrgOption.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **fullName** | **String** | The full display name of the organization | [optional] **location** | **String** | The location of the organization | [optional] **repoAdminChangeTeamAccess** | **Boolean** | Whether repository administrators can change team access | [optional] -**visibility** | [**VisibilityEnum**](#VisibilityEnum) | possible values are `public`, `limited` or `private` public UserVisibilityPublic limited UserVisibilityLimited private UserVisibilityPrivate | [optional] +**visibility** | [**VisibilityEnum**](#VisibilityEnum) | possible values are `public`, `limited` or `private` | [optional] **website** | **String** | The website URL of the organization | [optional] diff --git a/docs/EditTeamOption.md b/docs/EditTeamOption.md index 5e20a1d..8670948 100644 --- a/docs/EditTeamOption.md +++ b/docs/EditTeamOption.md @@ -8,9 +8,9 @@ Name | Type | Description | Notes **includesAllRepositories** | **Boolean** | Whether the team has access to all repositories in the organization | [optional] **name** | **String** | | **permission** | [**PermissionEnum**](#PermissionEnum) | | [optional] -**units** | **List<String>** | | [optional] +**units** | **List<String>** | Deprecated: This variable should be replaced by UnitsMap and will be dropped in later versions. | [optional] **unitsMap** | **Map<String, String>** | | [optional] -**visibility** | [**VisibilityEnum**](#VisibilityEnum) | Team visibility within the organization. When omitted, visibility is left unchanged. public TeamVisibilityPublic limited TeamVisibilityLimited private TeamVisibilityPrivate | [optional] +**visibility** | [**VisibilityEnum**](#VisibilityEnum) | Team visibility within the organization. When omitted, visibility is left unchanged. | [optional] ## Enum: PermissionEnum diff --git a/docs/EditUserOption.md b/docs/EditUserOption.md index c5caf0f..7caf072 100644 --- a/docs/EditUserOption.md +++ b/docs/EditUserOption.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **allowGitHook** | **Boolean** | Whether the user can use Git hooks | [optional] **allowImportLocal** | **Boolean** | Whether the user can import local repositories | [optional] **description** | **String** | The user's personal description or bio | [optional] -**email** | **String** | | [optional] +**email** | **String** | The email address of the user | [optional] **fullName** | **String** | The full display name of the user | [optional] **location** | **String** | The user's location or address | [optional] **loginName** | **String** | identifier of the user, provided by the external authenticator (if configured) | @@ -18,8 +18,8 @@ Name | Type | Description | Notes **password** | **String** | The plain text password for the user | [optional] **prohibitLogin** | **Boolean** | Whether the user is prohibited from logging in | [optional] **restricted** | **Boolean** | Whether the user has restricted access privileges | [optional] -**sourceId** | **Long** | | -**visibility** | [**VisibilityEnum**](#VisibilityEnum) | User visibility level: public, limited, or private public UserVisibilityPublic limited UserVisibilityLimited private UserVisibilityPrivate | [optional] +**sourceId** | **Long** | The authentication source ID to associate with the user | +**visibility** | [**VisibilityEnum**](#VisibilityEnum) | User visibility level: public, limited, or private | [optional] **website** | **String** | The user's personal website URL | [optional] diff --git a/docs/Email.md b/docs/Email.md index 14029ca..67210a4 100644 --- a/docs/Email.md +++ b/docs/Email.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**email** | **String** | | [optional] +**email** | **String** | The email address | [optional] **primary** | **Boolean** | Whether this is the primary email address | [optional] **userId** | **Long** | The unique identifier of the user who owns this email | [optional] **username** | **String** | username of the user | [optional] diff --git a/docs/FileCommitResponse.md b/docs/FileCommitResponse.md index 70cbe5b..6f5ff70 100644 --- a/docs/FileCommitResponse.md +++ b/docs/FileCommitResponse.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **author** | [**CommitUser**](CommitUser.md) | | [optional] **committer** | [**CommitUser**](CommitUser.md) | | [optional] -**created** | [**Date**](Date.md) | | [optional] +**created** | [**Date**](Date.md) | Created is the time when the commit was created | [optional] **htmlUrl** | **String** | HTMLURL is the web URL for viewing this commit | [optional] **message** | **String** | Message is the commit message | [optional] **parents** | [**List<CommitMeta>**](CommitMeta.md) | Parents contains parent commit metadata | [optional] diff --git a/docs/GPGKey.md b/docs/GPGKey.md index 5cb34e0..69e2a16 100644 --- a/docs/GPGKey.md +++ b/docs/GPGKey.md @@ -7,9 +7,9 @@ Name | Type | Description | Notes **canEncryptComms** | **Boolean** | Whether the key can be used for encrypting communications | [optional] **canEncryptStorage** | **Boolean** | Whether the key can be used for encrypting storage | [optional] **canSign** | **Boolean** | Whether the key can be used for signing | [optional] -**createdAt** | [**Date**](Date.md) | | [optional] +**createdAt** | [**Date**](Date.md) | The date and time when the GPG key was created | [optional] **emails** | [**List<GPGKeyEmail>**](GPGKeyEmail.md) | List of email addresses associated with this GPG key | [optional] -**expiresAt** | [**Date**](Date.md) | | [optional] +**expiresAt** | [**Date**](Date.md) | The date and time when the GPG key expires | [optional] **id** | **Long** | The unique identifier of the GPG key | [optional] **keyId** | **String** | The key ID of the GPG key | [optional] **primaryKeyId** | **String** | The primary key ID of the GPG key | [optional] diff --git a/docs/Hook.md b/docs/Hook.md index 2115094..c9d0dc3 100644 --- a/docs/Hook.md +++ b/docs/Hook.md @@ -7,9 +7,9 @@ Name | Type | Description | Notes **authorizationHeader** | **String** | Authorization header to include in webhook requests | [optional] **branchFilter** | **String** | Branch filter pattern to determine which branches trigger the webhook | [optional] **config** | **Map<String, String>** | Configuration settings for the webhook | [optional] -**createdAt** | [**Date**](Date.md) | | [optional] +**createdAt** | [**Date**](Date.md) | The date and time when the webhook was created | [optional] **events** | **List<String>** | List of events that trigger this webhook | [optional] **id** | **Long** | The unique identifier of the webhook | [optional] **name** | **String** | Optional human-readable name for the webhook | [optional] **type** | **String** | The type of the webhook (e.g., gitea, slack, discord) | [optional] -**updatedAt** | [**Date**](Date.md) | | [optional] +**updatedAt** | [**Date**](Date.md) | The date and time when the webhook was last updated | [optional] diff --git a/docs/Identity.md b/docs/Identity.md index 4a58abd..7427958 100644 --- a/docs/Identity.md +++ b/docs/Identity.md @@ -3,5 +3,5 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**email** | **String** | | [optional] +**email** | **String** | Email is the person's email address | [optional] **name** | **String** | Name is the person's name | [optional] diff --git a/docs/MarkdownOption.md b/docs/MarkdownOption.md index 975b2b7..1e47d65 100644 --- a/docs/MarkdownOption.md +++ b/docs/MarkdownOption.md @@ -6,4 +6,4 @@ Name | Type | Description | Notes **context** | **String** | URL path for rendering issue, media and file links Expected format: /subpath/{user}/{repo}/src/{branch, commit, tag}/{identifier/path}/{file/dir} | [optional] **mode** | **String** | Mode to render (markdown, comment, wiki, file) | [optional] **text** | **String** | Text markdown to render | [optional] -**wiki** | **Boolean** | Is it a wiki page? (use mode=wiki instead) Deprecated: true | [optional] +**wiki** | **Boolean** | Is it a wiki page? (use mode=wiki instead) | [optional] diff --git a/docs/MarkupOption.md b/docs/MarkupOption.md index d49a9f2..efb7b56 100644 --- a/docs/MarkupOption.md +++ b/docs/MarkupOption.md @@ -7,4 +7,4 @@ Name | Type | Description | Notes **filePath** | **String** | File path for detecting extension in file mode | [optional] **mode** | **String** | Mode to render (markdown, comment, wiki, file) | [optional] **text** | **String** | Text markup to render | [optional] -**wiki** | **Boolean** | Is it a wiki page? (use mode=wiki instead) Deprecated: true | [optional] +**wiki** | **Boolean** | Is it a wiki page? (use mode=wiki instead) | [optional] diff --git a/docs/Milestone.md b/docs/Milestone.md index 20d556f..0ddedaf 100644 --- a/docs/Milestone.md +++ b/docs/Milestone.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **dueOn** | [**Date**](Date.md) | | [optional] **id** | **Long** | ID is the unique identifier for the milestone | [optional] **openIssues** | **Long** | OpenIssues is the number of open issues in this milestone | [optional] -**state** | [**StateEnum**](#StateEnum) | State indicates if the milestone is open or closed open StateOpen pr is opened closed StateClosed pr is closed | [optional] +**state** | [**StateEnum**](#StateEnum) | State indicates if the milestone is open or closed | [optional] **title** | **String** | Title is the title of the milestone | [optional] **updatedAt** | [**Date**](Date.md) | | [optional] diff --git a/docs/ModelPackage.md b/docs/ModelPackage.md index b96388b..b5e40c1 100644 --- a/docs/ModelPackage.md +++ b/docs/ModelPackage.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**createdAt** | [**Date**](Date.md) | | [optional] +**createdAt** | [**Date**](Date.md) | The date and time when the package was created | [optional] **creator** | [**User**](User.md) | | [optional] **htmlUrl** | **String** | The HTML URL to view the package | [optional] **id** | **Long** | The unique identifier of the package | [optional] diff --git a/docs/NotificationSubject.md b/docs/NotificationSubject.md index b871324..b9c9800 100644 --- a/docs/NotificationSubject.md +++ b/docs/NotificationSubject.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes **htmlUrl** | **String** | HTMLURL is the web URL for the notification subject | [optional] **latestCommentHtmlUrl** | **String** | LatestCommentHTMLURL is the web URL for the latest comment | [optional] **latestCommentUrl** | **String** | LatestCommentURL is the API URL for the latest comment | [optional] -**state** | [**StateEnum**](#StateEnum) | State indicates the current state of the notification subject open NotifySubjectStateOpen is an open subject closed NotifySubjectStateClosed is a closed subject merged NotifySubjectStateMerged is a merged pull request | [optional] +**state** | [**StateEnum**](#StateEnum) | State indicates the current state of the notification subject | [optional] **title** | **String** | Title is the title of the notification subject | [optional] -**type** | [**TypeEnum**](#TypeEnum) | Type indicates the type of the notification subject Issue NotifySubjectIssue a issue is subject of an notification Pull NotifySubjectPull a pull is subject of an notification Commit NotifySubjectCommit a commit is subject of an notification Repository NotifySubjectRepository a repository is subject of an notification | [optional] +**type** | [**TypeEnum**](#TypeEnum) | Type indicates the type of the notification subject | [optional] **url** | **String** | URL is the API URL for the notification subject | [optional] diff --git a/docs/Organization.md b/docs/Organization.md index 2b9641a..d91cfb0 100644 --- a/docs/Organization.md +++ b/docs/Organization.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **name** | **String** | The name of the organization | [optional] **repoAdminChangeTeamAccess** | **Boolean** | Whether repository administrators can change team access | [optional] **username** | **String** | username of the organization deprecated | [optional] -**visibility** | [**VisibilityEnum**](#VisibilityEnum) | The visibility level of the organization (public, limited, private) public UserVisibilityPublic limited UserVisibilityLimited private UserVisibilityPrivate | [optional] +**visibility** | [**VisibilityEnum**](#VisibilityEnum) | The visibility level of the organization (public, limited, private) | [optional] **website** | **String** | The website URL of the organization | [optional] diff --git a/docs/PayloadCommit.md b/docs/PayloadCommit.md index b14154d..95db7d0 100644 --- a/docs/PayloadCommit.md +++ b/docs/PayloadCommit.md @@ -10,6 +10,6 @@ Name | Type | Description | Notes **message** | **String** | The commit message | [optional] **modified** | **List<String>** | List of files modified in this commit | [optional] **removed** | **List<String>** | List of files removed in this commit | [optional] -**timestamp** | [**Date**](Date.md) | | [optional] +**timestamp** | [**Date**](Date.md) | The timestamp when the commit was made | [optional] **url** | **String** | The URL to view this commit | [optional] **verification** | [**PayloadCommitVerification**](PayloadCommitVerification.md) | | [optional] diff --git a/docs/PublicKey.md b/docs/PublicKey.md index cc05d97..ed6eb8d 100644 --- a/docs/PublicKey.md +++ b/docs/PublicKey.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**createdAt** | [**Date**](Date.md) | | [optional] +**createdAt** | [**Date**](Date.md) | Created is the time when the key was added | [optional] **fingerprint** | **String** | Fingerprint is the key's fingerprint | [optional] **id** | **Long** | ID is the unique identifier for the public key | [optional] **key** | **String** | Key contains the actual SSH public key content | [optional] diff --git a/docs/PullRequest.md b/docs/PullRequest.md index 82ada82..48e1a53 100644 --- a/docs/PullRequest.md +++ b/docs/PullRequest.md @@ -36,7 +36,7 @@ Name | Type | Description | Notes **requestedReviewers** | [**List<User>**](User.md) | The users requested to review the pull request | [optional] **requestedReviewersTeams** | [**List<Team>**](Team.md) | The teams requested to review the pull request | [optional] **reviewComments** | **Long** | number of review comments made on the diff of a PR review (not including comments on commits or issues in a PR) | [optional] -**state** | [**StateEnum**](#StateEnum) | The current state of the pull request open StateOpen pr is opened closed StateClosed pr is closed | [optional] +**state** | [**StateEnum**](#StateEnum) | The current state of the pull request | [optional] **title** | **String** | The title of the pull request | [optional] **updatedAt** | [**Date**](Date.md) | | [optional] **url** | **String** | The API URL of the pull request | [optional] diff --git a/docs/Reaction.md b/docs/Reaction.md index 7f2e185..43cc6d1 100644 --- a/docs/Reaction.md +++ b/docs/Reaction.md @@ -4,5 +4,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **content** | **String** | The reaction content (e.g., emoji or reaction type) | [optional] -**createdAt** | [**Date**](Date.md) | | [optional] +**createdAt** | [**Date**](Date.md) | The date and time when the reaction was created | [optional] **user** | [**User**](User.md) | | [optional] diff --git a/docs/RepoCollaboratorPermission.md b/docs/RepoCollaboratorPermission.md index 96e4f15..1679171 100644 --- a/docs/RepoCollaboratorPermission.md +++ b/docs/RepoCollaboratorPermission.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**permission** | [**PermissionEnum**](#PermissionEnum) | Permission level of the collaborator none AccessLevelNameNone read AccessLevelNameRead write AccessLevelNameWrite admin AccessLevelNameAdmin owner AccessLevelNameOwner | [optional] +**permission** | [**PermissionEnum**](#PermissionEnum) | Permission level of the collaborator | [optional] **roleName** | **String** | RoleName is the name of the permission role | [optional] **user** | [**User**](User.md) | | [optional] diff --git a/docs/Repository.md b/docs/Repository.md index 8a622dd..107c30f 100644 --- a/docs/Repository.md +++ b/docs/Repository.md @@ -53,7 +53,7 @@ Name | Type | Description | Notes **mirrorLastSyncAt** | [**Date**](Date.md) | | [optional] **mirrorUpdated** | [**Date**](Date.md) | | [optional] **name** | **String** | | [optional] -**objectFormatName** | [**ObjectFormatNameEnum**](#ObjectFormatNameEnum) | ObjectFormatName of the underlying git repository sha1 ObjectFormatSHA1 sha256 ObjectFormatSHA256 | [optional] +**objectFormatName** | [**ObjectFormatNameEnum**](#ObjectFormatNameEnum) | ObjectFormatName of the underlying git repository | [optional] **openIssuesCount** | **Long** | | [optional] **openPrCounter** | **Long** | | [optional] **originalUrl** | **String** | | [optional] diff --git a/docs/StopWatch.md b/docs/StopWatch.md index d52d820..16d4cef 100644 --- a/docs/StopWatch.md +++ b/docs/StopWatch.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | [**Date**](Date.md) | | [optional] +**created** | [**Date**](Date.md) | Created is the time when the stopwatch was started | [optional] **duration** | **String** | Duration is a human-readable duration string | [optional] **issueIndex** | **Long** | IssueIndex is the index number of the associated issue | [optional] **issueTitle** | **String** | IssueTitle is the title of the associated issue | [optional] diff --git a/docs/TagProtection.md b/docs/TagProtection.md index 1e9feb0..f9d7b03 100644 --- a/docs/TagProtection.md +++ b/docs/TagProtection.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**createdAt** | [**Date**](Date.md) | | [optional] +**createdAt** | [**Date**](Date.md) | The date and time when the tag protection was created | [optional] **id** | **Long** | The unique identifier of the tag protection | [optional] **namePattern** | **String** | The pattern to match tag names for protection | [optional] -**updatedAt** | [**Date**](Date.md) | | [optional] +**updatedAt** | [**Date**](Date.md) | The date and time when the tag protection was last updated | [optional] **whitelistTeams** | **List<String>** | List of team names allowed to create/delete protected tags | [optional] **whitelistUsernames** | **List<String>** | List of usernames allowed to create/delete protected tags | [optional] diff --git a/docs/Team.md b/docs/Team.md index 675d5a7..49a35af 100644 --- a/docs/Team.md +++ b/docs/Team.md @@ -10,9 +10,9 @@ Name | Type | Description | Notes **name** | **String** | The name of the team | [optional] **organization** | [**Organization**](Organization.md) | | [optional] **permission** | [**PermissionEnum**](#PermissionEnum) | | [optional] -**units** | **List<String>** | | [optional] +**units** | **List<String>** | Deprecated: This variable should be replaced by UnitsMap and will be dropped in later versions. | [optional] **unitsMap** | **Map<String, String>** | | [optional] -**visibility** | [**VisibilityEnum**](#VisibilityEnum) | Team visibility within the organization. \"private\" teams are only listable by members and org owners; \"limited\" teams are listable by any organization member; \"public\" teams are listable by any signed-in user. public TeamVisibilityPublic limited TeamVisibilityLimited private TeamVisibilityPrivate | [optional] +**visibility** | [**VisibilityEnum**](#VisibilityEnum) | Team visibility within the organization. \"private\" teams are only listable by members and org owners; \"limited\" teams are listable by any organization member; \"public\" teams are listable by any signed-in user. | [optional] ## Enum: PermissionEnum diff --git a/docs/User.md b/docs/User.md index 4e2b094..9ec1624 100644 --- a/docs/User.md +++ b/docs/User.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes **restricted** | **Boolean** | Is user restricted | [optional] **sourceId** | **Long** | The ID of the user's Authentication Source | [optional] **starredReposCount** | **Long** | | [optional] -**visibility** | [**VisibilityEnum**](#VisibilityEnum) | User visibility level option: public, limited, private public UserVisibilityPublic limited UserVisibilityLimited private UserVisibilityPrivate | [optional] +**visibility** | [**VisibilityEnum**](#VisibilityEnum) | User visibility level option: public, limited, private | [optional] **website** | **String** | the user's website | [optional] diff --git a/src/main/java/org/gitnex/tea4j/v2/models/AddCollaboratorOption.java b/src/main/java/org/gitnex/tea4j/v2/models/AddCollaboratorOption.java index f60a2ee..9e810c4 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/AddCollaboratorOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/AddCollaboratorOption.java @@ -28,10 +28,7 @@ import java.util.Objects; "AddCollaboratorOption options when adding a user as a collaborator of a repository") public class AddCollaboratorOption implements Serializable { private static final long serialVersionUID = 1L; - /** - * Permission level to grant the collaborator read RepoWritePermissionRead write - * RepoWritePermissionWrite admin RepoWritePermissionAdmin - */ + /** Permission level to grant the collaborator */ @JsonAdapter(PermissionEnum.Adapter.class) public enum PermissionEnum { READ("read"), @@ -86,15 +83,11 @@ public class AddCollaboratorOption implements Serializable { } /** - * Permission level to grant the collaborator read RepoWritePermissionRead write - * RepoWritePermissionWrite admin RepoWritePermissionAdmin + * Permission level to grant the collaborator * * @return permission */ - @Schema( - description = - "Permission level to grant the collaborator read RepoWritePermissionRead write" - + " RepoWritePermissionWrite admin RepoWritePermissionAdmin") + @Schema(description = "Permission level to grant the collaborator") public PermissionEnum getPermission() { return permission; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/Attachment.java b/src/main/java/org/gitnex/tea4j/v2/models/Attachment.java index 7956ea1..1501916 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/Attachment.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/Attachment.java @@ -69,11 +69,11 @@ public class Attachment implements Serializable { } /** - * Get createdAt + * Created is the time when the attachment was uploaded * * @return createdAt */ - @Schema(description = "") + @Schema(description = "Created is the time when the attachment was uploaded") public Date getCreatedAt() { return createdAt; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/BranchProtection.java b/src/main/java/org/gitnex/tea4j/v2/models/BranchProtection.java index 770485e..efd8585 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/BranchProtection.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/BranchProtection.java @@ -269,11 +269,11 @@ public class BranchProtection implements Serializable { } /** - * Deprecated: true + * Get branchName * * @return branchName */ - @Schema(description = "Deprecated: true") + @Schema(description = "") public String getBranchName() { return branchName; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/CombinedStatus.java b/src/main/java/org/gitnex/tea4j/v2/models/CombinedStatus.java index 6fa615c..12cf3f3 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CombinedStatus.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CombinedStatus.java @@ -39,13 +39,7 @@ public class CombinedStatus implements Serializable { @SerializedName("sha") private String sha = null; - /** - * State is the overall combined status state pending CommitStatusPending is for when the - * CommitStatus is Pending success CommitStatusSuccess is for when the CommitStatus is Success - * error CommitStatusError is for when the CommitStatus is Error failure CommitStatusFailure is - * for when the CommitStatus is Failure warning CommitStatusWarning is for when the CommitStatus - * is Warning skipped CommitStatusSkipped is for when CommitStatus is Skipped - */ + /** State is the overall combined status state */ @JsonAdapter(StateEnum.Adapter.class) public enum StateEnum { PENDING("pending"), @@ -169,22 +163,11 @@ public class CombinedStatus implements Serializable { } /** - * State is the overall combined status state pending CommitStatusPending is for when the - * CommitStatus is Pending success CommitStatusSuccess is for when the CommitStatus is Success - * error CommitStatusError is for when the CommitStatus is Error failure CommitStatusFailure is - * for when the CommitStatus is Failure warning CommitStatusWarning is for when the CommitStatus - * is Warning skipped CommitStatusSkipped is for when CommitStatus is Skipped + * State is the overall combined status state * * @return state */ - @Schema( - description = - "State is the overall combined status state pending CommitStatusPending is for when the" - + " CommitStatus is Pending success CommitStatusSuccess is for when the CommitStatus" - + " is Success error CommitStatusError is for when the CommitStatus is Error failure" - + " CommitStatusFailure is for when the CommitStatus is Failure warning" - + " CommitStatusWarning is for when the CommitStatus is Warning skipped" - + " CommitStatusSkipped is for when CommitStatus is Skipped") + @Schema(description = "State is the overall combined status state") public StateEnum getState() { return state; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/Commit.java b/src/main/java/org/gitnex/tea4j/v2/models/Commit.java index c67468d..38e1628 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/Commit.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/Commit.java @@ -117,11 +117,11 @@ public class Commit implements Serializable { } /** - * Get created + * Created is the time when the commit was created * * @return created */ - @Schema(description = "") + @Schema(description = "Created is the time when the commit was created") public Date getCreated() { return created; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/CommitDateOptions.java b/src/main/java/org/gitnex/tea4j/v2/models/CommitDateOptions.java index 3ad2659..c6359fd 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CommitDateOptions.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CommitDateOptions.java @@ -35,11 +35,11 @@ public class CommitDateOptions implements Serializable { } /** - * Get author + * Author is the author date for the commit * * @return author */ - @Schema(description = "") + @Schema(description = "Author is the author date for the commit") public Date getAuthor() { return author; } @@ -54,11 +54,11 @@ public class CommitDateOptions implements Serializable { } /** - * Get committer + * Committer is the committer date for the commit * * @return committer */ - @Schema(description = "") + @Schema(description = "Committer is the committer date for the commit") public Date getCommitter() { return committer; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/CommitMeta.java b/src/main/java/org/gitnex/tea4j/v2/models/CommitMeta.java index a57d80c..9d41d23 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CommitMeta.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CommitMeta.java @@ -37,11 +37,11 @@ public class CommitMeta implements Serializable { } /** - * Get created + * Created is the time when the commit was created * * @return created */ - @Schema(description = "") + @Schema(description = "Created is the time when the commit was created") public Date getCreated() { return created; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/CommitStatus.java b/src/main/java/org/gitnex/tea4j/v2/models/CommitStatus.java index 510c311..1ba3186 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CommitStatus.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CommitStatus.java @@ -43,14 +43,7 @@ public class CommitStatus implements Serializable { @SerializedName("id") private Long id = null; - /** - * State represents the status state (pending, success, error, failure) pending - * CommitStatusPending is for when the CommitStatus is Pending success CommitStatusSuccess is for - * when the CommitStatus is Success error CommitStatusError is for when the CommitStatus is Error - * failure CommitStatusFailure is for when the CommitStatus is Failure warning CommitStatusWarning - * is for when the CommitStatus is Warning skipped CommitStatusSkipped is for when CommitStatus is - * Skipped - */ + /** State represents the status state (pending, success, error, failure) */ @JsonAdapter(StatusEnum.Adapter.class) public enum StatusEnum { PENDING("pending"), @@ -212,24 +205,11 @@ public class CommitStatus implements Serializable { } /** - * State represents the status state (pending, success, error, failure) pending - * CommitStatusPending is for when the CommitStatus is Pending success CommitStatusSuccess is for - * when the CommitStatus is Success error CommitStatusError is for when the CommitStatus is Error - * failure CommitStatusFailure is for when the CommitStatus is Failure warning CommitStatusWarning - * is for when the CommitStatus is Warning skipped CommitStatusSkipped is for when CommitStatus is - * Skipped + * State represents the status state (pending, success, error, failure) * * @return status */ - @Schema( - description = - "State represents the status state (pending, success, error, failure) pending" - + " CommitStatusPending is for when the CommitStatus is Pending success" - + " CommitStatusSuccess is for when the CommitStatus is Success error" - + " CommitStatusError is for when the CommitStatus is Error failure" - + " CommitStatusFailure is for when the CommitStatus is Failure warning" - + " CommitStatusWarning is for when the CommitStatus is Warning skipped" - + " CommitStatusSkipped is for when CommitStatus is Skipped") + @Schema(description = "State represents the status state (pending, success, error, failure)") public StatusEnum getStatus() { return status; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/CommitUser.java b/src/main/java/org/gitnex/tea4j/v2/models/CommitUser.java index d38789e..57421d4 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CommitUser.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CommitUser.java @@ -55,11 +55,11 @@ public class CommitUser implements Serializable { } /** - * Get email + * Email is the person's email address * * @return email */ - @Schema(description = "") + @Schema(description = "Email is the person's email address") public String getEmail() { return email; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/CreateBranchProtectionOption.java b/src/main/java/org/gitnex/tea4j/v2/models/CreateBranchProtectionOption.java index 464563d..5401749 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CreateBranchProtectionOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CreateBranchProtectionOption.java @@ -267,11 +267,11 @@ public class CreateBranchProtectionOption implements Serializable { } /** - * Deprecated: true + * Get branchName * * @return branchName */ - @Schema(description = "Deprecated: true") + @Schema(description = "") public String getBranchName() { return branchName; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/CreateBranchRepoOption.java b/src/main/java/org/gitnex/tea4j/v2/models/CreateBranchRepoOption.java index 2fc4da6..897a274 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CreateBranchRepoOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CreateBranchRepoOption.java @@ -56,11 +56,11 @@ public class CreateBranchRepoOption implements Serializable { } /** - * Deprecated: true Name of the old branch to create from + * Name of the old branch to create from * * @return oldBranchName */ - @Schema(description = "Deprecated: true Name of the old branch to create from") + @Schema(description = "Name of the old branch to create from") public String getOldBranchName() { return oldBranchName; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/CreateHookOption.java b/src/main/java/org/gitnex/tea4j/v2/models/CreateHookOption.java index b57fe1b..efad363 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CreateHookOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CreateHookOption.java @@ -47,7 +47,7 @@ public class CreateHookOption implements Serializable { @SerializedName("name") private String name = null; - /** Gets or Sets type */ + /** The type of the webhook to create */ @JsonAdapter(TypeEnum.Adapter.class) public enum TypeEnum { DINGTALK("dingtalk"), @@ -109,11 +109,11 @@ public class CreateHookOption implements Serializable { } /** - * Get active + * Whether the webhook should be active upon creation * * @return active */ - @Schema(description = "") + @Schema(description = "Whether the webhook should be active upon creation") public Boolean isActive() { return active; } @@ -231,11 +231,11 @@ public class CreateHookOption implements Serializable { } /** - * Get type + * The type of the webhook to create * * @return type */ - @Schema(required = true, description = "") + @Schema(required = true, description = "The type of the webhook to create") public TypeEnum getType() { return type; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/CreateIssueCommentOption.java b/src/main/java/org/gitnex/tea4j/v2/models/CreateIssueCommentOption.java index d20c37c..ac08e4e 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CreateIssueCommentOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CreateIssueCommentOption.java @@ -31,11 +31,11 @@ public class CreateIssueCommentOption implements Serializable { } /** - * Get body + * Body is the comment text content * * @return body */ - @Schema(required = true, description = "") + @Schema(required = true, description = "Body is the comment text content") public String getBody() { return body; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/CreateLabelOption.java b/src/main/java/org/gitnex/tea4j/v2/models/CreateLabelOption.java index 9ae7d14..3e87785 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CreateLabelOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CreateLabelOption.java @@ -119,11 +119,11 @@ public class CreateLabelOption implements Serializable { } /** - * Get name + * Name is the display name for the new label * * @return name */ - @Schema(required = true, description = "") + @Schema(required = true, description = "Name is the display name for the new label") public String getName() { return name; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/CreateMilestoneOption.java b/src/main/java/org/gitnex/tea4j/v2/models/CreateMilestoneOption.java index e89ba0b..9b8605d 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CreateMilestoneOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CreateMilestoneOption.java @@ -34,7 +34,7 @@ public class CreateMilestoneOption implements Serializable { @SerializedName("due_on") private Date dueOn = null; - /** Gets or Sets state */ + /** State indicates the initial state of the milestone */ @JsonAdapter(StateEnum.Adapter.class) public enum StateEnum { OPEN("open"), @@ -110,11 +110,11 @@ public class CreateMilestoneOption implements Serializable { } /** - * Get dueOn + * Deadline is the due date for the milestone * * @return dueOn */ - @Schema(description = "") + @Schema(description = "Deadline is the due date for the milestone") public Date getDueOn() { return dueOn; } @@ -129,11 +129,11 @@ public class CreateMilestoneOption implements Serializable { } /** - * Get state + * State indicates the initial state of the milestone * * @return state */ - @Schema(description = "") + @Schema(description = "State indicates the initial state of the milestone") public StateEnum getState() { return state; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/CreateOrgOption.java b/src/main/java/org/gitnex/tea4j/v2/models/CreateOrgOption.java index 729432a..03e2d04 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CreateOrgOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CreateOrgOption.java @@ -47,7 +47,6 @@ public class CreateOrgOption implements Serializable { /** * possible values are `public` (default), `limited` or `private` - * public UserVisibilityPublic limited UserVisibilityLimited private UserVisibilityPrivate */ @JsonAdapter(VisibilityEnum.Adapter.class) public enum VisibilityEnum { @@ -221,14 +220,10 @@ public class CreateOrgOption implements Serializable { /** * possible values are `public` (default), `limited` or `private` - * public UserVisibilityPublic limited UserVisibilityLimited private UserVisibilityPrivate * * @return visibility */ - @Schema( - description = - "possible values are `public` (default), `limited` or `private` public" - + " UserVisibilityPublic limited UserVisibilityLimited private UserVisibilityPrivate") + @Schema(description = "possible values are `public` (default), `limited` or `private`") public VisibilityEnum getVisibility() { return visibility; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/CreateRepoOption.java b/src/main/java/org/gitnex/tea4j/v2/models/CreateRepoOption.java index caa4153..5fb2532 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CreateRepoOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CreateRepoOption.java @@ -48,10 +48,7 @@ public class CreateRepoOption implements Serializable { @SerializedName("name") private String name = null; - /** - * ObjectFormatName of the underlying git repository, empty string for default (sha1) sha1 - * ObjectFormatSHA1 sha256 ObjectFormatSHA256 - */ + /** ObjectFormatName of the underlying git repository, empty string for default (sha1) */ @JsonAdapter(ObjectFormatNameEnum.Adapter.class) public enum ObjectFormatNameEnum { SHA1("sha1"), @@ -297,15 +294,13 @@ public class CreateRepoOption implements Serializable { } /** - * ObjectFormatName of the underlying git repository, empty string for default (sha1) sha1 - * ObjectFormatSHA1 sha256 ObjectFormatSHA256 + * ObjectFormatName of the underlying git repository, empty string for default (sha1) * * @return objectFormatName */ @Schema( description = - "ObjectFormatName of the underlying git repository, empty string for default (sha1) sha1" - + " ObjectFormatSHA1 sha256 ObjectFormatSHA256") + "ObjectFormatName of the underlying git repository, empty string for default (sha1)") public ObjectFormatNameEnum getObjectFormatName() { return objectFormatName; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/CreateStatusOption.java b/src/main/java/org/gitnex/tea4j/v2/models/CreateStatusOption.java index f536946..20da175 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CreateStatusOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CreateStatusOption.java @@ -35,14 +35,7 @@ public class CreateStatusOption implements Serializable { @SerializedName("description") private String description = null; - /** - * State represents the status state to set (pending, success, error, failure) pending - * CommitStatusPending is for when the CommitStatus is Pending success CommitStatusSuccess is for - * when the CommitStatus is Success error CommitStatusError is for when the CommitStatus is Error - * failure CommitStatusFailure is for when the CommitStatus is Failure warning CommitStatusWarning - * is for when the CommitStatus is Warning skipped CommitStatusSkipped is for when CommitStatus is - * Skipped - */ + /** State represents the status state to set (pending, success, error, failure) */ @JsonAdapter(StateEnum.Adapter.class) public enum StateEnum { PENDING("pending"), @@ -141,24 +134,12 @@ public class CreateStatusOption implements Serializable { } /** - * State represents the status state to set (pending, success, error, failure) pending - * CommitStatusPending is for when the CommitStatus is Pending success CommitStatusSuccess is for - * when the CommitStatus is Success error CommitStatusError is for when the CommitStatus is Error - * failure CommitStatusFailure is for when the CommitStatus is Failure warning CommitStatusWarning - * is for when the CommitStatus is Warning skipped CommitStatusSkipped is for when CommitStatus is - * Skipped + * State represents the status state to set (pending, success, error, failure) * * @return state */ @Schema( - description = - "State represents the status state to set (pending, success, error, failure) pending" - + " CommitStatusPending is for when the CommitStatus is Pending success" - + " CommitStatusSuccess is for when the CommitStatus is Success error" - + " CommitStatusError is for when the CommitStatus is Error failure" - + " CommitStatusFailure is for when the CommitStatus is Failure warning" - + " CommitStatusWarning is for when the CommitStatus is Warning skipped" - + " CommitStatusSkipped is for when CommitStatus is Skipped") + description = "State represents the status state to set (pending, success, error, failure)") public StateEnum getState() { return state; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/CreateTagOption.java b/src/main/java/org/gitnex/tea4j/v2/models/CreateTagOption.java index 3ce9643..c9f1728 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CreateTagOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CreateTagOption.java @@ -56,11 +56,11 @@ public class CreateTagOption implements Serializable { } /** - * Get tagName + * The name of the tag to create * * @return tagName */ - @Schema(required = true, description = "") + @Schema(required = true, description = "The name of the tag to create") public String getTagName() { return tagName; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/CreateTeamOption.java b/src/main/java/org/gitnex/tea4j/v2/models/CreateTeamOption.java index 465057b..4a8ac8f 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CreateTeamOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CreateTeamOption.java @@ -98,10 +98,7 @@ public class CreateTeamOption implements Serializable { @SerializedName("units_map") private Map unitsMap = null; - /** - * Team visibility within the organization. Defaults to \"private\". public - * TeamVisibilityPublic limited TeamVisibilityLimited private TeamVisibilityPrivate - */ + /** Team visibility within the organization. Defaults to \"private\". */ @JsonAdapter(VisibilityEnum.Adapter.class) public enum VisibilityEnum { PUBLIC("public"), @@ -259,14 +256,16 @@ public class CreateTeamOption implements Serializable { } /** - * Get units + * Deprecated: This variable should be replaced by UnitsMap and will be dropped in later versions. * * @return units */ @Schema( example = - "[\"repo.actions\",\"repo.code\",\"repo.issues\",\"repo.ext_issues\",\"repo.wiki\",\"repo.ext_wiki\",\"repo.pulls\",\"repo.releases\",\"repo.projects\",\"repo.ext_wiki\"]", - description = "") + "[\"repo.actions\",\"repo.packages\",\"repo.code\",\"repo.issues\",\"repo.ext_issues\",\"repo.wiki\",\"repo.pulls\",\"repo.releases\",\"repo.projects\",\"repo.ext_wiki\"]", + description = + "Deprecated: This variable should be replaced by UnitsMap and will be dropped in later" + + " versions.") public List getUnits() { return units; } @@ -295,7 +294,7 @@ public class CreateTeamOption implements Serializable { */ @Schema( example = - "{\"repo.actions\",\"repo.packages\",\"repo.code\":\"read\",\"repo.issues\":\"write\",\"repo.ext_issues\":\"none\",\"repo.wiki\":\"admin\",\"repo.pulls\":\"owner\",\"repo.releases\":\"none\",\"repo.projects\":\"none\",\"repo.ext_wiki\":\"none\"}", + "{\"repo.actions\":\"read\",\"repo.code\":\"read\",\"repo.ext_issues\":\"none\",\"repo.ext_wiki\":\"none\",\"repo.issues\":\"write\",\"repo.packages\":\"read\",\"repo.projects\":\"none\",\"repo.pulls\":\"owner\",\"repo.releases\":\"none\",\"repo.wiki\":\"admin\"}", description = "") public Map getUnitsMap() { return unitsMap; @@ -311,15 +310,11 @@ public class CreateTeamOption implements Serializable { } /** - * Team visibility within the organization. Defaults to \"private\". public - * TeamVisibilityPublic limited TeamVisibilityLimited private TeamVisibilityPrivate + * Team visibility within the organization. Defaults to \"private\". * * @return visibility */ - @Schema( - description = - "Team visibility within the organization. Defaults to \"private\". public" - + " TeamVisibilityPublic limited TeamVisibilityLimited private TeamVisibilityPrivate") + @Schema(description = "Team visibility within the organization. Defaults to \"private\".") public VisibilityEnum getVisibility() { return visibility; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/CreateUserOption.java b/src/main/java/org/gitnex/tea4j/v2/models/CreateUserOption.java index 693fe06..79813e1 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CreateUserOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CreateUserOption.java @@ -58,10 +58,7 @@ public class CreateUserOption implements Serializable { @SerializedName("username") private String username = null; - /** - * User visibility level: public, limited, or private public UserVisibilityPublic limited - * UserVisibilityLimited private UserVisibilityPrivate - */ + /** User visibility level: public, limited, or private */ @JsonAdapter(VisibilityEnum.Adapter.class) public enum VisibilityEnum { PUBLIC("public"), @@ -313,15 +310,11 @@ public class CreateUserOption implements Serializable { } /** - * User visibility level: public, limited, or private public UserVisibilityPublic limited - * UserVisibilityLimited private UserVisibilityPrivate + * User visibility level: public, limited, or private * * @return visibility */ - @Schema( - description = - "User visibility level: public, limited, or private public UserVisibilityPublic limited" - + " UserVisibilityLimited private UserVisibilityPrivate") + @Schema(description = "User visibility level: public, limited, or private") public VisibilityEnum getVisibility() { return visibility; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/DeployKey.java b/src/main/java/org/gitnex/tea4j/v2/models/DeployKey.java index ff4fec2..b34a526 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/DeployKey.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/DeployKey.java @@ -56,11 +56,11 @@ public class DeployKey implements Serializable { } /** - * Get createdAt + * Created is the time when the deploy key was added * * @return createdAt */ - @Schema(description = "") + @Schema(description = "Created is the time when the deploy key was added") public Date getCreatedAt() { return createdAt; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/EditIssueCommentOption.java b/src/main/java/org/gitnex/tea4j/v2/models/EditIssueCommentOption.java index c8b2e4e..7e7a3a0 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/EditIssueCommentOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/EditIssueCommentOption.java @@ -31,11 +31,11 @@ public class EditIssueCommentOption implements Serializable { } /** - * Get body + * Body is the updated comment text content * * @return body */ - @Schema(required = true, description = "") + @Schema(required = true, description = "Body is the updated comment text content") public String getBody() { return body; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/EditOrgOption.java b/src/main/java/org/gitnex/tea4j/v2/models/EditOrgOption.java index e708752..8acaa27 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/EditOrgOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/EditOrgOption.java @@ -42,10 +42,7 @@ public class EditOrgOption implements Serializable { @SerializedName("repo_admin_change_team_access") private Boolean repoAdminChangeTeamAccess = null; - /** - * possible values are `public`, `limited` or `private` public - * UserVisibilityPublic limited UserVisibilityLimited private UserVisibilityPrivate - */ + /** possible values are `public`, `limited` or `private` */ @JsonAdapter(VisibilityEnum.Adapter.class) public enum VisibilityEnum { PUBLIC("public"), @@ -198,15 +195,11 @@ public class EditOrgOption implements Serializable { } /** - * possible values are `public`, `limited` or `private` public - * UserVisibilityPublic limited UserVisibilityLimited private UserVisibilityPrivate + * possible values are `public`, `limited` or `private` * * @return visibility */ - @Schema( - description = - "possible values are `public`, `limited` or `private` public UserVisibilityPublic limited" - + " UserVisibilityLimited private UserVisibilityPrivate") + @Schema(description = "possible values are `public`, `limited` or `private`") public VisibilityEnum getVisibility() { return visibility; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/EditTeamOption.java b/src/main/java/org/gitnex/tea4j/v2/models/EditTeamOption.java index dcdd544..7a7b596 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/EditTeamOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/EditTeamOption.java @@ -98,10 +98,7 @@ public class EditTeamOption implements Serializable { @SerializedName("units_map") private Map unitsMap = null; - /** - * Team visibility within the organization. When omitted, visibility is left unchanged. public - * TeamVisibilityPublic limited TeamVisibilityLimited private TeamVisibilityPrivate - */ + /** Team visibility within the organization. When omitted, visibility is left unchanged. */ @JsonAdapter(VisibilityEnum.Adapter.class) public enum VisibilityEnum { PUBLIC("public"), @@ -259,14 +256,16 @@ public class EditTeamOption implements Serializable { } /** - * Get units + * Deprecated: This variable should be replaced by UnitsMap and will be dropped in later versions. * * @return units */ @Schema( example = "[\"repo.code\",\"repo.issues\",\"repo.ext_issues\",\"repo.wiki\",\"repo.pulls\",\"repo.releases\",\"repo.projects\",\"repo.ext_wiki\"]", - description = "") + description = + "Deprecated: This variable should be replaced by UnitsMap and will be dropped in later" + + " versions.") public List getUnits() { return units; } @@ -311,16 +310,13 @@ public class EditTeamOption implements Serializable { } /** - * Team visibility within the organization. When omitted, visibility is left unchanged. public - * TeamVisibilityPublic limited TeamVisibilityLimited private TeamVisibilityPrivate + * Team visibility within the organization. When omitted, visibility is left unchanged. * * @return visibility */ @Schema( description = - "Team visibility within the organization. When omitted, visibility is left unchanged." - + " public TeamVisibilityPublic limited TeamVisibilityLimited private" - + " TeamVisibilityPrivate") + "Team visibility within the organization. When omitted, visibility is left unchanged.") public VisibilityEnum getVisibility() { return visibility; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/EditUserOption.java b/src/main/java/org/gitnex/tea4j/v2/models/EditUserOption.java index e17ddf1..e4c5691 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/EditUserOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/EditUserOption.java @@ -75,10 +75,7 @@ public class EditUserOption implements Serializable { @SerializedName("source_id") private Long sourceId = null; - /** - * User visibility level: public, limited, or private public UserVisibilityPublic limited - * UserVisibilityLimited private UserVisibilityPrivate - */ + /** User visibility level: public, limited, or private */ @JsonAdapter(VisibilityEnum.Adapter.class) public enum VisibilityEnum { PUBLIC("public"), @@ -250,11 +247,11 @@ public class EditUserOption implements Serializable { } /** - * Get email + * The email address of the user * * @return email */ - @Schema(description = "") + @Schema(description = "The email address of the user") public String getEmail() { return email; } @@ -424,11 +421,11 @@ public class EditUserOption implements Serializable { } /** - * Get sourceId + * The authentication source ID to associate with the user * * @return sourceId */ - @Schema(required = true, description = "") + @Schema(required = true, description = "The authentication source ID to associate with the user") public Long getSourceId() { return sourceId; } @@ -443,15 +440,11 @@ public class EditUserOption implements Serializable { } /** - * User visibility level: public, limited, or private public UserVisibilityPublic limited - * UserVisibilityLimited private UserVisibilityPrivate + * User visibility level: public, limited, or private * * @return visibility */ - @Schema( - description = - "User visibility level: public, limited, or private public UserVisibilityPublic limited" - + " UserVisibilityLimited private UserVisibilityPrivate") + @Schema(description = "User visibility level: public, limited, or private") public VisibilityEnum getVisibility() { return visibility; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/Email.java b/src/main/java/org/gitnex/tea4j/v2/models/Email.java index 002596c..51447b8 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/Email.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/Email.java @@ -43,11 +43,11 @@ public class Email implements Serializable { } /** - * Get email + * The email address * * @return email */ - @Schema(description = "") + @Schema(description = "The email address") public String getEmail() { return email; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/FileCommitResponse.java b/src/main/java/org/gitnex/tea4j/v2/models/FileCommitResponse.java index 16df951..262049b 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/FileCommitResponse.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/FileCommitResponse.java @@ -95,11 +95,11 @@ public class FileCommitResponse implements Serializable { } /** - * Get created + * Created is the time when the commit was created * * @return created */ - @Schema(description = "") + @Schema(description = "Created is the time when the commit was created") public Date getCreated() { return created; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/GPGKey.java b/src/main/java/org/gitnex/tea4j/v2/models/GPGKey.java index 6d39f2e..5dfb108 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/GPGKey.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/GPGKey.java @@ -146,11 +146,11 @@ public class GPGKey implements Serializable { } /** - * Get createdAt + * The date and time when the GPG key was created * * @return createdAt */ - @Schema(description = "") + @Schema(description = "The date and time when the GPG key was created") public Date getCreatedAt() { return createdAt; } @@ -192,11 +192,11 @@ public class GPGKey implements Serializable { } /** - * Get expiresAt + * The date and time when the GPG key expires * * @return expiresAt */ - @Schema(description = "") + @Schema(description = "The date and time when the GPG key expires") public Date getExpiresAt() { return expiresAt; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/Hook.java b/src/main/java/org/gitnex/tea4j/v2/models/Hook.java index 4a9f745..05ae728 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/Hook.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/Hook.java @@ -147,11 +147,11 @@ public class Hook implements Serializable { } /** - * Get createdAt + * The date and time when the webhook was created * * @return createdAt */ - @Schema(description = "") + @Schema(description = "The date and time when the webhook was created") public Date getCreatedAt() { return createdAt; } @@ -250,11 +250,11 @@ public class Hook implements Serializable { } /** - * Get updatedAt + * The date and time when the webhook was last updated * * @return updatedAt */ - @Schema(description = "") + @Schema(description = "The date and time when the webhook was last updated") public Date getUpdatedAt() { return updatedAt; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/Identity.java b/src/main/java/org/gitnex/tea4j/v2/models/Identity.java index 853f860..4965289 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/Identity.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/Identity.java @@ -34,11 +34,11 @@ public class Identity implements Serializable { } /** - * Get email + * Email is the person's email address * * @return email */ - @Schema(description = "") + @Schema(description = "Email is the person's email address") public String getEmail() { return email; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/MarkdownOption.java b/src/main/java/org/gitnex/tea4j/v2/models/MarkdownOption.java index a6e1088..fcd305a 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/MarkdownOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/MarkdownOption.java @@ -101,11 +101,11 @@ public class MarkdownOption implements Serializable { } /** - * Is it a wiki page? (use mode=wiki instead) Deprecated: true + * Is it a wiki page? (use mode=wiki instead) * * @return wiki */ - @Schema(description = "Is it a wiki page? (use mode=wiki instead) Deprecated: true") + @Schema(description = "Is it a wiki page? (use mode=wiki instead)") public Boolean isWiki() { return wiki; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/MarkupOption.java b/src/main/java/org/gitnex/tea4j/v2/models/MarkupOption.java index d657bce..752997d 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/MarkupOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/MarkupOption.java @@ -123,11 +123,11 @@ public class MarkupOption implements Serializable { } /** - * Is it a wiki page? (use mode=wiki instead) Deprecated: true + * Is it a wiki page? (use mode=wiki instead) * * @return wiki */ - @Schema(description = "Is it a wiki page? (use mode=wiki instead) Deprecated: true") + @Schema(description = "Is it a wiki page? (use mode=wiki instead)") public Boolean isWiki() { return wiki; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/Milestone.java b/src/main/java/org/gitnex/tea4j/v2/models/Milestone.java index e5aa25f..c4791f0 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/Milestone.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/Milestone.java @@ -49,10 +49,7 @@ public class Milestone implements Serializable { @SerializedName("open_issues") private Long openIssues = null; - /** - * State indicates if the milestone is open or closed open StateOpen pr is opened closed - * StateClosed pr is closed - */ + /** State indicates if the milestone is open or closed */ @JsonAdapter(StateEnum.Adapter.class) public enum StateEnum { OPEN("open"), @@ -245,15 +242,11 @@ public class Milestone implements Serializable { } /** - * State indicates if the milestone is open or closed open StateOpen pr is opened closed - * StateClosed pr is closed + * State indicates if the milestone is open or closed * * @return state */ - @Schema( - description = - "State indicates if the milestone is open or closed open StateOpen pr is opened closed" - + " StateClosed pr is closed") + @Schema(description = "State indicates if the milestone is open or closed") public StateEnum getState() { return state; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/ModelPackage.java b/src/main/java/org/gitnex/tea4j/v2/models/ModelPackage.java index 253cf83..c8e5140 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/ModelPackage.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/ModelPackage.java @@ -56,11 +56,11 @@ public class ModelPackage implements Serializable { } /** - * Get createdAt + * The date and time when the package was created * * @return createdAt */ - @Schema(description = "") + @Schema(description = "The date and time when the package was created") public Date getCreatedAt() { return createdAt; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/NotificationSubject.java b/src/main/java/org/gitnex/tea4j/v2/models/NotificationSubject.java index f26897c..d41503f 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/NotificationSubject.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/NotificationSubject.java @@ -36,11 +36,7 @@ public class NotificationSubject implements Serializable { @SerializedName("latest_comment_url") private String latestCommentUrl = null; - /** - * State indicates the current state of the notification subject open NotifySubjectStateOpen is an - * open subject closed NotifySubjectStateClosed is a closed subject merged - * NotifySubjectStateMerged is a merged pull request - */ + /** State indicates the current state of the notification subject */ @JsonAdapter(StateEnum.Adapter.class) public enum StateEnum { OPEN("open"), @@ -92,12 +88,7 @@ public class NotificationSubject implements Serializable { @SerializedName("title") private String title = null; - /** - * Type indicates the type of the notification subject Issue NotifySubjectIssue a issue is subject - * of an notification Pull NotifySubjectPull a pull is subject of an notification Commit - * NotifySubjectCommit a commit is subject of an notification Repository NotifySubjectRepository a - * repository is subject of an notification - */ + /** Type indicates the type of the notification subject */ @JsonAdapter(TypeEnum.Adapter.class) public enum TypeEnum { ISSUE("Issue"), @@ -213,17 +204,11 @@ public class NotificationSubject implements Serializable { } /** - * State indicates the current state of the notification subject open NotifySubjectStateOpen is an - * open subject closed NotifySubjectStateClosed is a closed subject merged - * NotifySubjectStateMerged is a merged pull request + * State indicates the current state of the notification subject * * @return state */ - @Schema( - description = - "State indicates the current state of the notification subject open" - + " NotifySubjectStateOpen is an open subject closed NotifySubjectStateClosed is a" - + " closed subject merged NotifySubjectStateMerged is a merged pull request") + @Schema(description = "State indicates the current state of the notification subject") public StateEnum getState() { return state; } @@ -257,19 +242,11 @@ public class NotificationSubject implements Serializable { } /** - * Type indicates the type of the notification subject Issue NotifySubjectIssue a issue is subject - * of an notification Pull NotifySubjectPull a pull is subject of an notification Commit - * NotifySubjectCommit a commit is subject of an notification Repository NotifySubjectRepository a - * repository is subject of an notification + * Type indicates the type of the notification subject * * @return type */ - @Schema( - description = - "Type indicates the type of the notification subject Issue NotifySubjectIssue a issue is" - + " subject of an notification Pull NotifySubjectPull a pull is subject of an" - + " notification Commit NotifySubjectCommit a commit is subject of an notification" - + " Repository NotifySubjectRepository a repository is subject of an notification") + @Schema(description = "Type indicates the type of the notification subject") public TypeEnum getType() { return type; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/Organization.java b/src/main/java/org/gitnex/tea4j/v2/models/Organization.java index 145f6c6..b7648e3 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/Organization.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/Organization.java @@ -54,10 +54,7 @@ public class Organization implements Serializable { @SerializedName("username") private String username = null; - /** - * The visibility level of the organization (public, limited, private) public UserVisibilityPublic - * limited UserVisibilityLimited private UserVisibilityPrivate - */ + /** The visibility level of the organization (public, limited, private) */ @JsonAdapter(VisibilityEnum.Adapter.class) public enum VisibilityEnum { PUBLIC("public"), @@ -286,15 +283,11 @@ public class Organization implements Serializable { } /** - * The visibility level of the organization (public, limited, private) public UserVisibilityPublic - * limited UserVisibilityLimited private UserVisibilityPrivate + * The visibility level of the organization (public, limited, private) * * @return visibility */ - @Schema( - description = - "The visibility level of the organization (public, limited, private) public" - + " UserVisibilityPublic limited UserVisibilityLimited private UserVisibilityPrivate") + @Schema(description = "The visibility level of the organization (public, limited, private)") public VisibilityEnum getVisibility() { return visibility; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/PayloadCommit.java b/src/main/java/org/gitnex/tea4j/v2/models/PayloadCommit.java index fda81b5..945d90b 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/PayloadCommit.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/PayloadCommit.java @@ -218,11 +218,11 @@ public class PayloadCommit implements Serializable { } /** - * Get timestamp + * The timestamp when the commit was made * * @return timestamp */ - @Schema(description = "") + @Schema(description = "The timestamp when the commit was made") public Date getTimestamp() { return timestamp; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/PublicKey.java b/src/main/java/org/gitnex/tea4j/v2/models/PublicKey.java index ab8155d..56bfe43 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/PublicKey.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/PublicKey.java @@ -59,11 +59,11 @@ public class PublicKey implements Serializable { } /** - * Get createdAt + * Created is the time when the key was added * * @return createdAt */ - @Schema(description = "") + @Schema(description = "Created is the time when the key was added") public Date getCreatedAt() { return createdAt; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/PullRequest.java b/src/main/java/org/gitnex/tea4j/v2/models/PullRequest.java index 5f175f8..48ec8ea 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/PullRequest.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/PullRequest.java @@ -129,10 +129,7 @@ public class PullRequest implements Serializable { @SerializedName("review_comments") private Long reviewComments = null; - /** - * The current state of the pull request open StateOpen pr is opened closed StateClosed pr is - * closed - */ + /** The current state of the pull request */ @JsonAdapter(StateEnum.Adapter.class) public enum StateEnum { OPEN("open"), @@ -861,15 +858,11 @@ public class PullRequest implements Serializable { } /** - * The current state of the pull request open StateOpen pr is opened closed StateClosed pr is - * closed + * The current state of the pull request * * @return state */ - @Schema( - description = - "The current state of the pull request open StateOpen pr is opened closed StateClosed pr" - + " is closed") + @Schema(description = "The current state of the pull request") public StateEnum getState() { return state; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/Reaction.java b/src/main/java/org/gitnex/tea4j/v2/models/Reaction.java index 17fed6f..3460327 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/Reaction.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/Reaction.java @@ -57,11 +57,11 @@ public class Reaction implements Serializable { } /** - * Get createdAt + * The date and time when the reaction was created * * @return createdAt */ - @Schema(description = "") + @Schema(description = "The date and time when the reaction was created") public Date getCreatedAt() { return createdAt; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/RepoCollaboratorPermission.java b/src/main/java/org/gitnex/tea4j/v2/models/RepoCollaboratorPermission.java index 61b3e70..dbed746 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/RepoCollaboratorPermission.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/RepoCollaboratorPermission.java @@ -26,10 +26,7 @@ import java.util.Objects; @Schema(description = "RepoCollaboratorPermission to get repository permission for a collaborator") public class RepoCollaboratorPermission implements Serializable { private static final long serialVersionUID = 1L; - /** - * Permission level of the collaborator none AccessLevelNameNone read AccessLevelNameRead write - * AccessLevelNameWrite admin AccessLevelNameAdmin owner AccessLevelNameOwner - */ + /** Permission level of the collaborator */ @JsonAdapter(PermissionEnum.Adapter.class) public enum PermissionEnum { NONE("none"), @@ -92,15 +89,11 @@ public class RepoCollaboratorPermission implements Serializable { } /** - * Permission level of the collaborator none AccessLevelNameNone read AccessLevelNameRead write - * AccessLevelNameWrite admin AccessLevelNameAdmin owner AccessLevelNameOwner + * Permission level of the collaborator * * @return permission */ - @Schema( - description = - "Permission level of the collaborator none AccessLevelNameNone read AccessLevelNameRead" - + " write AccessLevelNameWrite admin AccessLevelNameAdmin owner AccessLevelNameOwner") + @Schema(description = "Permission level of the collaborator") public PermissionEnum getPermission() { return permission; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/Repository.java b/src/main/java/org/gitnex/tea4j/v2/models/Repository.java index e8d530c..d9da7f6 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/Repository.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/Repository.java @@ -180,10 +180,7 @@ public class Repository implements Serializable { @SerializedName("name") private String name = null; - /** - * ObjectFormatName of the underlying git repository sha1 ObjectFormatSHA1 sha256 - * ObjectFormatSHA256 - */ + /** ObjectFormatName of the underlying git repository */ @JsonAdapter(ObjectFormatNameEnum.Adapter.class) public enum ObjectFormatNameEnum { SHA1("sha1"), @@ -1252,15 +1249,11 @@ public class Repository implements Serializable { } /** - * ObjectFormatName of the underlying git repository sha1 ObjectFormatSHA1 sha256 - * ObjectFormatSHA256 + * ObjectFormatName of the underlying git repository * * @return objectFormatName */ - @Schema( - description = - "ObjectFormatName of the underlying git repository sha1 ObjectFormatSHA1 sha256" - + " ObjectFormatSHA256") + @Schema(description = "ObjectFormatName of the underlying git repository") public ObjectFormatNameEnum getObjectFormatName() { return objectFormatName; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/StopWatch.java b/src/main/java/org/gitnex/tea4j/v2/models/StopWatch.java index 34add43..6e00323 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/StopWatch.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/StopWatch.java @@ -50,11 +50,11 @@ public class StopWatch implements Serializable { } /** - * Get created + * Created is the time when the stopwatch was started * * @return created */ - @Schema(description = "") + @Schema(description = "Created is the time when the stopwatch was started") public Date getCreated() { return created; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/TagProtection.java b/src/main/java/org/gitnex/tea4j/v2/models/TagProtection.java index d564d04..9b02d17 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/TagProtection.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/TagProtection.java @@ -49,11 +49,11 @@ public class TagProtection implements Serializable { } /** - * Get createdAt + * The date and time when the tag protection was created * * @return createdAt */ - @Schema(description = "") + @Schema(description = "The date and time when the tag protection was created") public Date getCreatedAt() { return createdAt; } @@ -106,11 +106,11 @@ public class TagProtection implements Serializable { } /** - * Get updatedAt + * The date and time when the tag protection was last updated * * @return updatedAt */ - @Schema(description = "") + @Schema(description = "The date and time when the tag protection was last updated") public Date getUpdatedAt() { return updatedAt; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/Team.java b/src/main/java/org/gitnex/tea4j/v2/models/Team.java index 048a1ad..4557493 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/Team.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/Team.java @@ -109,8 +109,7 @@ public class Team implements Serializable { /** * Team visibility within the organization. \"private\" teams are only listable by * members and org owners; \"limited\" teams are listable by any organization member; - * \"public\" teams are listable by any signed-in user. public TeamVisibilityPublic - * limited TeamVisibilityLimited private TeamVisibilityPrivate + * \"public\" teams are listable by any signed-in user. */ @JsonAdapter(VisibilityEnum.Adapter.class) public enum VisibilityEnum { @@ -307,14 +306,16 @@ public class Team implements Serializable { } /** - * Get units + * Deprecated: This variable should be replaced by UnitsMap and will be dropped in later versions. * * @return units */ @Schema( example = "[\"repo.code\",\"repo.issues\",\"repo.ext_issues\",\"repo.wiki\",\"repo.pulls\",\"repo.releases\",\"repo.projects\",\"repo.ext_wiki\"]", - description = "") + description = + "Deprecated: This variable should be replaced by UnitsMap and will be dropped in later" + + " versions.") public List getUnits() { return units; } @@ -361,8 +362,7 @@ public class Team implements Serializable { /** * Team visibility within the organization. \"private\" teams are only listable by * members and org owners; \"limited\" teams are listable by any organization member; - * \"public\" teams are listable by any signed-in user. public TeamVisibilityPublic - * limited TeamVisibilityLimited private TeamVisibilityPrivate + * \"public\" teams are listable by any signed-in user. * * @return visibility */ @@ -370,8 +370,7 @@ public class Team implements Serializable { description = "Team visibility within the organization. \"private\" teams are only listable by members" + " and org owners; \"limited\" teams are listable by any organization member;" - + " \"public\" teams are listable by any signed-in user. public TeamVisibilityPublic" - + " limited TeamVisibilityLimited private TeamVisibilityPrivate") + + " \"public\" teams are listable by any signed-in user.") public VisibilityEnum getVisibility() { return visibility; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/User.java b/src/main/java/org/gitnex/tea4j/v2/models/User.java index b32c401..a5b9395 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/User.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/User.java @@ -88,10 +88,7 @@ public class User implements Serializable { @SerializedName("starred_repos_count") private Long starredReposCount = null; - /** - * User visibility level option: public, limited, private public UserVisibilityPublic limited - * UserVisibilityLimited private UserVisibilityPrivate - */ + /** User visibility level option: public, limited, private */ @JsonAdapter(VisibilityEnum.Adapter.class) public enum VisibilityEnum { PUBLIC("public"), @@ -531,15 +528,11 @@ public class User implements Serializable { } /** - * User visibility level option: public, limited, private public UserVisibilityPublic limited - * UserVisibilityLimited private UserVisibilityPrivate + * User visibility level option: public, limited, private * * @return visibility */ - @Schema( - description = - "User visibility level option: public, limited, private public UserVisibilityPublic" - + " limited UserVisibilityLimited private UserVisibilityPrivate") + @Schema(description = "User visibility level option: public, limited, private") public VisibilityEnum getVisibility() { return visibility; }