diff --git a/docs/APIError.md b/docs/APIError.md index 19c59bb..7ac58b7 100644 --- a/docs/APIError.md +++ b/docs/APIError.md @@ -3,5 +3,5 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**message** | **String** | | [optional] -**url** | **String** | | [optional] +**message** | **String** | Message contains the error description | [optional] +**url** | **String** | URL contains the documentation URL for this error | [optional] diff --git a/docs/AccessToken.md b/docs/AccessToken.md index e7991bb..9ce62ed 100644 --- a/docs/AccessToken.md +++ b/docs/AccessToken.md @@ -3,10 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**createdAt** | [**Date**](Date.md) | | [optional] -**id** | **Long** | | [optional] -**lastUsedAt** | [**Date**](Date.md) | | [optional] -**name** | **String** | | [optional] -**scopes** | **List<String>** | | [optional] -**sha1** | **String** | | [optional] -**tokenLastEight** | **String** | | [optional] +**createdAt** | [**Date**](Date.md) | The timestamp when the token was created | [optional] +**id** | **Long** | The unique identifier of the access token | [optional] +**lastUsedAt** | [**Date**](Date.md) | The timestamp when the token was last used | [optional] +**name** | **String** | The name of the access token | [optional] +**scopes** | **List<String>** | The scopes granted to this access token | [optional] +**sha1** | **String** | The SHA1 hash of the access token | [optional] +**tokenLastEight** | **String** | The last eight characters of the token | [optional] diff --git a/docs/ActionTask.md b/docs/ActionTask.md index 94dfb1c..631c14d 100644 --- a/docs/ActionTask.md +++ b/docs/ActionTask.md @@ -4,15 +4,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **createdAt** | [**Date**](Date.md) | | [optional] -**displayTitle** | **String** | | [optional] -**event** | **String** | | [optional] -**headBranch** | **String** | | [optional] -**headSha** | **String** | | [optional] -**id** | **Long** | | [optional] -**name** | **String** | | [optional] -**runNumber** | **Long** | | [optional] +**displayTitle** | **String** | DisplayTitle is the display title for the workflow run | [optional] +**event** | **String** | Event is the type of event that triggered the workflow | [optional] +**headBranch** | **String** | HeadBranch is the branch that triggered the workflow | [optional] +**headSha** | **String** | HeadSHA is the commit SHA that triggered the workflow | [optional] +**id** | **Long** | ID is the unique identifier for the action task | [optional] +**name** | **String** | Name is the name of the workflow | [optional] +**runNumber** | **Long** | RunNumber is the sequential number of the workflow run | [optional] **runStartedAt** | [**Date**](Date.md) | | [optional] -**status** | **String** | | [optional] +**status** | **String** | Status indicates the current status of the workflow run | [optional] **updatedAt** | [**Date**](Date.md) | | [optional] -**url** | **String** | | [optional] -**workflowId** | **String** | | [optional] +**url** | **String** | URL is the API URL for this workflow run | [optional] +**workflowId** | **String** | WorkflowID is the identifier of the workflow | [optional] diff --git a/docs/ActionTaskResponse.md b/docs/ActionTaskResponse.md index 6d7db5b..8515d89 100644 --- a/docs/ActionTaskResponse.md +++ b/docs/ActionTaskResponse.md @@ -3,5 +3,5 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalCount** | **Long** | | [optional] -**workflowRuns** | [**List<ActionTask>**](ActionTask.md) | | [optional] +**totalCount** | **Long** | TotalCount is the total number of workflow runs | [optional] +**workflowRuns** | [**List<ActionTask>**](ActionTask.md) | Entries contains the list of workflow runs | [optional] diff --git a/docs/ActionWorkflow.md b/docs/ActionWorkflow.md index 1f36923..8a2265f 100644 --- a/docs/ActionWorkflow.md +++ b/docs/ActionWorkflow.md @@ -3,13 +3,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**badgeUrl** | **String** | | [optional] +**badgeUrl** | **String** | BadgeURL is the URL for the workflow badge | [optional] **createdAt** | [**Date**](Date.md) | | [optional] **deletedAt** | [**Date**](Date.md) | | [optional] -**htmlUrl** | **String** | | [optional] -**id** | **String** | | [optional] -**name** | **String** | | [optional] -**path** | **String** | | [optional] -**state** | **String** | | [optional] +**htmlUrl** | **String** | HTMLURL is the web URL for viewing the workflow | [optional] +**id** | **String** | ID is the unique identifier for the workflow | [optional] +**name** | **String** | Name is the name of the workflow | [optional] +**path** | **String** | Path is the file path of the workflow | [optional] +**state** | **String** | State indicates if the workflow is active or disabled | [optional] **updatedAt** | [**Date**](Date.md) | | [optional] -**url** | **String** | | [optional] +**url** | **String** | URL is the API URL for this workflow | [optional] diff --git a/docs/Activity.md b/docs/Activity.md index b471fd9..215c68e 100644 --- a/docs/Activity.md +++ b/docs/Activity.md @@ -4,18 +4,18 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **actUser** | [**User**](User.md) | | [optional] -**actUserId** | **Long** | | [optional] +**actUserId** | **Long** | The ID of the user who performed the action | [optional] **comment** | [**Comment**](Comment.md) | | [optional] -**commentId** | **Long** | | [optional] -**content** | **String** | | [optional] -**created** | [**Date**](Date.md) | | [optional] -**id** | **Long** | | [optional] -**isPrivate** | **Boolean** | | [optional] +**commentId** | **Long** | The ID of the comment associated with the activity (if applicable) | [optional] +**content** | **String** | Additional content or details about the activity | [optional] +**created** | [**Date**](Date.md) | The date and time when the activity occurred | [optional] +**id** | **Long** | The unique identifier of the activity | [optional] +**isPrivate** | **Boolean** | Whether this activity is from a private repository | [optional] **opType** | [**OpTypeEnum**](#OpTypeEnum) | the type of action | [optional] -**refName** | **String** | | [optional] +**refName** | **String** | The name of the git reference (branch/tag) associated with the activity | [optional] **repo** | [**Repository**](Repository.md) | | [optional] -**repoId** | **Long** | | [optional] -**userId** | **Long** | | [optional] +**repoId** | **Long** | The ID of the repository associated with the activity | [optional] +**userId** | **Long** | The ID of the user who receives/sees this activity | [optional] ## Enum: OpTypeEnum diff --git a/docs/ActivityPub.md b/docs/ActivityPub.md index 8b7e723..dbae1f8 100644 --- a/docs/ActivityPub.md +++ b/docs/ActivityPub.md @@ -3,4 +3,4 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**_atContext** | **String** | | [optional] +**_atContext** | **String** | Context defines the JSON-LD context for ActivityPub | [optional] diff --git a/docs/AnnotatedTag.md b/docs/AnnotatedTag.md index 7ea8a39..b70520e 100644 --- a/docs/AnnotatedTag.md +++ b/docs/AnnotatedTag.md @@ -3,10 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**message** | **String** | | [optional] +**message** | **String** | The message associated with the annotated tag | [optional] **object** | [**AnnotatedTagObject**](AnnotatedTagObject.md) | | [optional] -**sha** | **String** | | [optional] -**tag** | **String** | | [optional] +**sha** | **String** | The SHA hash of the annotated tag | [optional] +**tag** | **String** | The name of the annotated tag | [optional] **tagger** | [**CommitUser**](CommitUser.md) | | [optional] -**url** | **String** | | [optional] +**url** | **String** | The URL to access the annotated tag | [optional] **verification** | [**PayloadCommitVerification**](PayloadCommitVerification.md) | | [optional] diff --git a/docs/AnnotatedTagObject.md b/docs/AnnotatedTagObject.md index f4ba830..51c51f8 100644 --- a/docs/AnnotatedTagObject.md +++ b/docs/AnnotatedTagObject.md @@ -3,6 +3,6 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**sha** | **String** | | [optional] -**type** | **String** | | [optional] -**url** | **String** | | [optional] +**sha** | **String** | The SHA hash of the tagged object | [optional] +**type** | **String** | The type of the tagged object (e.g., commit, tree) | [optional] +**url** | **String** | The URL to access the tagged object | [optional] diff --git a/docs/Attachment.md b/docs/Attachment.md index 6dbc7a8..a4e9b63 100644 --- a/docs/Attachment.md +++ b/docs/Attachment.md @@ -3,10 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**browserDownloadUrl** | **String** | | [optional] +**browserDownloadUrl** | **String** | DownloadURL is the URL to download the attachment | [optional] **createdAt** | [**Date**](Date.md) | | [optional] -**downloadCount** | **Long** | | [optional] -**id** | **Long** | | [optional] -**name** | **String** | | [optional] -**size** | **Long** | | [optional] -**uuid** | **String** | | [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] +**size** | **Long** | Size is the file size in bytes | [optional] +**uuid** | **String** | UUID is the unique identifier for the attachment file | [optional] diff --git a/docs/Branch.md b/docs/Branch.md index 99140ea..0228580 100644 --- a/docs/Branch.md +++ b/docs/Branch.md @@ -4,11 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **commit** | [**PayloadCommit**](PayloadCommit.md) | | [optional] -**effectiveBranchProtectionName** | **String** | | [optional] -**enableStatusCheck** | **Boolean** | | [optional] -**name** | **String** | | [optional] -**_protected** | **Boolean** | | [optional] -**requiredApprovals** | **Long** | | [optional] -**statusCheckContexts** | **List<String>** | | [optional] -**userCanMerge** | **Boolean** | | [optional] -**userCanPush** | **Boolean** | | [optional] +**effectiveBranchProtectionName** | **String** | EffectiveBranchProtectionName is the name of the effective branch protection rule | [optional] +**enableStatusCheck** | **Boolean** | EnableStatusCheck indicates if status checks are enabled | [optional] +**name** | **String** | Name is the branch name | [optional] +**_protected** | **Boolean** | Protected indicates if the branch is protected | [optional] +**requiredApprovals** | **Long** | RequiredApprovals is the number of required approvals for pull requests | [optional] +**statusCheckContexts** | **List<String>** | StatusCheckContexts contains the list of required status check contexts | [optional] +**userCanMerge** | **Boolean** | UserCanMerge indicates if the current user can merge to this branch | [optional] +**userCanPush** | **Boolean** | UserCanPush indicates if the current user can push to this branch | [optional] diff --git a/docs/BranchProtection.md b/docs/BranchProtection.md index ccb258b..099b3d6 100644 --- a/docs/BranchProtection.md +++ b/docs/BranchProtection.md @@ -25,14 +25,14 @@ Name | Type | Description | Notes **ignoreStaleApprovals** | **Boolean** | | [optional] **mergeWhitelistTeams** | **List<String>** | | [optional] **mergeWhitelistUsernames** | **List<String>** | | [optional] -**priority** | **Long** | | [optional] +**priority** | **Long** | Priority is the priority of this branch protection rule | [optional] **protectedFilePatterns** | **String** | | [optional] **pushWhitelistDeployKeys** | **Boolean** | | [optional] **pushWhitelistTeams** | **List<String>** | | [optional] **pushWhitelistUsernames** | **List<String>** | | [optional] **requireSignedCommits** | **Boolean** | | [optional] **requiredApprovals** | **Long** | | [optional] -**ruleName** | **String** | | [optional] +**ruleName** | **String** | RuleName is the name of the branch protection rule | [optional] **statusCheckContexts** | **List<String>** | | [optional] **unprotectedFilePatterns** | **String** | | [optional] **updatedAt** | [**Date**](Date.md) | | [optional] diff --git a/docs/ChangedFile.md b/docs/ChangedFile.md index 4160283..97e6686 100644 --- a/docs/ChangedFile.md +++ b/docs/ChangedFile.md @@ -3,12 +3,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**additions** | **Long** | | [optional] -**changes** | **Long** | | [optional] -**contentsUrl** | **String** | | [optional] -**deletions** | **Long** | | [optional] -**filename** | **String** | | [optional] -**htmlUrl** | **String** | | [optional] -**previousFilename** | **String** | | [optional] -**rawUrl** | **String** | | [optional] -**status** | **String** | | [optional] +**additions** | **Long** | The number of lines added to the file | [optional] +**changes** | **Long** | The total number of changes to the file | [optional] +**contentsUrl** | **String** | The API URL to get the file contents | [optional] +**deletions** | **Long** | The number of lines deleted from the file | [optional] +**filename** | **String** | The name of the changed file | [optional] +**htmlUrl** | **String** | The HTML URL to view the file changes | [optional] +**previousFilename** | **String** | The previous filename if the file was renamed | [optional] +**rawUrl** | **String** | The raw URL to download the file | [optional] +**status** | **String** | The status of the file change (added, modified, deleted, etc.) | [optional] diff --git a/docs/CombinedStatus.md b/docs/CombinedStatus.md index 74b6f53..56822c3 100644 --- a/docs/CombinedStatus.md +++ b/docs/CombinedStatus.md @@ -3,13 +3,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**commitUrl** | **String** | | [optional] +**commitUrl** | **String** | CommitURL is the API URL for the commit | [optional] **repository** | [**Repository**](Repository.md) | | [optional] -**sha** | **String** | | [optional] -**state** | [**StateEnum**](#StateEnum) | | [optional] -**statuses** | [**List<CommitStatus>**](CommitStatus.md) | | [optional] -**totalCount** | **Long** | | [optional] -**url** | **String** | | [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 CommitStatusPending is for when the CommitStatus is Pending success CommitStatusSuccess CommitStatusSuccess is for when the CommitStatus is Success error CommitStatusError CommitStatusError is for when the CommitStatus is Error failure CommitStatusFailure CommitStatusFailure is for when the CommitStatus is Failure warning CommitStatusWarning CommitStatusWarning is for when the CommitStatus is Warning skipped CommitStatusSkipped CommitStatusSkipped is for when CommitStatus is Skipped | [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] ## Enum: StateEnum diff --git a/docs/Comment.md b/docs/Comment.md index da5ab6e..d502567 100644 --- a/docs/Comment.md +++ b/docs/Comment.md @@ -3,14 +3,14 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**assets** | [**List<Attachment>**](Attachment.md) | | [optional] -**body** | **String** | | [optional] +**assets** | [**List<Attachment>**](Attachment.md) | Attachments contains files attached to the comment | [optional] +**body** | **String** | Body contains the comment text content | [optional] **createdAt** | [**Date**](Date.md) | | [optional] -**htmlUrl** | **String** | | [optional] -**id** | **Long** | | [optional] -**issueUrl** | **String** | | [optional] -**originalAuthor** | **String** | | [optional] -**originalAuthorId** | **Long** | | [optional] -**pullRequestUrl** | **String** | | [optional] +**htmlUrl** | **String** | HTMLURL is the web URL for viewing the comment | [optional] +**id** | **Long** | ID is the unique identifier for the comment | [optional] +**issueUrl** | **String** | IssueURL is the API URL for the issue | [optional] +**originalAuthor** | **String** | OriginalAuthor is the original author name (for imported comments) | [optional] +**originalAuthorId** | **Long** | OriginalAuthorID is the original author ID (for imported comments) | [optional] +**pullRequestUrl** | **String** | PRURL is the API URL for the pull request (if applicable) | [optional] **updatedAt** | [**Date**](Date.md) | | [optional] **user** | [**User**](User.md) | | [optional] diff --git a/docs/Commit.md b/docs/Commit.md index 44ce268..51ea378 100644 --- a/docs/Commit.md +++ b/docs/Commit.md @@ -7,9 +7,9 @@ Name | Type | Description | Notes **commit** | [**RepoCommit**](RepoCommit.md) | | [optional] **committer** | [**User**](User.md) | | [optional] **created** | [**Date**](Date.md) | | [optional] -**files** | [**List<CommitAffectedFiles>**](CommitAffectedFiles.md) | | [optional] -**htmlUrl** | **String** | | [optional] -**parents** | [**List<CommitMeta>**](CommitMeta.md) | | [optional] -**sha** | **String** | | [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] +**sha** | **String** | SHA is the commit SHA hash | [optional] **stats** | [**CommitStats**](CommitStats.md) | | [optional] -**url** | **String** | | [optional] +**url** | **String** | URL is the API URL for the commit | [optional] diff --git a/docs/CommitAffectedFiles.md b/docs/CommitAffectedFiles.md index cbd7773..e9693d2 100644 --- a/docs/CommitAffectedFiles.md +++ b/docs/CommitAffectedFiles.md @@ -3,5 +3,5 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**filename** | **String** | | [optional] -**status** | **String** | | [optional] +**filename** | **String** | Filename is the path of the affected file | [optional] +**status** | **String** | Status indicates how the file was affected (added, modified, deleted) | [optional] diff --git a/docs/CommitMeta.md b/docs/CommitMeta.md index bba9ec1..8db9647 100644 --- a/docs/CommitMeta.md +++ b/docs/CommitMeta.md @@ -4,5 +4,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **created** | [**Date**](Date.md) | | [optional] -**sha** | **String** | | [optional] -**url** | **String** | | [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/CommitStats.md b/docs/CommitStats.md index d285960..6f29e21 100644 --- a/docs/CommitStats.md +++ b/docs/CommitStats.md @@ -3,6 +3,6 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**additions** | **Long** | | [optional] -**deletions** | **Long** | | [optional] -**total** | **Long** | | [optional] +**additions** | **Long** | Additions is the number of lines added | [optional] +**deletions** | **Long** | Deletions is the number of lines deleted | [optional] +**total** | **Long** | Total is the total number of lines changed | [optional] diff --git a/docs/CommitStatus.md b/docs/CommitStatus.md index 1e107c3..0eb03aa 100644 --- a/docs/CommitStatus.md +++ b/docs/CommitStatus.md @@ -3,15 +3,15 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**context** | **String** | | [optional] +**context** | **String** | Context is the unique context identifier for the status | [optional] **createdAt** | [**Date**](Date.md) | | [optional] **creator** | [**User**](User.md) | | [optional] -**description** | **String** | | [optional] -**id** | **Long** | | [optional] -**status** | [**StatusEnum**](#StatusEnum) | | [optional] -**targetUrl** | **String** | | [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 CommitStatusPending is for when the CommitStatus is Pending success CommitStatusSuccess CommitStatusSuccess is for when the CommitStatus is Success error CommitStatusError CommitStatusError is for when the CommitStatus is Error failure CommitStatusFailure CommitStatusFailure is for when the CommitStatus is Failure warning CommitStatusWarning CommitStatusWarning is for when the CommitStatus is Warning skipped CommitStatusSkipped CommitStatusSkipped is for when CommitStatus is Skipped | [optional] +**targetUrl** | **String** | TargetURL is the URL to link to for more details | [optional] **updatedAt** | [**Date**](Date.md) | | [optional] -**url** | **String** | | [optional] +**url** | **String** | URL is the API URL for this status | [optional] ## Enum: StatusEnum diff --git a/docs/CommitUser.md b/docs/CommitUser.md index f694614..a1a2dff 100644 --- a/docs/CommitUser.md +++ b/docs/CommitUser.md @@ -3,6 +3,6 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**date** | **String** | | [optional] +**date** | **String** | Date is the commit date in string format | [optional] **email** | **String** | | [optional] -**name** | **String** | | [optional] +**name** | **String** | Name is the person's name | [optional] diff --git a/docs/ContentsExtResponse.md b/docs/ContentsExtResponse.md index 40b934b..21bdbcb 100644 --- a/docs/ContentsExtResponse.md +++ b/docs/ContentsExtResponse.md @@ -3,5 +3,5 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**dirContents** | [**List<ContentsResponse>**](ContentsResponse.md) | | [optional] +**dirContents** | [**List<ContentsResponse>**](ContentsResponse.md) | DirContents contains directory listing when the path represents a directory | [optional] **fileContents** | [**ContentsResponse**](ContentsResponse.md) | | [optional] diff --git a/docs/ContentsResponse.md b/docs/ContentsResponse.md index 7e9edf3..fb87646 100644 --- a/docs/ContentsResponse.md +++ b/docs/ContentsResponse.md @@ -5,21 +5,21 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_links** | [**FileLinksResponse**](FileLinksResponse.md) | | [optional] **content** | **String** | `content` is populated when `type` is `file`, otherwise null | [optional] -**downloadUrl** | **String** | | [optional] +**downloadUrl** | **String** | DownloadURL is the direct download URL for this file | [optional] **encoding** | **String** | `encoding` is populated when `type` is `file`, otherwise null | [optional] -**gitUrl** | **String** | | [optional] -**htmlUrl** | **String** | | [optional] +**gitUrl** | **String** | GitURL is the Git API URL for this blob or tree | [optional] +**htmlUrl** | **String** | HTMLURL is the web URL for this file or directory | [optional] **lastAuthorDate** | [**Date**](Date.md) | | [optional] -**lastCommitMessage** | **String** | | [optional] -**lastCommitSha** | **String** | | [optional] +**lastCommitMessage** | **String** | LastCommitMessage is the message of the last commit that affected this file | [optional] +**lastCommitSha** | **String** | LastCommitSHA is the SHA of the last commit that affected this file | [optional] **lastCommitterDate** | [**Date**](Date.md) | | [optional] -**lfsOid** | **String** | | [optional] -**lfsSize** | **Long** | | [optional] -**name** | **String** | | [optional] -**path** | **String** | | [optional] -**sha** | **String** | | [optional] -**size** | **Long** | | [optional] +**lfsOid** | **String** | LfsOid is the Git LFS object ID if this file is stored in LFS | [optional] +**lfsSize** | **Long** | LfsSize is the file size if this file is stored in LFS | [optional] +**name** | **String** | Name is the file or directory name | [optional] +**path** | **String** | Path is the full path to the file or directory | [optional] +**sha** | **String** | SHA is the Git blob or tree SHA | [optional] +**size** | **Long** | Size is the file size in bytes | [optional] **submoduleGitUrl** | **String** | `submodule_git_url` is populated when `type` is `submodule`, otherwise null | [optional] **target** | **String** | `target` is populated when `type` is `symlink`, otherwise null | [optional] **type** | **String** | `type` will be `file`, `dir`, `symlink`, or `submodule` | [optional] -**url** | **String** | | [optional] +**url** | **String** | URL is the API URL for this file or directory | [optional] diff --git a/docs/CreateGPGKeyOption.md b/docs/CreateGPGKeyOption.md index 8eaf2be..93cd50f 100644 --- a/docs/CreateGPGKeyOption.md +++ b/docs/CreateGPGKeyOption.md @@ -4,4 +4,4 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **armoredPublicKey** | **String** | An armored GPG key to add | -**armoredSignature** | **String** | | [optional] +**armoredSignature** | **String** | An optional armored signature for the GPG key | [optional] diff --git a/docs/CreateHookOption.md b/docs/CreateHookOption.md index 88ac256..5a31001 100644 --- a/docs/CreateHookOption.md +++ b/docs/CreateHookOption.md @@ -4,10 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **active** | **Boolean** | | [optional] -**authorizationHeader** | **String** | | [optional] -**branchFilter** | **String** | | [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>** | | [optional] +**events** | **List<String>** | List of events that will trigger this webhook | [optional] **type** | [**TypeEnum**](#TypeEnum) | | diff --git a/docs/CreateLabelOption.md b/docs/CreateLabelOption.md index 547f363..3cb7d32 100644 --- a/docs/CreateLabelOption.md +++ b/docs/CreateLabelOption.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **color** | **String** | | -**description** | **String** | | [optional] +**description** | **String** | Description provides additional context about the label's purpose | [optional] **exclusive** | **Boolean** | | [optional] **isArchived** | **Boolean** | | [optional] **name** | **String** | | diff --git a/docs/CreateMilestoneOption.md b/docs/CreateMilestoneOption.md index c987305..f2c41d5 100644 --- a/docs/CreateMilestoneOption.md +++ b/docs/CreateMilestoneOption.md @@ -3,10 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**description** | **String** | | [optional] +**description** | **String** | Description provides details about the milestone | [optional] **dueOn** | [**Date**](Date.md) | | [optional] **state** | [**StateEnum**](#StateEnum) | | [optional] -**title** | **String** | | [optional] +**title** | **String** | Title is the title of the new milestone | [optional] ## Enum: StateEnum diff --git a/docs/CreateOAuth2ApplicationOptions.md b/docs/CreateOAuth2ApplicationOptions.md index 05bceaa..1c71705 100644 --- a/docs/CreateOAuth2ApplicationOptions.md +++ b/docs/CreateOAuth2ApplicationOptions.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**confidentialClient** | **Boolean** | | [optional] -**name** | **String** | | [optional] -**redirectUris** | **List<String>** | | [optional] -**skipSecondaryAuthorization** | **Boolean** | | [optional] +**confidentialClient** | **Boolean** | Whether the client is confidential | [optional] +**name** | **String** | The name of the OAuth2 application | [optional] +**redirectUris** | **List<String>** | The list of allowed redirect URIs | [optional] +**skipSecondaryAuthorization** | **Boolean** | Whether to skip secondary authorization | [optional] diff --git a/docs/CreateOrgOption.md b/docs/CreateOrgOption.md index 86553af..aad12ad 100644 --- a/docs/CreateOrgOption.md +++ b/docs/CreateOrgOption.md @@ -3,14 +3,14 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**description** | **String** | | [optional] -**email** | **String** | | [optional] -**fullName** | **String** | | [optional] -**location** | **String** | | [optional] -**repoAdminChangeTeamAccess** | **Boolean** | | [optional] +**description** | **String** | The description of the organization | [optional] +**email** | **String** | The email address of the organization | [optional] +**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] **username** | **String** | username of the organization | **visibility** | [**VisibilityEnum**](#VisibilityEnum) | possible values are `public` (default), `limited` or `private` | [optional] -**website** | **String** | | [optional] +**website** | **String** | The website URL of the organization | [optional] ## Enum: VisibilityEnum diff --git a/docs/CreatePullRequestOption.md b/docs/CreatePullRequestOption.md index fc7fc47..c5a174a 100644 --- a/docs/CreatePullRequestOption.md +++ b/docs/CreatePullRequestOption.md @@ -3,14 +3,14 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**assignee** | **String** | | [optional] -**assignees** | **List<String>** | | [optional] -**base** | **String** | | [optional] -**body** | **String** | | [optional] +**assignee** | **String** | The primary assignee username | [optional] +**assignees** | **List<String>** | The list of assignee usernames | [optional] +**base** | **String** | The base branch for the pull request | [optional] +**body** | **String** | The description body of the pull request | [optional] **dueDate** | [**Date**](Date.md) | | [optional] -**head** | **String** | | [optional] -**labels** | **List<Long>** | | [optional] -**milestone** | **Long** | | [optional] -**reviewers** | **List<String>** | | [optional] -**teamReviewers** | **List<String>** | | [optional] -**title** | **String** | | [optional] +**head** | **String** | The head branch for the pull request, it could be a branch name on the base repository or a form like `<username>:<branch>` which refers to the user's fork repository's branch. | [optional] +**labels** | **List<Long>** | The list of label IDs to assign to the pull request | [optional] +**milestone** | **Long** | The milestone ID to assign to the pull request | [optional] +**reviewers** | **List<String>** | The list of reviewer usernames | [optional] +**teamReviewers** | **List<String>** | The list of team reviewer names | [optional] +**title** | **String** | The title of the pull request | [optional] diff --git a/docs/CreatePushMirrorOption.md b/docs/CreatePushMirrorOption.md index c50be65..5606be5 100644 --- a/docs/CreatePushMirrorOption.md +++ b/docs/CreatePushMirrorOption.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**interval** | **String** | | [optional] -**remoteAddress** | **String** | | [optional] -**remotePassword** | **String** | | [optional] -**remoteUsername** | **String** | | [optional] -**syncOnCommit** | **Boolean** | | [optional] +**interval** | **String** | The sync interval for automatic updates | [optional] +**remoteAddress** | **String** | The remote repository URL to push to | [optional] +**remotePassword** | **String** | The password for authentication with the remote repository | [optional] +**remoteUsername** | **String** | The username for authentication with the remote repository | [optional] +**syncOnCommit** | **Boolean** | Whether to sync on every commit | [optional] diff --git a/docs/CreateReleaseOption.md b/docs/CreateReleaseOption.md index c52929b..b008a10 100644 --- a/docs/CreateReleaseOption.md +++ b/docs/CreateReleaseOption.md @@ -3,10 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**body** | **String** | | [optional] -**draft** | **Boolean** | | [optional] -**name** | **String** | | [optional] -**prerelease** | **Boolean** | | [optional] -**tagMessage** | **String** | | [optional] +**body** | **String** | The release notes or description | [optional] +**draft** | **Boolean** | Whether to create the release as a draft | [optional] +**name** | **String** | The display title of the release | [optional] +**prerelease** | **Boolean** | Whether to mark the release as a prerelease | [optional] +**tagMessage** | **String** | The message for the git tag | [optional] **tagName** | **String** | | -**targetCommitish** | **String** | | [optional] +**targetCommitish** | **String** | The target commitish for the release | [optional] diff --git a/docs/CreateStatusOption.md b/docs/CreateStatusOption.md index c79d545..6e796e0 100644 --- a/docs/CreateStatusOption.md +++ b/docs/CreateStatusOption.md @@ -3,10 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**context** | **String** | | [optional] -**description** | **String** | | [optional] -**state** | [**StateEnum**](#StateEnum) | | [optional] -**targetUrl** | **String** | | [optional] +**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 CommitStatusPending is for when the CommitStatus is Pending success CommitStatusSuccess CommitStatusSuccess is for when the CommitStatus is Success error CommitStatusError CommitStatusError is for when the CommitStatus is Error failure CommitStatusFailure CommitStatusFailure is for when the CommitStatus is Failure warning CommitStatusWarning CommitStatusWarning is for when the CommitStatus is Warning skipped CommitStatusSkipped CommitStatusSkipped is for when CommitStatus is Skipped | [optional] +**targetUrl** | **String** | TargetURL is the URL to link to for more details | [optional] ## Enum: StateEnum diff --git a/docs/CreateTagOption.md b/docs/CreateTagOption.md index 5b07a61..efaa798 100644 --- a/docs/CreateTagOption.md +++ b/docs/CreateTagOption.md @@ -3,6 +3,6 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**message** | **String** | | [optional] +**message** | **String** | The message to associate with the tag | [optional] **tagName** | **String** | | -**target** | **String** | | [optional] +**target** | **String** | The target commit SHA or branch name for the tag | [optional] diff --git a/docs/CreateTagProtectionOption.md b/docs/CreateTagProtectionOption.md index 2e258e2..668763d 100644 --- a/docs/CreateTagProtectionOption.md +++ b/docs/CreateTagProtectionOption.md @@ -3,6 +3,6 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**namePattern** | **String** | | [optional] -**whitelistTeams** | **List<String>** | | [optional] -**whitelistUsernames** | **List<String>** | | [optional] +**namePattern** | **String** | The pattern to match tag names for protection | [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/CreateTeamOption.md b/docs/CreateTeamOption.md index 7dfede8..2800818 100644 --- a/docs/CreateTeamOption.md +++ b/docs/CreateTeamOption.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**canCreateOrgRepo** | **Boolean** | | [optional] -**description** | **String** | | [optional] -**includesAllRepositories** | **Boolean** | | [optional] +**canCreateOrgRepo** | **Boolean** | Whether the team can create repositories in the organization | [optional] +**description** | **String** | The description of the team | [optional] +**includesAllRepositories** | **Boolean** | Whether the team has access to all repositories in the organization | [optional] **name** | **String** | | **permission** | [**PermissionEnum**](#PermissionEnum) | | [optional] **units** | **List<String>** | | [optional] diff --git a/docs/CreateUserOption.md b/docs/CreateUserOption.md index 20d609e..42a748c 100644 --- a/docs/CreateUserOption.md +++ b/docs/CreateUserOption.md @@ -5,12 +5,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **createdAt** | [**Date**](Date.md) | For explicitly setting the user creation timestamp. Useful when users are migrated from other systems. When omitted, the user's creation timestamp will be set to \"now\". | [optional] **email** | **String** | | -**fullName** | **String** | | [optional] +**fullName** | **String** | The full display name of the user | [optional] **loginName** | **String** | identifier of the user, provided by the external authenticator (if configured) | [optional] -**mustChangePassword** | **Boolean** | | [optional] -**password** | **String** | | [optional] -**restricted** | **Boolean** | | [optional] -**sendNotify** | **Boolean** | | [optional] -**sourceId** | **Long** | | [optional] +**mustChangePassword** | **Boolean** | Whether the user must change password on first login | [optional] +**password** | **String** | The plain text password for the user | [optional] +**restricted** | **Boolean** | Whether the user has restricted access privileges | [optional] +**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** | **String** | | [optional] +**visibility** | **String** | User visibility level: public, limited, or private | [optional] diff --git a/docs/Cron.md b/docs/Cron.md index 913c2b6..bfa25f1 100644 --- a/docs/Cron.md +++ b/docs/Cron.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**execTimes** | **Long** | | [optional] -**name** | **String** | | [optional] -**next** | [**Date**](Date.md) | | [optional] -**prev** | [**Date**](Date.md) | | [optional] -**schedule** | **String** | | [optional] +**execTimes** | **Long** | The total number of times this cron task has been executed | [optional] +**name** | **String** | The name of the cron task | [optional] +**next** | [**Date**](Date.md) | The next scheduled execution time | [optional] +**prev** | [**Date**](Date.md) | The previous execution time | [optional] +**schedule** | **String** | The cron schedule expression (e.g., \"0 0 * * *\") | [optional] diff --git a/docs/DeployKey.md b/docs/DeployKey.md index 9565250..cc0612a 100644 --- a/docs/DeployKey.md +++ b/docs/DeployKey.md @@ -4,11 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **createdAt** | [**Date**](Date.md) | | [optional] -**fingerprint** | **String** | | [optional] -**id** | **Long** | | [optional] -**key** | **String** | | [optional] -**keyId** | **Long** | | [optional] -**readOnly** | **Boolean** | | [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] +**keyId** | **Long** | KeyID is the associated public key ID | [optional] +**readOnly** | **Boolean** | ReadOnly indicates if the key has read-only access | [optional] **repository** | [**Repository**](Repository.md) | | [optional] -**title** | **String** | | [optional] -**url** | **String** | | [optional] +**title** | **String** | Title is the human-readable name for the key | [optional] +**url** | **String** | URL is the API URL for this deploy key | [optional] diff --git a/docs/EditAttachmentOptions.md b/docs/EditAttachmentOptions.md index 6cbd855..dc72820 100644 --- a/docs/EditAttachmentOptions.md +++ b/docs/EditAttachmentOptions.md @@ -3,4 +3,4 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **String** | | [optional] +**name** | **String** | Name is the new filename for the attachment | [optional] diff --git a/docs/EditGitHookOption.md b/docs/EditGitHookOption.md index 1936221..fb2c4b5 100644 --- a/docs/EditGitHookOption.md +++ b/docs/EditGitHookOption.md @@ -3,4 +3,4 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**content** | **String** | | [optional] +**content** | **String** | Content is the new script content for the hook | [optional] diff --git a/docs/EditHookOption.md b/docs/EditHookOption.md index a4cdc93..23f9ca7 100644 --- a/docs/EditHookOption.md +++ b/docs/EditHookOption.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**active** | **Boolean** | | [optional] -**authorizationHeader** | **String** | | [optional] -**branchFilter** | **String** | | [optional] -**config** | **Map<String, String>** | | [optional] -**events** | **List<String>** | | [optional] +**active** | **Boolean** | Whether the webhook is active and will be triggered | [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** | **Map<String, String>** | Configuration settings for the webhook | [optional] +**events** | **List<String>** | List of events that trigger this webhook | [optional] diff --git a/docs/EditLabelOption.md b/docs/EditLabelOption.md index 5f8af46..bc2a731 100644 --- a/docs/EditLabelOption.md +++ b/docs/EditLabelOption.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **color** | **String** | | [optional] -**description** | **String** | | [optional] +**description** | **String** | Description provides additional context about the label's purpose | [optional] **exclusive** | **Boolean** | | [optional] **isArchived** | **Boolean** | | [optional] -**name** | **String** | | [optional] +**name** | **String** | Name is the new display name for the label | [optional] diff --git a/docs/EditMilestoneOption.md b/docs/EditMilestoneOption.md index 9cee3b1..c5f34a1 100644 --- a/docs/EditMilestoneOption.md +++ b/docs/EditMilestoneOption.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**description** | **String** | | [optional] -**dueOn** | [**Date**](Date.md) | | [optional] -**state** | **String** | | [optional] -**title** | **String** | | [optional] +**description** | **String** | Description provides updated details about the milestone | [optional] +**dueOn** | [**Date**](Date.md) | Deadline is the updated due date for the milestone | [optional] +**state** | **String** | State indicates the updated state of the milestone | [optional] +**title** | **String** | Title is the updated title of the milestone | [optional] diff --git a/docs/EditOrgOption.md b/docs/EditOrgOption.md index 461ed21..b4dcd70 100644 --- a/docs/EditOrgOption.md +++ b/docs/EditOrgOption.md @@ -3,13 +3,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**description** | **String** | | [optional] -**email** | **String** | | [optional] -**fullName** | **String** | | [optional] -**location** | **String** | | [optional] -**repoAdminChangeTeamAccess** | **Boolean** | | [optional] +**description** | **String** | The description of the organization | [optional] +**email** | **String** | The email address of the organization | [optional] +**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` | [optional] -**website** | **String** | | [optional] +**website** | **String** | The website URL of the organization | [optional] ## Enum: VisibilityEnum diff --git a/docs/EditPullRequestOption.md b/docs/EditPullRequestOption.md index 6236140..ddd5bec 100644 --- a/docs/EditPullRequestOption.md +++ b/docs/EditPullRequestOption.md @@ -3,14 +3,14 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**allowMaintainerEdit** | **Boolean** | | [optional] -**assignee** | **String** | | [optional] -**assignees** | **List<String>** | | [optional] -**base** | **String** | | [optional] -**body** | **String** | | [optional] +**allowMaintainerEdit** | **Boolean** | Whether to allow maintainer edits | [optional] +**assignee** | **String** | The new primary assignee username | [optional] +**assignees** | **List<String>** | The new list of assignee usernames | [optional] +**base** | **String** | The new base branch for the pull request | [optional] +**body** | **String** | The new description body for the pull request | [optional] **dueDate** | [**Date**](Date.md) | | [optional] -**labels** | **List<Long>** | | [optional] -**milestone** | **Long** | | [optional] -**state** | **String** | | [optional] -**title** | **String** | | [optional] -**unsetDueDate** | **Boolean** | | [optional] +**labels** | **List<Long>** | The new list of label IDs for the pull request | [optional] +**milestone** | **Long** | The new milestone ID for the pull request | [optional] +**state** | **String** | The new state for the pull request | [optional] +**title** | **String** | The new title for the pull request | [optional] +**unsetDueDate** | **Boolean** | Whether to remove the current deadline | [optional] diff --git a/docs/EditReactionOption.md b/docs/EditReactionOption.md index b9539a1..ff716b9 100644 --- a/docs/EditReactionOption.md +++ b/docs/EditReactionOption.md @@ -3,4 +3,4 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**content** | **String** | | [optional] +**content** | **String** | The reaction content (e.g., emoji or reaction type) | [optional] diff --git a/docs/EditReleaseOption.md b/docs/EditReleaseOption.md index fa462fb..791140d 100644 --- a/docs/EditReleaseOption.md +++ b/docs/EditReleaseOption.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**body** | **String** | | [optional] -**draft** | **Boolean** | | [optional] -**name** | **String** | | [optional] -**prerelease** | **Boolean** | | [optional] -**tagName** | **String** | | [optional] -**targetCommitish** | **String** | | [optional] +**body** | **String** | The new release notes or description | [optional] +**draft** | **Boolean** | Whether to change the draft status | [optional] +**name** | **String** | The new display title of the release | [optional] +**prerelease** | **Boolean** | Whether to change the prerelease status | [optional] +**tagName** | **String** | The new name of the git tag | [optional] +**targetCommitish** | **String** | The new target commitish for the release | [optional] diff --git a/docs/EditTagProtectionOption.md b/docs/EditTagProtectionOption.md index 8f573c7..5ebac09 100644 --- a/docs/EditTagProtectionOption.md +++ b/docs/EditTagProtectionOption.md @@ -3,6 +3,6 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**namePattern** | **String** | | [optional] -**whitelistTeams** | **List<String>** | | [optional] -**whitelistUsernames** | **List<String>** | | [optional] +**namePattern** | **String** | The pattern to match tag names for protection | [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/EditTeamOption.md b/docs/EditTeamOption.md index ed8ac04..af2f34f 100644 --- a/docs/EditTeamOption.md +++ b/docs/EditTeamOption.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**canCreateOrgRepo** | **Boolean** | | [optional] -**description** | **String** | | [optional] -**includesAllRepositories** | **Boolean** | | [optional] +**canCreateOrgRepo** | **Boolean** | Whether the team can create repositories in the organization | [optional] +**description** | **String** | The description of the team | [optional] +**includesAllRepositories** | **Boolean** | Whether the team has access to all repositories in the organization | [optional] **name** | **String** | | **permission** | [**PermissionEnum**](#PermissionEnum) | | [optional] **units** | **List<String>** | | [optional] diff --git a/docs/EditUserOption.md b/docs/EditUserOption.md index b78349d..7a4396e 100644 --- a/docs/EditUserOption.md +++ b/docs/EditUserOption.md @@ -3,21 +3,21 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**active** | **Boolean** | | [optional] -**admin** | **Boolean** | | [optional] -**allowCreateOrganization** | **Boolean** | | [optional] -**allowGitHook** | **Boolean** | | [optional] -**allowImportLocal** | **Boolean** | | [optional] -**description** | **String** | | [optional] +**active** | **Boolean** | Whether the user account is active | [optional] +**admin** | **Boolean** | Whether the user has administrator privileges | [optional] +**allowCreateOrganization** | **Boolean** | Whether the user can create organizations | [optional] +**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] -**fullName** | **String** | | [optional] -**location** | **String** | | [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) | -**maxRepoCreation** | **Long** | | [optional] -**mustChangePassword** | **Boolean** | | [optional] -**password** | **String** | | [optional] -**prohibitLogin** | **Boolean** | | [optional] -**restricted** | **Boolean** | | [optional] +**maxRepoCreation** | **Long** | Maximum number of repositories the user can create | [optional] +**mustChangePassword** | **Boolean** | Whether the user must change password on next login | [optional] +**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** | **String** | | [optional] -**website** | **String** | | [optional] +**visibility** | **String** | 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 933a198..14029ca 100644 --- a/docs/Email.md +++ b/docs/Email.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **String** | | [optional] -**primary** | **Boolean** | | [optional] -**userId** | **Long** | | [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] -**verified** | **Boolean** | | [optional] +**verified** | **Boolean** | Whether the email address has been verified | [optional] diff --git a/docs/FileCommitResponse.md b/docs/FileCommitResponse.md index 142414a..70cbe5b 100644 --- a/docs/FileCommitResponse.md +++ b/docs/FileCommitResponse.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes **author** | [**CommitUser**](CommitUser.md) | | [optional] **committer** | [**CommitUser**](CommitUser.md) | | [optional] **created** | [**Date**](Date.md) | | [optional] -**htmlUrl** | **String** | | [optional] -**message** | **String** | | [optional] -**parents** | [**List<CommitMeta>**](CommitMeta.md) | | [optional] -**sha** | **String** | | [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] +**sha** | **String** | SHA is the commit SHA hash | [optional] **tree** | [**CommitMeta**](CommitMeta.md) | | [optional] -**url** | **String** | | [optional] +**url** | **String** | URL is the API URL for the commit | [optional] diff --git a/docs/FileDeleteResponse.md b/docs/FileDeleteResponse.md index c883bff..1386057 100644 --- a/docs/FileDeleteResponse.md +++ b/docs/FileDeleteResponse.md @@ -4,5 +4,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **commit** | [**FileCommitResponse**](FileCommitResponse.md) | | [optional] -**content** | **Object** | | [optional] +**content** | **Object** | Content is always null for delete operations | [optional] **verification** | [**PayloadCommitVerification**](PayloadCommitVerification.md) | | [optional] diff --git a/docs/FileLinksResponse.md b/docs/FileLinksResponse.md index ac213f0..ed5eabc 100644 --- a/docs/FileLinksResponse.md +++ b/docs/FileLinksResponse.md @@ -3,6 +3,6 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**git** | **String** | | [optional] -**html** | **String** | | [optional] -**self** | **String** | | [optional] +**git** | **String** | GitURL is the Git API URL for this file | [optional] +**html** | **String** | HTMLURL is the web URL for this file | [optional] +**self** | **String** | Self is the API URL for this file | [optional] diff --git a/docs/FilesResponse.md b/docs/FilesResponse.md index 06a5c6c..0520b7a 100644 --- a/docs/FilesResponse.md +++ b/docs/FilesResponse.md @@ -4,5 +4,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **commit** | [**FileCommitResponse**](FileCommitResponse.md) | | [optional] -**files** | [**List<ContentsResponse>**](ContentsResponse.md) | | [optional] +**files** | [**List<ContentsResponse>**](ContentsResponse.md) | Files contains the list of file contents and metadata | [optional] **verification** | [**PayloadCommitVerification**](PayloadCommitVerification.md) | | [optional] diff --git a/docs/GPGKey.md b/docs/GPGKey.md index eddb2e5..5cb34e0 100644 --- a/docs/GPGKey.md +++ b/docs/GPGKey.md @@ -3,16 +3,16 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**canCertify** | **Boolean** | | [optional] -**canEncryptComms** | **Boolean** | | [optional] -**canEncryptStorage** | **Boolean** | | [optional] -**canSign** | **Boolean** | | [optional] +**canCertify** | **Boolean** | Whether the key can be used for certification | [optional] +**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] -**emails** | [**List<GPGKeyEmail>**](GPGKeyEmail.md) | | [optional] +**emails** | [**List<GPGKeyEmail>**](GPGKeyEmail.md) | List of email addresses associated with this GPG key | [optional] **expiresAt** | [**Date**](Date.md) | | [optional] -**id** | **Long** | | [optional] -**keyId** | **String** | | [optional] -**primaryKeyId** | **String** | | [optional] -**publicKey** | **String** | | [optional] -**subkeys** | [**List<GPGKey>**](GPGKey.md) | | [optional] -**verified** | **Boolean** | | [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] +**publicKey** | **String** | The public key content in armored format | [optional] +**subkeys** | [**List<GPGKey>**](GPGKey.md) | List of subkeys of this GPG key | [optional] +**verified** | **Boolean** | Whether the GPG key has been verified | [optional] diff --git a/docs/GPGKeyEmail.md b/docs/GPGKeyEmail.md index 69e9694..75e55cf 100644 --- a/docs/GPGKeyEmail.md +++ b/docs/GPGKeyEmail.md @@ -3,5 +3,5 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**email** | **String** | | [optional] -**verified** | **Boolean** | | [optional] +**email** | **String** | The email address associated with the GPG key | [optional] +**verified** | **Boolean** | Whether the email address has been verified | [optional] diff --git a/docs/GeneralAPISettings.md b/docs/GeneralAPISettings.md index 00cd7de..31b0f41 100644 --- a/docs/GeneralAPISettings.md +++ b/docs/GeneralAPISettings.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**defaultGitTreesPerPage** | **Long** | | [optional] -**defaultMaxBlobSize** | **Long** | | [optional] -**defaultMaxResponseSize** | **Long** | | [optional] -**defaultPagingNum** | **Long** | | [optional] -**maxResponseItems** | **Long** | | [optional] +**defaultGitTreesPerPage** | **Long** | DefaultGitTreesPerPage is the default number of Git tree items per page | [optional] +**defaultMaxBlobSize** | **Long** | DefaultMaxBlobSize is the default maximum blob size for API responses | [optional] +**defaultMaxResponseSize** | **Long** | DefaultMaxResponseSize is the default maximum response size | [optional] +**defaultPagingNum** | **Long** | DefaultPagingNum is the default number of items per page | [optional] +**maxResponseItems** | **Long** | MaxResponseItems is the maximum number of items returned in API responses | [optional] diff --git a/docs/GeneralAttachmentSettings.md b/docs/GeneralAttachmentSettings.md index da9994d..0811af0 100644 --- a/docs/GeneralAttachmentSettings.md +++ b/docs/GeneralAttachmentSettings.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**allowedTypes** | **String** | | [optional] -**enabled** | **Boolean** | | [optional] -**maxFiles** | **Long** | | [optional] -**maxSize** | **Long** | | [optional] +**allowedTypes** | **String** | AllowedTypes contains the allowed file types for attachments | [optional] +**enabled** | **Boolean** | Enabled indicates if file attachments are enabled | [optional] +**maxFiles** | **Long** | MaxFiles is the maximum number of files per attachment | [optional] +**maxSize** | **Long** | MaxSize is the maximum size for individual attachments | [optional] diff --git a/docs/GeneralRepoSettings.md b/docs/GeneralRepoSettings.md index 9779cae..5f95309 100644 --- a/docs/GeneralRepoSettings.md +++ b/docs/GeneralRepoSettings.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**httpGitDisabled** | **Boolean** | | [optional] -**lfsDisabled** | **Boolean** | | [optional] -**migrationsDisabled** | **Boolean** | | [optional] -**mirrorsDisabled** | **Boolean** | | [optional] -**starsDisabled** | **Boolean** | | [optional] -**timeTrackingDisabled** | **Boolean** | | [optional] +**httpGitDisabled** | **Boolean** | HTTPGitDisabled indicates if HTTP Git operations are disabled | [optional] +**lfsDisabled** | **Boolean** | LFSDisabled indicates if Git LFS support is disabled | [optional] +**migrationsDisabled** | **Boolean** | MigrationsDisabled indicates if repository migrations are disabled | [optional] +**mirrorsDisabled** | **Boolean** | MirrorsDisabled indicates if repository mirroring is disabled | [optional] +**starsDisabled** | **Boolean** | StarsDisabled indicates if repository starring is disabled | [optional] +**timeTrackingDisabled** | **Boolean** | TimeTrackingDisabled indicates if time tracking is disabled | [optional] diff --git a/docs/GeneralUISettings.md b/docs/GeneralUISettings.md index cab7428..ee6c0ac 100644 --- a/docs/GeneralUISettings.md +++ b/docs/GeneralUISettings.md @@ -3,6 +3,6 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**allowedReactions** | **List<String>** | | [optional] -**customEmojis** | **List<String>** | | [optional] -**defaultTheme** | **String** | | [optional] +**allowedReactions** | **List<String>** | AllowedReactions contains the list of allowed emoji reactions | [optional] +**customEmojis** | **List<String>** | CustomEmojis contains the list of custom emojis | [optional] +**defaultTheme** | **String** | DefaultTheme is the default UI theme | [optional] diff --git a/docs/GetFilesOptions.md b/docs/GetFilesOptions.md index e36b7a3..bcb2d43 100644 --- a/docs/GetFilesOptions.md +++ b/docs/GetFilesOptions.md @@ -3,4 +3,4 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**files** | **List<String>** | | [optional] +**files** | **List<String>** | Files is the list of file paths to retrieve | [optional] diff --git a/docs/GitBlobResponse.md b/docs/GitBlobResponse.md index 2fed07d..67be685 100644 --- a/docs/GitBlobResponse.md +++ b/docs/GitBlobResponse.md @@ -3,10 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**content** | **String** | | [optional] -**encoding** | **String** | | [optional] -**lfsOid** | **String** | | [optional] -**lfsSize** | **Long** | | [optional] -**sha** | **String** | | [optional] -**size** | **Long** | | [optional] -**url** | **String** | | [optional] +**content** | **String** | The content of the git blob (may be base64 encoded) | [optional] +**encoding** | **String** | The encoding used for the content (e.g., \"base64\") | [optional] +**lfsOid** | **String** | The LFS object ID if this blob is stored in LFS | [optional] +**lfsSize** | **Long** | The size of the LFS object if this blob is stored in LFS | [optional] +**sha** | **String** | The SHA hash of the git blob | [optional] +**size** | **Long** | The size of the git blob in bytes | [optional] +**url** | **String** | The URL to access this git blob | [optional] diff --git a/docs/GitEntry.md b/docs/GitEntry.md index 89dc6f5..8f531ce 100644 --- a/docs/GitEntry.md +++ b/docs/GitEntry.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**mode** | **String** | | [optional] -**path** | **String** | | [optional] -**sha** | **String** | | [optional] -**size** | **Long** | | [optional] -**type** | **String** | | [optional] -**url** | **String** | | [optional] +**mode** | **String** | Mode is the file mode (permissions) | [optional] +**path** | **String** | Path is the file or directory path | [optional] +**sha** | **String** | SHA is the Git object SHA | [optional] +**size** | **Long** | Size is the file size in bytes | [optional] +**type** | **String** | Type indicates if this is a file, directory, or symlink | [optional] +**url** | **String** | URL is the API URL for this tree entry | [optional] diff --git a/docs/GitHook.md b/docs/GitHook.md index 2f82018..badff15 100644 --- a/docs/GitHook.md +++ b/docs/GitHook.md @@ -3,6 +3,6 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**content** | **String** | | [optional] -**isActive** | **Boolean** | | [optional] -**name** | **String** | | [optional] +**content** | **String** | Content contains the script content of the hook | [optional] +**isActive** | **Boolean** | IsActive indicates if the hook is active | [optional] +**name** | **String** | Name is the name of the Git hook | [optional] diff --git a/docs/GitObject.md b/docs/GitObject.md index fe74857..e47d463 100644 --- a/docs/GitObject.md +++ b/docs/GitObject.md @@ -3,6 +3,6 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**sha** | **String** | | [optional] -**type** | **String** | | [optional] -**url** | **String** | | [optional] +**sha** | **String** | The SHA hash of the Git object | [optional] +**type** | **String** | The type of the Git object (e.g., commit, tag, tree, blob) | [optional] +**url** | **String** | The URL to access this Git object | [optional] diff --git a/docs/GitTreeResponse.md b/docs/GitTreeResponse.md index 9d82e50..865e811 100644 --- a/docs/GitTreeResponse.md +++ b/docs/GitTreeResponse.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**page** | **Long** | | [optional] -**sha** | **String** | | [optional] -**totalCount** | **Long** | | [optional] -**tree** | [**List<GitEntry>**](GitEntry.md) | | [optional] -**truncated** | **Boolean** | | [optional] -**url** | **String** | | [optional] +**page** | **Long** | Page is the current page number for pagination | [optional] +**sha** | **String** | SHA is the tree object SHA | [optional] +**totalCount** | **Long** | TotalCount is the total number of entries in the tree | [optional] +**tree** | [**List<GitEntry>**](GitEntry.md) | Entries contains the tree entries (files and directories) | [optional] +**truncated** | **Boolean** | Truncated indicates if the response was truncated due to size | [optional] +**url** | **String** | URL is the API URL for this tree | [optional] diff --git a/docs/GitignoreTemplateInfo.md b/docs/GitignoreTemplateInfo.md index cc15dff..99420ef 100644 --- a/docs/GitignoreTemplateInfo.md +++ b/docs/GitignoreTemplateInfo.md @@ -3,5 +3,5 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **String** | | [optional] -**source** | **String** | | [optional] +**name** | **String** | Name is the name of the gitignore template | [optional] +**source** | **String** | Source contains the content of the gitignore template | [optional] diff --git a/docs/Hook.md b/docs/Hook.md index 7d546c7..2d9d95f 100644 --- a/docs/Hook.md +++ b/docs/Hook.md @@ -3,12 +3,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**active** | **Boolean** | | [optional] -**authorizationHeader** | **String** | | [optional] -**branchFilter** | **String** | | [optional] -**config** | **Map<String, String>** | | [optional] +**active** | **Boolean** | Whether the webhook is active and will be triggered | [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** | **Map<String, String>** | Configuration settings for the webhook | [optional] **createdAt** | [**Date**](Date.md) | | [optional] -**events** | **List<String>** | | [optional] -**id** | **Long** | | [optional] -**type** | **String** | | [optional] +**events** | **List<String>** | List of events that trigger this webhook | [optional] +**id** | **Long** | The unique identifier of the webhook | [optional] +**type** | **String** | The type of the webhook (e.g., gitea, slack, discord) | [optional] **updatedAt** | [**Date**](Date.md) | | [optional] diff --git a/docs/Identity.md b/docs/Identity.md index 270dfd5..4a58abd 100644 --- a/docs/Identity.md +++ b/docs/Identity.md @@ -4,4 +4,4 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **String** | | [optional] -**name** | **String** | | [optional] +**name** | **String** | Name is the person's name | [optional] diff --git a/docs/Label.md b/docs/Label.md index 051565d..fa2f172 100644 --- a/docs/Label.md +++ b/docs/Label.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **color** | **String** | | [optional] -**description** | **String** | | [optional] +**description** | **String** | Description provides additional context about the label's purpose | [optional] **exclusive** | **Boolean** | | [optional] -**id** | **Long** | | [optional] +**id** | **Long** | ID is the unique identifier for the label | [optional] **isArchived** | **Boolean** | | [optional] -**name** | **String** | | [optional] -**url** | **String** | | [optional] +**name** | **String** | Name is the display name of the label | [optional] +**url** | **String** | URL is the API endpoint for accessing this label | [optional] diff --git a/docs/LabelTemplate.md b/docs/LabelTemplate.md index 2d990dd..7818b6c 100644 --- a/docs/LabelTemplate.md +++ b/docs/LabelTemplate.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **color** | **String** | | [optional] -**description** | **String** | | [optional] +**description** | **String** | Description provides additional context about the label template's purpose | [optional] **exclusive** | **Boolean** | | [optional] -**name** | **String** | | [optional] +**name** | **String** | Name is the display name of the label template | [optional] diff --git a/docs/LicenseTemplateInfo.md b/docs/LicenseTemplateInfo.md index 82849d1..4bf8fb5 100644 --- a/docs/LicenseTemplateInfo.md +++ b/docs/LicenseTemplateInfo.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**body** | **String** | | [optional] -**implementation** | **String** | | [optional] -**key** | **String** | | [optional] -**name** | **String** | | [optional] -**url** | **String** | | [optional] +**body** | **String** | Body contains the full text of the license | [optional] +**implementation** | **String** | Implementation contains license implementation details | [optional] +**key** | **String** | Key is the unique identifier for the license template | [optional] +**name** | **String** | Name is the display name of the license | [optional] +**url** | **String** | URL is the reference URL for the license | [optional] diff --git a/docs/LicensesTemplateListEntry.md b/docs/LicensesTemplateListEntry.md index 70730c4..46995b0 100644 --- a/docs/LicensesTemplateListEntry.md +++ b/docs/LicensesTemplateListEntry.md @@ -3,6 +3,6 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**key** | **String** | | [optional] -**name** | **String** | | [optional] -**url** | **String** | | [optional] +**key** | **String** | Key is the unique identifier for the license template | [optional] +**name** | **String** | Name is the display name of the license | [optional] +**url** | **String** | URL is the reference URL for the license | [optional] diff --git a/docs/Milestone.md b/docs/Milestone.md index 2c2ad13..327373b 100644 --- a/docs/Milestone.md +++ b/docs/Milestone.md @@ -4,12 +4,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **closedAt** | [**Date**](Date.md) | | [optional] -**closedIssues** | **Long** | | [optional] +**closedIssues** | **Long** | ClosedIssues is the number of closed issues in this milestone | [optional] **createdAt** | [**Date**](Date.md) | | [optional] -**description** | **String** | | [optional] +**description** | **String** | Description provides details about the milestone | [optional] **dueOn** | [**Date**](Date.md) | | [optional] -**id** | **Long** | | [optional] -**openIssues** | **Long** | | [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** | **String** | | [optional] -**title** | **String** | | [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 97544e7..b96388b 100644 --- a/docs/ModelPackage.md +++ b/docs/ModelPackage.md @@ -5,10 +5,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **createdAt** | [**Date**](Date.md) | | [optional] **creator** | [**User**](User.md) | | [optional] -**htmlUrl** | **String** | | [optional] -**id** | **Long** | | [optional] -**name** | **String** | | [optional] +**htmlUrl** | **String** | The HTML URL to view the package | [optional] +**id** | **Long** | The unique identifier of the package | [optional] +**name** | **String** | The name of the package | [optional] **owner** | [**User**](User.md) | | [optional] **repository** | [**Repository**](Repository.md) | | [optional] -**type** | **String** | | [optional] -**version** | **String** | | [optional] +**type** | **String** | The type of the package (e.g., npm, maven, docker) | [optional] +**version** | **String** | The version of the package | [optional] diff --git a/docs/NodeInfo.md b/docs/NodeInfo.md index 774d2a1..14b8229 100644 --- a/docs/NodeInfo.md +++ b/docs/NodeInfo.md @@ -3,10 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**metadata** | **Object** | | [optional] -**openRegistrations** | **Boolean** | | [optional] -**protocols** | **List<String>** | | [optional] +**metadata** | **Object** | Metadata contains free form key value pairs for software specific values | [optional] +**openRegistrations** | **Boolean** | OpenRegistrations indicates if new user registrations are accepted | [optional] +**protocols** | **List<String>** | Protocols lists the protocols supported by this server | [optional] **services** | [**NodeInfoServices**](NodeInfoServices.md) | | [optional] **software** | [**NodeInfoSoftware**](NodeInfoSoftware.md) | | [optional] **usage** | [**NodeInfoUsage**](NodeInfoUsage.md) | | [optional] -**version** | **String** | | [optional] +**version** | **String** | Version specifies the schema version | [optional] diff --git a/docs/NodeInfoServices.md b/docs/NodeInfoServices.md index 8a85f40..edf45ab 100644 --- a/docs/NodeInfoServices.md +++ b/docs/NodeInfoServices.md @@ -3,5 +3,5 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**inbound** | **List<String>** | | [optional] -**outbound** | **List<String>** | | [optional] +**inbound** | **List<String>** | Inbound lists services that can deliver content to this server | [optional] +**outbound** | **List<String>** | Outbound lists services this server can deliver content to | [optional] diff --git a/docs/NodeInfoSoftware.md b/docs/NodeInfoSoftware.md index 287e0b4..7bdc9b0 100644 --- a/docs/NodeInfoSoftware.md +++ b/docs/NodeInfoSoftware.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**homepage** | **String** | | [optional] -**name** | **String** | | [optional] -**repository** | **String** | | [optional] -**version** | **String** | | [optional] +**homepage** | **String** | Homepage is the URL to the homepage of this server software | [optional] +**name** | **String** | Name is the canonical name of this server software | [optional] +**repository** | **String** | Repository is the URL to the source code repository | [optional] +**version** | **String** | Version is the version of this server software | [optional] diff --git a/docs/NodeInfoUsage.md b/docs/NodeInfoUsage.md index b428742..b189047 100644 --- a/docs/NodeInfoUsage.md +++ b/docs/NodeInfoUsage.md @@ -3,6 +3,6 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**localComments** | **Long** | | [optional] -**localPosts** | **Long** | | [optional] +**localComments** | **Long** | LocalComments is the total amount of comments made by users local to this server | [optional] +**localPosts** | **Long** | LocalPosts is the total amount of posts made by users local to this server | [optional] **users** | [**NodeInfoUsageUsers**](NodeInfoUsageUsers.md) | | [optional] diff --git a/docs/NodeInfoUsageUsers.md b/docs/NodeInfoUsageUsers.md index 653f407..a5ffa37 100644 --- a/docs/NodeInfoUsageUsers.md +++ b/docs/NodeInfoUsageUsers.md @@ -3,6 +3,6 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**activeHalfyear** | **Long** | | [optional] -**activeMonth** | **Long** | | [optional] -**total** | **Long** | | [optional] +**activeHalfyear** | **Long** | ActiveHalfyear is the amount of users that signed in at least once in the last 180 days | [optional] +**activeMonth** | **Long** | ActiveMonth is the amount of users that signed in at least once in the last 30 days | [optional] +**total** | **Long** | Total is the total amount of users on this server | [optional] diff --git a/docs/Note.md b/docs/Note.md index b2ddd9a..40bf3dd 100644 --- a/docs/Note.md +++ b/docs/Note.md @@ -4,4 +4,4 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **commit** | [**Commit**](Commit.md) | | [optional] -**message** | **String** | | [optional] +**message** | **String** | The content message of the git note | [optional] diff --git a/docs/NotificationCount.md b/docs/NotificationCount.md index bcbfdd7..2d0d742 100644 --- a/docs/NotificationCount.md +++ b/docs/NotificationCount.md @@ -3,4 +3,4 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**_new** | **Long** | | [optional] +**_new** | **Long** | New is the number of unread notifications | [optional] diff --git a/docs/NotificationSubject.md b/docs/NotificationSubject.md index dcc75f7..2784974 100644 --- a/docs/NotificationSubject.md +++ b/docs/NotificationSubject.md @@ -3,10 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**htmlUrl** | **String** | | [optional] -**latestCommentHtmlUrl** | **String** | | [optional] -**latestCommentUrl** | **String** | | [optional] +**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** | **String** | | [optional] -**title** | **String** | | [optional] +**title** | **String** | Title is the title of the notification subject | [optional] **type** | **String** | | [optional] -**url** | **String** | | [optional] +**url** | **String** | URL is the API URL for the notification subject | [optional] diff --git a/docs/NotificationThread.md b/docs/NotificationThread.md index eea4507..5a87c22 100644 --- a/docs/NotificationThread.md +++ b/docs/NotificationThread.md @@ -3,10 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **Long** | | [optional] -**pinned** | **Boolean** | | [optional] +**id** | **Long** | ID is the unique identifier for the notification thread | [optional] +**pinned** | **Boolean** | Pinned indicates if the notification is pinned | [optional] **repository** | [**Repository**](Repository.md) | | [optional] **subject** | [**NotificationSubject**](NotificationSubject.md) | | [optional] -**unread** | **Boolean** | | [optional] -**updatedAt** | [**Date**](Date.md) | | [optional] -**url** | **String** | | [optional] +**unread** | **Boolean** | Unread indicates if the notification has been read | [optional] +**updatedAt** | [**Date**](Date.md) | UpdatedAt is the time when the notification was last updated | [optional] +**url** | **String** | URL is the API URL for this notification thread | [optional] diff --git a/docs/OAuth2Application.md b/docs/OAuth2Application.md index 72c3507..7f415f1 100644 --- a/docs/OAuth2Application.md +++ b/docs/OAuth2Application.md @@ -3,11 +3,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**clientId** | **String** | | [optional] -**clientSecret** | **String** | | [optional] -**confidentialClient** | **Boolean** | | [optional] -**created** | [**Date**](Date.md) | | [optional] -**id** | **Long** | | [optional] -**name** | **String** | | [optional] -**redirectUris** | **List<String>** | | [optional] -**skipSecondaryAuthorization** | **Boolean** | | [optional] +**clientId** | **String** | The client ID of the OAuth2 application | [optional] +**clientSecret** | **String** | The client secret of the OAuth2 application | [optional] +**confidentialClient** | **Boolean** | Whether the client is confidential | [optional] +**created** | [**Date**](Date.md) | The timestamp when the application was created | [optional] +**id** | **Long** | The unique identifier of the OAuth2 application | [optional] +**name** | **String** | The name of the OAuth2 application | [optional] +**redirectUris** | **List<String>** | The list of allowed redirect URIs | [optional] +**skipSecondaryAuthorization** | **Boolean** | Whether to skip secondary authorization | [optional] diff --git a/docs/Organization.md b/docs/Organization.md index 14b41a6..2bbc0d7 100644 --- a/docs/Organization.md +++ b/docs/Organization.md @@ -3,14 +3,14 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**avatarUrl** | **String** | | [optional] -**description** | **String** | | [optional] -**email** | **String** | | [optional] -**fullName** | **String** | | [optional] -**id** | **Long** | | [optional] -**location** | **String** | | [optional] -**name** | **String** | | [optional] -**repoAdminChangeTeamAccess** | **Boolean** | | [optional] +**avatarUrl** | **String** | The URL of the organization's avatar | [optional] +**description** | **String** | The description of the organization | [optional] +**email** | **String** | The email address of the organization | [optional] +**fullName** | **String** | The full display name of the organization | [optional] +**id** | **Long** | The unique identifier of the organization | [optional] +**location** | **String** | The location of the organization | [optional] +**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** | **String** | | [optional] -**website** | **String** | | [optional] +**visibility** | **String** | The visibility level of the organization (public, limited, private) | [optional] +**website** | **String** | The website URL of the organization | [optional] diff --git a/docs/OrganizationPermissions.md b/docs/OrganizationPermissions.md index 02438c5..034c2bf 100644 --- a/docs/OrganizationPermissions.md +++ b/docs/OrganizationPermissions.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**canCreateRepository** | **Boolean** | | [optional] -**canRead** | **Boolean** | | [optional] -**canWrite** | **Boolean** | | [optional] -**isAdmin** | **Boolean** | | [optional] -**isOwner** | **Boolean** | | [optional] +**canCreateRepository** | **Boolean** | Whether the user can create repositories in the organization | [optional] +**canRead** | **Boolean** | Whether the user can read the organization | [optional] +**canWrite** | **Boolean** | Whether the user can write to the organization | [optional] +**isAdmin** | **Boolean** | Whether the user is an admin of the organization | [optional] +**isOwner** | **Boolean** | Whether the user is an owner of the organization | [optional] diff --git a/docs/PRBranchInfo.md b/docs/PRBranchInfo.md index 033e68c..daf1039 100644 --- a/docs/PRBranchInfo.md +++ b/docs/PRBranchInfo.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**label** | **String** | | [optional] -**ref** | **String** | | [optional] +**label** | **String** | The display name of the branch | [optional] +**ref** | **String** | The git reference of the branch | [optional] **repo** | [**Repository**](Repository.md) | | [optional] -**repoId** | **Long** | | [optional] -**sha** | **String** | | [optional] +**repoId** | **Long** | The unique identifier of the repository | [optional] +**sha** | **String** | The commit SHA of the branch head | [optional] diff --git a/docs/PackageFile.md b/docs/PackageFile.md index bd7bd1d..cbaf3ce 100644 --- a/docs/PackageFile.md +++ b/docs/PackageFile.md @@ -3,10 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **Long** | | [optional] -**md5** | **String** | | [optional] -**name** | **String** | | [optional] -**sha1** | **String** | | [optional] -**sha256** | **String** | | [optional] -**sha512** | **String** | | [optional] -**size** | **Long** | | [optional] +**id** | **Long** | The unique identifier of the package file | [optional] +**md5** | **String** | The MD5 hash of the package file | [optional] +**name** | **String** | The name of the package file | [optional] +**sha1** | **String** | The SHA1 hash of the package file | [optional] +**sha256** | **String** | The SHA256 hash of the package file | [optional] +**sha512** | **String** | The SHA512 hash of the package file | [optional] +**size** | **Long** | The size of the package file in bytes | [optional] diff --git a/docs/PayloadCommit.md b/docs/PayloadCommit.md index b5ffada..b14154d 100644 --- a/docs/PayloadCommit.md +++ b/docs/PayloadCommit.md @@ -3,13 +3,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**added** | **List<String>** | | [optional] +**added** | **List<String>** | List of files added in this commit | [optional] **author** | [**PayloadUser**](PayloadUser.md) | | [optional] **committer** | [**PayloadUser**](PayloadUser.md) | | [optional] **id** | **String** | sha1 hash of the commit | [optional] -**message** | **String** | | [optional] -**modified** | **List<String>** | | [optional] -**removed** | **List<String>** | | [optional] +**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] -**url** | **String** | | [optional] +**url** | **String** | The URL to view this commit | [optional] **verification** | [**PayloadCommitVerification**](PayloadCommitVerification.md) | | [optional] diff --git a/docs/PayloadCommitVerification.md b/docs/PayloadCommitVerification.md index 5c5f692..921cc18 100644 --- a/docs/PayloadCommitVerification.md +++ b/docs/PayloadCommitVerification.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**payload** | **String** | | [optional] -**reason** | **String** | | [optional] -**signature** | **String** | | [optional] +**payload** | **String** | The signed payload content | [optional] +**reason** | **String** | The reason for the verification status | [optional] +**signature** | **String** | The GPG signature of the commit | [optional] **signer** | [**PayloadUser**](PayloadUser.md) | | [optional] -**verified** | **Boolean** | | [optional] +**verified** | **Boolean** | Whether the commit signature is verified | [optional] diff --git a/docs/PublicKey.md b/docs/PublicKey.md index 0d149c1..cc05d97 100644 --- a/docs/PublicKey.md +++ b/docs/PublicKey.md @@ -4,12 +4,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **createdAt** | [**Date**](Date.md) | | [optional] -**fingerprint** | **String** | | [optional] -**id** | **Long** | | [optional] -**key** | **String** | | [optional] -**keyType** | **String** | | [optional] -**lastUsedAt** | [**Date**](Date.md) | | [optional] -**readOnly** | **Boolean** | | [optional] -**title** | **String** | | [optional] -**url** | **String** | | [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] +**keyType** | **String** | KeyType indicates the type of the SSH key | [optional] +**lastUsedAt** | [**Date**](Date.md) | Updated is the time when the key was last used | [optional] +**readOnly** | **Boolean** | ReadOnly indicates if the key has read-only access | [optional] +**title** | **String** | Title is the human-readable name for the key | [optional] +**url** | **String** | URL is the API URL for this key | [optional] **user** | [**User**](User.md) | | [optional] diff --git a/docs/PullRequest.md b/docs/PullRequest.md index f54e2f0..99dcba7 100644 --- a/docs/PullRequest.md +++ b/docs/PullRequest.md @@ -3,40 +3,40 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**additions** | **Long** | | [optional] -**allowMaintainerEdit** | **Boolean** | | [optional] +**additions** | **Long** | The number of lines added in the pull request | [optional] +**allowMaintainerEdit** | **Boolean** | Whether maintainers can edit the pull request | [optional] **assignee** | [**User**](User.md) | | [optional] -**assignees** | [**List<User>**](User.md) | | [optional] +**assignees** | [**List<User>**](User.md) | The list of users assigned to the pull request | [optional] **base** | [**PRBranchInfo**](PRBranchInfo.md) | | [optional] -**body** | **String** | | [optional] -**changedFiles** | **Long** | | [optional] +**body** | **String** | The description body of the pull request | [optional] +**changedFiles** | **Long** | The number of files changed in the pull request | [optional] **closedAt** | [**Date**](Date.md) | | [optional] -**comments** | **Long** | | [optional] +**comments** | **Long** | The number of comments on the pull request | [optional] **createdAt** | [**Date**](Date.md) | | [optional] -**deletions** | **Long** | | [optional] -**diffUrl** | **String** | | [optional] -**draft** | **Boolean** | | [optional] +**deletions** | **Long** | The number of lines deleted in the pull request | [optional] +**diffUrl** | **String** | The URL to download the diff patch | [optional] +**draft** | **Boolean** | Whether the pull request is a draft | [optional] **dueDate** | [**Date**](Date.md) | | [optional] **head** | [**PRBranchInfo**](PRBranchInfo.md) | | [optional] -**htmlUrl** | **String** | | [optional] -**id** | **Long** | | [optional] -**isLocked** | **Boolean** | | [optional] -**labels** | [**List<Label>**](Label.md) | | [optional] -**mergeBase** | **String** | | [optional] -**mergeCommitSha** | **String** | | [optional] -**mergeable** | **Boolean** | | [optional] -**merged** | **Boolean** | | [optional] +**htmlUrl** | **String** | The HTML URL to view the pull request | [optional] +**id** | **Long** | The unique identifier of the pull request | [optional] +**isLocked** | **Boolean** | Whether the pull request conversation is locked | [optional] +**labels** | [**List<Label>**](Label.md) | The labels attached to the pull request | [optional] +**mergeBase** | **String** | The merge base commit SHA | [optional] +**mergeCommitSha** | **String** | The SHA of the merge commit | [optional] +**mergeable** | **Boolean** | Whether the pull request can be merged | [optional] +**merged** | **Boolean** | Whether the pull request has been merged | [optional] **mergedAt** | [**Date**](Date.md) | | [optional] **mergedBy** | [**User**](User.md) | | [optional] **milestone** | [**Milestone**](Milestone.md) | | [optional] -**number** | **Long** | | [optional] -**patchUrl** | **String** | | [optional] -**pinOrder** | **Long** | | [optional] -**requestedReviewers** | [**List<User>**](User.md) | | [optional] -**requestedReviewersTeams** | [**List<Team>**](Team.md) | | [optional] +**number** | **Long** | The pull request number | [optional] +**patchUrl** | **String** | The URL to download the patch file | [optional] +**pinOrder** | **Long** | The pin order for the pull request | [optional] +**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** | **String** | | [optional] -**title** | **String** | | [optional] +**title** | **String** | The title of the pull request | [optional] **updatedAt** | [**Date**](Date.md) | | [optional] -**url** | **String** | | [optional] +**url** | **String** | The API URL of the pull request | [optional] **user** | [**User**](User.md) | | [optional] diff --git a/docs/PullReview.md b/docs/PullReview.md index ca55dbf..e507e40 100644 --- a/docs/PullReview.md +++ b/docs/PullReview.md @@ -7,10 +7,10 @@ Name | Type | Description | Notes **commentsCount** | **Long** | | [optional] **commitId** | **String** | | [optional] **dismissed** | **Boolean** | | [optional] -**htmlUrl** | **String** | | [optional] +**htmlUrl** | **String** | HTMLURL is the web URL for viewing the review | [optional] **id** | **Long** | | [optional] **official** | **Boolean** | | [optional] -**pullRequestUrl** | **String** | | [optional] +**pullRequestUrl** | **String** | HTMLPullURL is the web URL for the pull request | [optional] **stale** | **Boolean** | | [optional] **state** | **String** | | [optional] **submittedAt** | [**Date**](Date.md) | | [optional] diff --git a/docs/PushMirror.md b/docs/PushMirror.md index 5571e90..ae66797 100644 --- a/docs/PushMirror.md +++ b/docs/PushMirror.md @@ -4,10 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **created** | [**Date**](Date.md) | | [optional] -**interval** | **String** | | [optional] -**lastError** | **String** | | [optional] +**interval** | **String** | The sync interval for automatic updates | [optional] +**lastError** | **String** | The last error message encountered during sync | [optional] **lastUpdate** | [**Date**](Date.md) | | [optional] -**remoteAddress** | **String** | | [optional] -**remoteName** | **String** | | [optional] -**repoName** | **String** | | [optional] -**syncOnCommit** | **Boolean** | | [optional] +**remoteAddress** | **String** | The remote repository URL being mirrored to | [optional] +**remoteName** | **String** | The name of the remote in the git configuration | [optional] +**repoName** | **String** | The name of the source repository | [optional] +**syncOnCommit** | **Boolean** | Whether to sync on every commit | [optional] diff --git a/docs/Reaction.md b/docs/Reaction.md index 0384a48..7f2e185 100644 --- a/docs/Reaction.md +++ b/docs/Reaction.md @@ -3,6 +3,6 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**content** | **String** | | [optional] +**content** | **String** | The reaction content (e.g., emoji or reaction type) | [optional] **createdAt** | [**Date**](Date.md) | | [optional] **user** | [**User**](User.md) | | [optional] diff --git a/docs/Reference.md b/docs/Reference.md index 6dd168b..0fc46ac 100644 --- a/docs/Reference.md +++ b/docs/Reference.md @@ -4,5 +4,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **object** | [**GitObject**](GitObject.md) | | [optional] -**ref** | **String** | | [optional] -**url** | **String** | | [optional] +**ref** | **String** | The name of the Git reference (e.g., refs/heads/main) | [optional] +**url** | **String** | The URL to access this Git reference | [optional] diff --git a/docs/Release.md b/docs/Release.md index a4918f4..c3b3f90 100644 --- a/docs/Release.md +++ b/docs/Release.md @@ -3,19 +3,19 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**assets** | [**List<Attachment>**](Attachment.md) | | [optional] +**assets** | [**List<Attachment>**](Attachment.md) | The files attached to the release | [optional] **author** | [**User**](User.md) | | [optional] -**body** | **String** | | [optional] +**body** | **String** | The release notes or description | [optional] **createdAt** | [**Date**](Date.md) | | [optional] -**draft** | **Boolean** | | [optional] -**htmlUrl** | **String** | | [optional] -**id** | **Long** | | [optional] -**name** | **String** | | [optional] -**prerelease** | **Boolean** | | [optional] +**draft** | **Boolean** | Whether the release is a draft | [optional] +**htmlUrl** | **String** | The HTML URL to view the release | [optional] +**id** | **Long** | The unique identifier of the release | [optional] +**name** | **String** | The display title of the release | [optional] +**prerelease** | **Boolean** | Whether the release is a prerelease | [optional] **publishedAt** | [**Date**](Date.md) | | [optional] -**tagName** | **String** | | [optional] -**tarballUrl** | **String** | | [optional] -**targetCommitish** | **String** | | [optional] -**uploadUrl** | **String** | | [optional] -**url** | **String** | | [optional] -**zipballUrl** | **String** | | [optional] +**tagName** | **String** | The name of the git tag associated with the release | [optional] +**tarballUrl** | **String** | The URL to download the tarball archive | [optional] +**targetCommitish** | **String** | The target commitish for the release | [optional] +**uploadUrl** | **String** | The URL template for uploading release assets | [optional] +**url** | **String** | The API URL of the release | [optional] +**zipballUrl** | **String** | The URL to download the zip archive | [optional] diff --git a/docs/RepoCollaboratorPermission.md b/docs/RepoCollaboratorPermission.md index 53a481d..316adcf 100644 --- a/docs/RepoCollaboratorPermission.md +++ b/docs/RepoCollaboratorPermission.md @@ -3,6 +3,6 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**permission** | **String** | | [optional] -**roleName** | **String** | | [optional] +**permission** | **String** | 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/RepoCommit.md b/docs/RepoCommit.md index 9db5c35..91428af 100644 --- a/docs/RepoCommit.md +++ b/docs/RepoCommit.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **author** | [**CommitUser**](CommitUser.md) | | [optional] **committer** | [**CommitUser**](CommitUser.md) | | [optional] -**message** | **String** | | [optional] +**message** | **String** | Message is the commit message | [optional] **tree** | [**CommitMeta**](CommitMeta.md) | | [optional] -**url** | **String** | | [optional] +**url** | **String** | URL is the API URL for the commit | [optional] **verification** | [**PayloadCommitVerification**](PayloadCommitVerification.md) | | [optional] diff --git a/docs/SearchResults.md b/docs/SearchResults.md index 8da8c08..d11d9da 100644 --- a/docs/SearchResults.md +++ b/docs/SearchResults.md @@ -3,5 +3,5 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**List<Repository>**](Repository.md) | | [optional] -**ok** | **Boolean** | | [optional] +**data** | [**List<Repository>**](Repository.md) | Data contains the repository search results | [optional] +**ok** | **Boolean** | OK indicates if the search was successful | [optional] diff --git a/docs/ServerVersion.md b/docs/ServerVersion.md index e941b36..6443c73 100644 --- a/docs/ServerVersion.md +++ b/docs/ServerVersion.md @@ -3,4 +3,4 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**version** | **String** | | [optional] +**version** | **String** | Version is the server version string | [optional] diff --git a/docs/StopWatch.md b/docs/StopWatch.md index cae46c7..d52d820 100644 --- a/docs/StopWatch.md +++ b/docs/StopWatch.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **created** | [**Date**](Date.md) | | [optional] -**duration** | **String** | | [optional] -**issueIndex** | **Long** | | [optional] -**issueTitle** | **String** | | [optional] -**repoName** | **String** | | [optional] -**repoOwnerName** | **String** | | [optional] -**seconds** | **Long** | | [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] +**repoName** | **String** | RepoName is the name of the repository | [optional] +**repoOwnerName** | **String** | RepoOwnerName is the name of the repository owner | [optional] +**seconds** | **Long** | Seconds is the total elapsed time in seconds | [optional] diff --git a/docs/Tag.md b/docs/Tag.md index 120547e..882e901 100644 --- a/docs/Tag.md +++ b/docs/Tag.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **commit** | [**CommitMeta**](CommitMeta.md) | | [optional] -**id** | **String** | | [optional] -**message** | **String** | | [optional] -**name** | **String** | | [optional] -**tarballUrl** | **String** | | [optional] -**zipballUrl** | **String** | | [optional] +**id** | **String** | The ID (SHA) of the tag | [optional] +**message** | **String** | The message associated with the tag | [optional] +**name** | **String** | The name of the tag | [optional] +**tarballUrl** | **String** | The URL to download the tarball archive | [optional] +**zipballUrl** | **String** | The URL to download the zipball archive | [optional] diff --git a/docs/TagProtection.md b/docs/TagProtection.md index 173f314..1e9feb0 100644 --- a/docs/TagProtection.md +++ b/docs/TagProtection.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **createdAt** | [**Date**](Date.md) | | [optional] -**id** | **Long** | | [optional] -**namePattern** | **String** | | [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] -**whitelistTeams** | **List<String>** | | [optional] -**whitelistUsernames** | **List<String>** | | [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 acce8c2..7428008 100644 --- a/docs/Team.md +++ b/docs/Team.md @@ -3,11 +3,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**canCreateOrgRepo** | **Boolean** | | [optional] -**description** | **String** | | [optional] -**id** | **Long** | | [optional] -**includesAllRepositories** | **Boolean** | | [optional] -**name** | **String** | | [optional] +**canCreateOrgRepo** | **Boolean** | Whether the team can create repositories in the organization | [optional] +**description** | **String** | The description of the team | [optional] +**id** | **Long** | The unique identifier of the team | [optional] +**includesAllRepositories** | **Boolean** | Whether the team has access to all repositories in the organization | [optional] +**name** | **String** | The name of the team | [optional] **organization** | [**Organization**](Organization.md) | | [optional] **permission** | [**PermissionEnum**](#PermissionEnum) | | [optional] **units** | **List<String>** | | [optional] diff --git a/docs/TimelineComment.md b/docs/TimelineComment.md index 7921a10..92610c3 100644 --- a/docs/TimelineComment.md +++ b/docs/TimelineComment.md @@ -5,12 +5,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **assignee** | [**User**](User.md) | | [optional] **assigneeTeam** | [**Team**](Team.md) | | [optional] -**body** | **String** | | [optional] +**body** | **String** | Body contains the timeline event content | [optional] **createdAt** | [**Date**](Date.md) | | [optional] **dependentIssue** | [**Issue**](Issue.md) | | [optional] -**htmlUrl** | **String** | | [optional] -**id** | **Long** | | [optional] -**issueUrl** | **String** | | [optional] +**htmlUrl** | **String** | HTMLURL is the web URL for viewing the comment | [optional] +**id** | **Long** | ID is the unique identifier for the timeline comment | [optional] +**issueUrl** | **String** | IssueURL is the API URL for the issue | [optional] **label** | [**Label**](Label.md) | | [optional] **milestone** | [**Milestone**](Milestone.md) | | [optional] **newRef** | **String** | | [optional] @@ -20,7 +20,7 @@ Name | Type | Description | Notes **oldRef** | **String** | | [optional] **oldTitle** | **String** | | [optional] **projectId** | **Long** | | [optional] -**pullRequestUrl** | **String** | | [optional] +**pullRequestUrl** | **String** | PRURL is the API URL for the pull request (if applicable) | [optional] **refAction** | **String** | | [optional] **refComment** | [**Comment**](Comment.md) | | [optional] **refCommitSha** | **String** | commit SHA where issue/PR was referenced | [optional] @@ -29,6 +29,6 @@ Name | Type | Description | Notes **resolveDoer** | [**User**](User.md) | | [optional] **reviewId** | **Long** | | [optional] **trackedTime** | [**TrackedTime**](TrackedTime.md) | | [optional] -**type** | **String** | | [optional] +**type** | **String** | Type indicates the type of timeline event | [optional] **updatedAt** | [**Date**](Date.md) | | [optional] **user** | [**User**](User.md) | | [optional] diff --git a/docs/TopicName.md b/docs/TopicName.md index 7e7ffcd..c67661c 100644 --- a/docs/TopicName.md +++ b/docs/TopicName.md @@ -3,4 +3,4 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**topics** | **List<String>** | | [optional] +**topics** | **List<String>** | List of topic names | [optional] diff --git a/docs/TopicResponse.md b/docs/TopicResponse.md index 42e9b0d..b7d3402 100644 --- a/docs/TopicResponse.md +++ b/docs/TopicResponse.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | [**Date**](Date.md) | | [optional] -**id** | **Long** | | [optional] -**repoCount** | **Long** | | [optional] -**topicName** | **String** | | [optional] -**updated** | [**Date**](Date.md) | | [optional] +**created** | [**Date**](Date.md) | The date and time when the topic was created | [optional] +**id** | **Long** | The unique identifier of the topic | [optional] +**repoCount** | **Long** | The number of repositories using this topic | [optional] +**topicName** | **String** | The name of the topic | [optional] +**updated** | [**Date**](Date.md) | The date and time when the topic was last updated | [optional] diff --git a/docs/TrackedTime.md b/docs/TrackedTime.md index ec0a0de..b61235c 100644 --- a/docs/TrackedTime.md +++ b/docs/TrackedTime.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **created** | [**Date**](Date.md) | | [optional] -**id** | **Long** | | [optional] +**id** | **Long** | ID is the unique identifier for the tracked time entry | [optional] **issue** | [**Issue**](Issue.md) | | [optional] **issueId** | **Long** | deprecated (only for backwards compatibility) | [optional] **time** | **Long** | Time in seconds | [optional] diff --git a/docs/WatchInfo.md b/docs/WatchInfo.md index 8907792..f01d3ea 100644 --- a/docs/WatchInfo.md +++ b/docs/WatchInfo.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**createdAt** | [**Date**](Date.md) | | [optional] -**ignored** | **Boolean** | | [optional] -**reason** | **Object** | | [optional] -**repositoryUrl** | **String** | | [optional] -**subscribed** | **Boolean** | | [optional] -**url** | **String** | | [optional] +**createdAt** | [**Date**](Date.md) | The timestamp when the watch status was created | [optional] +**ignored** | **Boolean** | Whether notifications for the repository are ignored | [optional] +**reason** | **Object** | The reason for the current watch status | [optional] +**repositoryUrl** | **String** | The URL of the repository being watched | [optional] +**subscribed** | **Boolean** | Whether the repository is being watched for notifications | [optional] +**url** | **String** | The URL for managing the watch status | [optional] diff --git a/docs/WikiCommit.md b/docs/WikiCommit.md index c1a74f8..791f6e6 100644 --- a/docs/WikiCommit.md +++ b/docs/WikiCommit.md @@ -5,5 +5,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **author** | [**CommitUser**](CommitUser.md) | | [optional] **commiter** | [**CommitUser**](CommitUser.md) | | [optional] -**message** | **String** | | [optional] -**sha** | **String** | | [optional] +**message** | **String** | The commit message | [optional] +**sha** | **String** | The commit SHA hash | [optional] diff --git a/docs/WikiCommitList.md b/docs/WikiCommitList.md index dd64396..6a8fc7e 100644 --- a/docs/WikiCommitList.md +++ b/docs/WikiCommitList.md @@ -3,5 +3,5 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**commits** | [**List<WikiCommit>**](WikiCommit.md) | | [optional] -**count** | **Long** | | [optional] +**commits** | [**List<WikiCommit>**](WikiCommit.md) | The list of wiki commits | [optional] +**count** | **Long** | The total count of commits | [optional] diff --git a/docs/WikiPage.md b/docs/WikiPage.md index 5b67d69..e1624be 100644 --- a/docs/WikiPage.md +++ b/docs/WikiPage.md @@ -3,11 +3,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**commitCount** | **Long** | | [optional] +**commitCount** | **Long** | The number of commits that modified this page | [optional] **contentBase64** | **String** | Page content, base64 encoded | [optional] -**footer** | **String** | | [optional] -**htmlUrl** | **String** | | [optional] +**footer** | **String** | The footer content for the wiki page | [optional] +**htmlUrl** | **String** | The HTML URL to view the wiki page | [optional] **lastCommit** | [**WikiCommit**](WikiCommit.md) | | [optional] -**sidebar** | **String** | | [optional] -**subUrl** | **String** | | [optional] -**title** | **String** | | [optional] +**sidebar** | **String** | The sidebar content for the wiki page | [optional] +**subUrl** | **String** | The sub URL path for the wiki page | [optional] +**title** | **String** | The title of the wiki page | [optional] diff --git a/docs/WikiPageMetaData.md b/docs/WikiPageMetaData.md index 9d0267f..5974ff0 100644 --- a/docs/WikiPageMetaData.md +++ b/docs/WikiPageMetaData.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**htmlUrl** | **String** | | [optional] +**htmlUrl** | **String** | The HTML URL to view the wiki page | [optional] **lastCommit** | [**WikiCommit**](WikiCommit.md) | | [optional] -**subUrl** | **String** | | [optional] -**title** | **String** | | [optional] +**subUrl** | **String** | The sub URL path for the wiki page | [optional] +**title** | **String** | The title of the wiki page | [optional] diff --git a/src/main/java/org/gitnex/tea4j/v2/models/APIError.java b/src/main/java/org/gitnex/tea4j/v2/models/APIError.java index 5ebf6a5..dcd0e2f 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/APIError.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/APIError.java @@ -34,11 +34,11 @@ public class APIError implements Serializable { } /** - * Get message + * Message contains the error description * * @return message */ - @Schema(description = "") + @Schema(description = "Message contains the error description") public String getMessage() { return message; } @@ -53,11 +53,11 @@ public class APIError implements Serializable { } /** - * Get url + * URL contains the documentation URL for this error * * @return url */ - @Schema(description = "") + @Schema(description = "URL contains the documentation URL for this error") public String getUrl() { return url; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/AccessToken.java b/src/main/java/org/gitnex/tea4j/v2/models/AccessToken.java index d508c9f..1f73448 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/AccessToken.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/AccessToken.java @@ -51,11 +51,11 @@ public class AccessToken implements Serializable { } /** - * Get createdAt + * The timestamp when the token was created * * @return createdAt */ - @Schema(description = "") + @Schema(description = "The timestamp when the token was created") public Date getCreatedAt() { return createdAt; } @@ -70,11 +70,11 @@ public class AccessToken implements Serializable { } /** - * Get id + * The unique identifier of the access token * * @return id */ - @Schema(description = "") + @Schema(description = "The unique identifier of the access token") public Long getId() { return id; } @@ -89,11 +89,11 @@ public class AccessToken implements Serializable { } /** - * Get lastUsedAt + * The timestamp when the token was last used * * @return lastUsedAt */ - @Schema(description = "") + @Schema(description = "The timestamp when the token was last used") public Date getLastUsedAt() { return lastUsedAt; } @@ -108,11 +108,11 @@ public class AccessToken implements Serializable { } /** - * Get name + * The name of the access token * * @return name */ - @Schema(description = "") + @Schema(description = "The name of the access token") public String getName() { return name; } @@ -135,11 +135,11 @@ public class AccessToken implements Serializable { } /** - * Get scopes + * The scopes granted to this access token * * @return scopes */ - @Schema(description = "") + @Schema(description = "The scopes granted to this access token") public List getScopes() { return scopes; } @@ -154,11 +154,11 @@ public class AccessToken implements Serializable { } /** - * Get sha1 + * The SHA1 hash of the access token * * @return sha1 */ - @Schema(description = "") + @Schema(description = "The SHA1 hash of the access token") public String getSha1() { return sha1; } @@ -173,11 +173,11 @@ public class AccessToken implements Serializable { } /** - * Get tokenLastEight + * The last eight characters of the token * * @return tokenLastEight */ - @Schema(description = "") + @Schema(description = "The last eight characters of the token") public String getTokenLastEight() { return tokenLastEight; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/ActionTask.java b/src/main/java/org/gitnex/tea4j/v2/models/ActionTask.java index 97a1183..53fe668 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/ActionTask.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/ActionTask.java @@ -87,11 +87,11 @@ public class ActionTask implements Serializable { } /** - * Get displayTitle + * DisplayTitle is the display title for the workflow run * * @return displayTitle */ - @Schema(description = "") + @Schema(description = "DisplayTitle is the display title for the workflow run") public String getDisplayTitle() { return displayTitle; } @@ -106,11 +106,11 @@ public class ActionTask implements Serializable { } /** - * Get event + * Event is the type of event that triggered the workflow * * @return event */ - @Schema(description = "") + @Schema(description = "Event is the type of event that triggered the workflow") public String getEvent() { return event; } @@ -125,11 +125,11 @@ public class ActionTask implements Serializable { } /** - * Get headBranch + * HeadBranch is the branch that triggered the workflow * * @return headBranch */ - @Schema(description = "") + @Schema(description = "HeadBranch is the branch that triggered the workflow") public String getHeadBranch() { return headBranch; } @@ -144,11 +144,11 @@ public class ActionTask implements Serializable { } /** - * Get headSha + * HeadSHA is the commit SHA that triggered the workflow * * @return headSha */ - @Schema(description = "") + @Schema(description = "HeadSHA is the commit SHA that triggered the workflow") public String getHeadSha() { return headSha; } @@ -163,11 +163,11 @@ public class ActionTask implements Serializable { } /** - * Get id + * ID is the unique identifier for the action task * * @return id */ - @Schema(description = "") + @Schema(description = "ID is the unique identifier for the action task") public Long getId() { return id; } @@ -182,11 +182,11 @@ public class ActionTask implements Serializable { } /** - * Get name + * Name is the name of the workflow * * @return name */ - @Schema(description = "") + @Schema(description = "Name is the name of the workflow") public String getName() { return name; } @@ -201,11 +201,11 @@ public class ActionTask implements Serializable { } /** - * Get runNumber + * RunNumber is the sequential number of the workflow run * * @return runNumber */ - @Schema(description = "") + @Schema(description = "RunNumber is the sequential number of the workflow run") public Long getRunNumber() { return runNumber; } @@ -239,11 +239,11 @@ public class ActionTask implements Serializable { } /** - * Get status + * Status indicates the current status of the workflow run * * @return status */ - @Schema(description = "") + @Schema(description = "Status indicates the current status of the workflow run") public String getStatus() { return status; } @@ -277,11 +277,11 @@ public class ActionTask implements Serializable { } /** - * Get url + * URL is the API URL for this workflow run * * @return url */ - @Schema(description = "") + @Schema(description = "URL is the API URL for this workflow run") public String getUrl() { return url; } @@ -296,11 +296,11 @@ public class ActionTask implements Serializable { } /** - * Get workflowId + * WorkflowID is the identifier of the workflow * * @return workflowId */ - @Schema(description = "") + @Schema(description = "WorkflowID is the identifier of the workflow") public String getWorkflowId() { return workflowId; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/ActionTaskResponse.java b/src/main/java/org/gitnex/tea4j/v2/models/ActionTaskResponse.java index cfd6c4f..b2fb12c 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/ActionTaskResponse.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/ActionTaskResponse.java @@ -36,11 +36,11 @@ public class ActionTaskResponse implements Serializable { } /** - * Get totalCount + * TotalCount is the total number of workflow runs * * @return totalCount */ - @Schema(description = "") + @Schema(description = "TotalCount is the total number of workflow runs") public Long getTotalCount() { return totalCount; } @@ -63,11 +63,11 @@ public class ActionTaskResponse implements Serializable { } /** - * Get workflowRuns + * Entries contains the list of workflow runs * * @return workflowRuns */ - @Schema(description = "") + @Schema(description = "Entries contains the list of workflow runs") public List getWorkflowRuns() { return workflowRuns; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/ActionWorkflow.java b/src/main/java/org/gitnex/tea4j/v2/models/ActionWorkflow.java index 450bfec..5de8a69 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/ActionWorkflow.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/ActionWorkflow.java @@ -59,11 +59,11 @@ public class ActionWorkflow implements Serializable { } /** - * Get badgeUrl + * BadgeURL is the URL for the workflow badge * * @return badgeUrl */ - @Schema(description = "") + @Schema(description = "BadgeURL is the URL for the workflow badge") public String getBadgeUrl() { return badgeUrl; } @@ -116,11 +116,11 @@ public class ActionWorkflow implements Serializable { } /** - * Get htmlUrl + * HTMLURL is the web URL for viewing the workflow * * @return htmlUrl */ - @Schema(description = "") + @Schema(description = "HTMLURL is the web URL for viewing the workflow") public String getHtmlUrl() { return htmlUrl; } @@ -135,11 +135,11 @@ public class ActionWorkflow implements Serializable { } /** - * Get id + * ID is the unique identifier for the workflow * * @return id */ - @Schema(description = "") + @Schema(description = "ID is the unique identifier for the workflow") public String getId() { return id; } @@ -154,11 +154,11 @@ public class ActionWorkflow implements Serializable { } /** - * Get name + * Name is the name of the workflow * * @return name */ - @Schema(description = "") + @Schema(description = "Name is the name of the workflow") public String getName() { return name; } @@ -173,11 +173,11 @@ public class ActionWorkflow implements Serializable { } /** - * Get path + * Path is the file path of the workflow * * @return path */ - @Schema(description = "") + @Schema(description = "Path is the file path of the workflow") public String getPath() { return path; } @@ -192,11 +192,11 @@ public class ActionWorkflow implements Serializable { } /** - * Get state + * State indicates if the workflow is active or disabled * * @return state */ - @Schema(description = "") + @Schema(description = "State indicates if the workflow is active or disabled") public String getState() { return state; } @@ -230,11 +230,11 @@ public class ActionWorkflow implements Serializable { } /** - * Get url + * URL is the API URL for this workflow * * @return url */ - @Schema(description = "") + @Schema(description = "URL is the API URL for this workflow") public String getUrl() { return url; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/Activity.java b/src/main/java/org/gitnex/tea4j/v2/models/Activity.java index 1145dd0..62589bf 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/Activity.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/Activity.java @@ -161,11 +161,11 @@ public class Activity implements Serializable { } /** - * Get actUserId + * The ID of the user who performed the action * * @return actUserId */ - @Schema(description = "") + @Schema(description = "The ID of the user who performed the action") public Long getActUserId() { return actUserId; } @@ -199,11 +199,11 @@ public class Activity implements Serializable { } /** - * Get commentId + * The ID of the comment associated with the activity (if applicable) * * @return commentId */ - @Schema(description = "") + @Schema(description = "The ID of the comment associated with the activity (if applicable)") public Long getCommentId() { return commentId; } @@ -218,11 +218,11 @@ public class Activity implements Serializable { } /** - * Get content + * Additional content or details about the activity * * @return content */ - @Schema(description = "") + @Schema(description = "Additional content or details about the activity") public String getContent() { return content; } @@ -237,11 +237,11 @@ public class Activity implements Serializable { } /** - * Get created + * The date and time when the activity occurred * * @return created */ - @Schema(description = "") + @Schema(description = "The date and time when the activity occurred") public Date getCreated() { return created; } @@ -256,11 +256,11 @@ public class Activity implements Serializable { } /** - * Get id + * The unique identifier of the activity * * @return id */ - @Schema(description = "") + @Schema(description = "The unique identifier of the activity") public Long getId() { return id; } @@ -275,11 +275,11 @@ public class Activity implements Serializable { } /** - * Get isPrivate + * Whether this activity is from a private repository * * @return isPrivate */ - @Schema(description = "") + @Schema(description = "Whether this activity is from a private repository") public Boolean isIsPrivate() { return isPrivate; } @@ -313,11 +313,11 @@ public class Activity implements Serializable { } /** - * Get refName + * The name of the git reference (branch/tag) associated with the activity * * @return refName */ - @Schema(description = "") + @Schema(description = "The name of the git reference (branch/tag) associated with the activity") public String getRefName() { return refName; } @@ -351,11 +351,11 @@ public class Activity implements Serializable { } /** - * Get repoId + * The ID of the repository associated with the activity * * @return repoId */ - @Schema(description = "") + @Schema(description = "The ID of the repository associated with the activity") public Long getRepoId() { return repoId; } @@ -370,11 +370,11 @@ public class Activity implements Serializable { } /** - * Get userId + * The ID of the user who receives/sees this activity * * @return userId */ - @Schema(description = "") + @Schema(description = "The ID of the user who receives/sees this activity") public Long getUserId() { return userId; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/ActivityPub.java b/src/main/java/org/gitnex/tea4j/v2/models/ActivityPub.java index 359b354..93e295c 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/ActivityPub.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/ActivityPub.java @@ -31,11 +31,11 @@ public class ActivityPub implements Serializable { } /** - * Get _atContext + * Context defines the JSON-LD context for ActivityPub * * @return _atContext */ - @Schema(description = "") + @Schema(description = "Context defines the JSON-LD context for ActivityPub") public String getAtContext() { return _atContext; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/AnnotatedTag.java b/src/main/java/org/gitnex/tea4j/v2/models/AnnotatedTag.java index 0891d9e..6fda87d 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/AnnotatedTag.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/AnnotatedTag.java @@ -49,11 +49,11 @@ public class AnnotatedTag implements Serializable { } /** - * Get message + * The message associated with the annotated tag * * @return message */ - @Schema(description = "") + @Schema(description = "The message associated with the annotated tag") public String getMessage() { return message; } @@ -87,11 +87,11 @@ public class AnnotatedTag implements Serializable { } /** - * Get sha + * The SHA hash of the annotated tag * * @return sha */ - @Schema(description = "") + @Schema(description = "The SHA hash of the annotated tag") public String getSha() { return sha; } @@ -106,11 +106,11 @@ public class AnnotatedTag implements Serializable { } /** - * Get tag + * The name of the annotated tag * * @return tag */ - @Schema(description = "") + @Schema(description = "The name of the annotated tag") public String getTag() { return tag; } @@ -144,11 +144,11 @@ public class AnnotatedTag implements Serializable { } /** - * Get url + * The URL to access the annotated tag * * @return url */ - @Schema(description = "") + @Schema(description = "The URL to access the annotated tag") public String getUrl() { return url; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/AnnotatedTagObject.java b/src/main/java/org/gitnex/tea4j/v2/models/AnnotatedTagObject.java index 5f5fca7..04a98c4 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/AnnotatedTagObject.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/AnnotatedTagObject.java @@ -37,11 +37,11 @@ public class AnnotatedTagObject implements Serializable { } /** - * Get sha + * The SHA hash of the tagged object * * @return sha */ - @Schema(description = "") + @Schema(description = "The SHA hash of the tagged object") public String getSha() { return sha; } @@ -56,11 +56,11 @@ public class AnnotatedTagObject implements Serializable { } /** - * Get type + * The type of the tagged object (e.g., commit, tree) * * @return type */ - @Schema(description = "") + @Schema(description = "The type of the tagged object (e.g., commit, tree)") public String getType() { return type; } @@ -75,11 +75,11 @@ public class AnnotatedTagObject implements Serializable { } /** - * Get url + * The URL to access the tagged object * * @return url */ - @Schema(description = "") + @Schema(description = "The URL to access the tagged object") public String getUrl() { return url; } 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 c77bc54..7956ea1 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/Attachment.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/Attachment.java @@ -50,11 +50,11 @@ public class Attachment implements Serializable { } /** - * Get browserDownloadUrl + * DownloadURL is the URL to download the attachment * * @return browserDownloadUrl */ - @Schema(description = "") + @Schema(description = "DownloadURL is the URL to download the attachment") public String getBrowserDownloadUrl() { return browserDownloadUrl; } @@ -88,11 +88,11 @@ public class Attachment implements Serializable { } /** - * Get downloadCount + * DownloadCount is the number of times the attachment has been downloaded * * @return downloadCount */ - @Schema(description = "") + @Schema(description = "DownloadCount is the number of times the attachment has been downloaded") public Long getDownloadCount() { return downloadCount; } @@ -107,11 +107,11 @@ public class Attachment implements Serializable { } /** - * Get id + * ID is the unique identifier for the attachment * * @return id */ - @Schema(description = "") + @Schema(description = "ID is the unique identifier for the attachment") public Long getId() { return id; } @@ -126,11 +126,11 @@ public class Attachment implements Serializable { } /** - * Get name + * Name is the filename of the attachment * * @return name */ - @Schema(description = "") + @Schema(description = "Name is the filename of the attachment") public String getName() { return name; } @@ -145,11 +145,11 @@ public class Attachment implements Serializable { } /** - * Get size + * Size is the file size in bytes * * @return size */ - @Schema(description = "") + @Schema(description = "Size is the file size in bytes") public Long getSize() { return size; } @@ -164,11 +164,11 @@ public class Attachment implements Serializable { } /** - * Get uuid + * UUID is the unique identifier for the attachment file * * @return uuid */ - @Schema(description = "") + @Schema(description = "UUID is the unique identifier for the attachment file") public String getUuid() { return uuid; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/Branch.java b/src/main/java/org/gitnex/tea4j/v2/models/Branch.java index 6d19dbf..a826549 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/Branch.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/Branch.java @@ -76,11 +76,13 @@ public class Branch implements Serializable { } /** - * Get effectiveBranchProtectionName + * EffectiveBranchProtectionName is the name of the effective branch protection rule * * @return effectiveBranchProtectionName */ - @Schema(description = "") + @Schema( + description = + "EffectiveBranchProtectionName is the name of the effective branch protection rule") public String getEffectiveBranchProtectionName() { return effectiveBranchProtectionName; } @@ -95,11 +97,11 @@ public class Branch implements Serializable { } /** - * Get enableStatusCheck + * EnableStatusCheck indicates if status checks are enabled * * @return enableStatusCheck */ - @Schema(description = "") + @Schema(description = "EnableStatusCheck indicates if status checks are enabled") public Boolean isEnableStatusCheck() { return enableStatusCheck; } @@ -114,11 +116,11 @@ public class Branch implements Serializable { } /** - * Get name + * Name is the branch name * * @return name */ - @Schema(description = "") + @Schema(description = "Name is the branch name") public String getName() { return name; } @@ -133,11 +135,11 @@ public class Branch implements Serializable { } /** - * Get _protected + * Protected indicates if the branch is protected * * @return _protected */ - @Schema(description = "") + @Schema(description = "Protected indicates if the branch is protected") public Boolean isProtected() { return _protected; } @@ -152,11 +154,11 @@ public class Branch implements Serializable { } /** - * Get requiredApprovals + * RequiredApprovals is the number of required approvals for pull requests * * @return requiredApprovals */ - @Schema(description = "") + @Schema(description = "RequiredApprovals is the number of required approvals for pull requests") public Long getRequiredApprovals() { return requiredApprovals; } @@ -179,11 +181,11 @@ public class Branch implements Serializable { } /** - * Get statusCheckContexts + * StatusCheckContexts contains the list of required status check contexts * * @return statusCheckContexts */ - @Schema(description = "") + @Schema(description = "StatusCheckContexts contains the list of required status check contexts") public List getStatusCheckContexts() { return statusCheckContexts; } @@ -198,11 +200,11 @@ public class Branch implements Serializable { } /** - * Get userCanMerge + * UserCanMerge indicates if the current user can merge to this branch * * @return userCanMerge */ - @Schema(description = "") + @Schema(description = "UserCanMerge indicates if the current user can merge to this branch") public Boolean isUserCanMerge() { return userCanMerge; } @@ -217,11 +219,11 @@ public class Branch implements Serializable { } /** - * Get userCanPush + * UserCanPush indicates if the current user can push to this branch * * @return userCanPush */ - @Schema(description = "") + @Schema(description = "UserCanPush indicates if the current user can push to this branch") public Boolean isUserCanPush() { return userCanPush; } 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 235ce99..c429bdd 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/BranchProtection.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/BranchProtection.java @@ -597,11 +597,11 @@ public class BranchProtection implements Serializable { } /** - * Get priority + * Priority is the priority of this branch protection rule * * @return priority */ - @Schema(description = "") + @Schema(description = "Priority is the priority of this branch protection rule") public Long getPriority() { return priority; } @@ -746,11 +746,11 @@ public class BranchProtection implements Serializable { } /** - * Get ruleName + * RuleName is the name of the branch protection rule * * @return ruleName */ - @Schema(description = "") + @Schema(description = "RuleName is the name of the branch protection rule") public String getRuleName() { return ruleName; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/ChangedFile.java b/src/main/java/org/gitnex/tea4j/v2/models/ChangedFile.java index ad188ad..fdd2654 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/ChangedFile.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/ChangedFile.java @@ -55,11 +55,11 @@ public class ChangedFile implements Serializable { } /** - * Get additions + * The number of lines added to the file * * @return additions */ - @Schema(description = "") + @Schema(description = "The number of lines added to the file") public Long getAdditions() { return additions; } @@ -74,11 +74,11 @@ public class ChangedFile implements Serializable { } /** - * Get changes + * The total number of changes to the file * * @return changes */ - @Schema(description = "") + @Schema(description = "The total number of changes to the file") public Long getChanges() { return changes; } @@ -93,11 +93,11 @@ public class ChangedFile implements Serializable { } /** - * Get contentsUrl + * The API URL to get the file contents * * @return contentsUrl */ - @Schema(description = "") + @Schema(description = "The API URL to get the file contents") public String getContentsUrl() { return contentsUrl; } @@ -112,11 +112,11 @@ public class ChangedFile implements Serializable { } /** - * Get deletions + * The number of lines deleted from the file * * @return deletions */ - @Schema(description = "") + @Schema(description = "The number of lines deleted from the file") public Long getDeletions() { return deletions; } @@ -131,11 +131,11 @@ public class ChangedFile implements Serializable { } /** - * Get filename + * The name of the changed file * * @return filename */ - @Schema(description = "") + @Schema(description = "The name of the changed file") public String getFilename() { return filename; } @@ -150,11 +150,11 @@ public class ChangedFile implements Serializable { } /** - * Get htmlUrl + * The HTML URL to view the file changes * * @return htmlUrl */ - @Schema(description = "") + @Schema(description = "The HTML URL to view the file changes") public String getHtmlUrl() { return htmlUrl; } @@ -169,11 +169,11 @@ public class ChangedFile implements Serializable { } /** - * Get previousFilename + * The previous filename if the file was renamed * * @return previousFilename */ - @Schema(description = "") + @Schema(description = "The previous filename if the file was renamed") public String getPreviousFilename() { return previousFilename; } @@ -188,11 +188,11 @@ public class ChangedFile implements Serializable { } /** - * Get rawUrl + * The raw URL to download the file * * @return rawUrl */ - @Schema(description = "") + @Schema(description = "The raw URL to download the file") public String getRawUrl() { return rawUrl; } @@ -207,11 +207,11 @@ public class ChangedFile implements Serializable { } /** - * Get status + * The status of the file change (added, modified, deleted, etc.) * * @return status */ - @Schema(description = "") + @Schema(description = "The status of the file change (added, modified, deleted, etc.)") public String getStatus() { return status; } 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 261d42a..7e98021 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CombinedStatus.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CombinedStatus.java @@ -39,7 +39,15 @@ public class CombinedStatus implements Serializable { @SerializedName("sha") private String sha = null; - /** Gets or Sets state */ + /** + * State is the overall combined status state pending CommitStatusPending CommitStatusPending is + * for when the CommitStatus is Pending success CommitStatusSuccess CommitStatusSuccess is for + * when the CommitStatus is Success error CommitStatusError CommitStatusError is for when the + * CommitStatus is Error failure CommitStatusFailure CommitStatusFailure is for when the + * CommitStatus is Failure warning CommitStatusWarning CommitStatusWarning is for when the + * CommitStatus is Warning skipped CommitStatusSkipped CommitStatusSkipped is for when + * CommitStatus is Skipped + */ @JsonAdapter(StateEnum.Adapter.class) public enum StateEnum { PENDING("pending"), @@ -106,11 +114,11 @@ public class CombinedStatus implements Serializable { } /** - * Get commitUrl + * CommitURL is the API URL for the commit * * @return commitUrl */ - @Schema(description = "") + @Schema(description = "CommitURL is the API URL for the commit") public String getCommitUrl() { return commitUrl; } @@ -144,11 +152,11 @@ public class CombinedStatus implements Serializable { } /** - * Get sha + * SHA is the commit SHA this status applies to * * @return sha */ - @Schema(description = "") + @Schema(description = "SHA is the commit SHA this status applies to") public String getSha() { return sha; } @@ -163,11 +171,26 @@ public class CombinedStatus implements Serializable { } /** - * Get state + * State is the overall combined status state pending CommitStatusPending CommitStatusPending is + * for when the CommitStatus is Pending success CommitStatusSuccess CommitStatusSuccess is for + * when the CommitStatus is Success error CommitStatusError CommitStatusError is for when the + * CommitStatus is Error failure CommitStatusFailure CommitStatusFailure is for when the + * CommitStatus is Failure warning CommitStatusWarning CommitStatusWarning is for when the + * CommitStatus is Warning skipped CommitStatusSkipped CommitStatusSkipped is for when + * CommitStatus is Skipped * * @return state */ - @Schema(description = "") + @Schema( + description = + "State is the overall combined status state pending CommitStatusPending " + + " CommitStatusPending is for when the CommitStatus is Pending success" + + " CommitStatusSuccess CommitStatusSuccess is for when the CommitStatus is Success" + + " error CommitStatusError CommitStatusError is for when the CommitStatus is Error" + + " failure CommitStatusFailure CommitStatusFailure is for when the CommitStatus is" + + " Failure warning CommitStatusWarning CommitStatusWarning is for when the" + + " CommitStatus is Warning skipped CommitStatusSkipped CommitStatusSkipped is for" + + " when CommitStatus is Skipped") public StateEnum getState() { return state; } @@ -190,11 +213,11 @@ public class CombinedStatus implements Serializable { } /** - * Get statuses + * Statuses contains all individual commit statuses * * @return statuses */ - @Schema(description = "") + @Schema(description = "Statuses contains all individual commit statuses") public List getStatuses() { return statuses; } @@ -209,11 +232,11 @@ public class CombinedStatus implements Serializable { } /** - * Get totalCount + * TotalCount is the total number of statuses * * @return totalCount */ - @Schema(description = "") + @Schema(description = "TotalCount is the total number of statuses") public Long getTotalCount() { return totalCount; } @@ -228,11 +251,11 @@ public class CombinedStatus implements Serializable { } /** - * Get url + * URL is the API URL for this combined status * * @return url */ - @Schema(description = "") + @Schema(description = "URL is the API URL for this combined status") public String getUrl() { return url; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/Comment.java b/src/main/java/org/gitnex/tea4j/v2/models/Comment.java index 59c1293..e984962 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/Comment.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/Comment.java @@ -72,11 +72,11 @@ public class Comment implements Serializable { } /** - * Get assets + * Attachments contains files attached to the comment * * @return assets */ - @Schema(description = "") + @Schema(description = "Attachments contains files attached to the comment") public List getAssets() { return assets; } @@ -91,11 +91,11 @@ public class Comment implements Serializable { } /** - * Get body + * Body contains the comment text content * * @return body */ - @Schema(description = "") + @Schema(description = "Body contains the comment text content") public String getBody() { return body; } @@ -129,11 +129,11 @@ public class Comment implements Serializable { } /** - * Get htmlUrl + * HTMLURL is the web URL for viewing the comment * * @return htmlUrl */ - @Schema(description = "") + @Schema(description = "HTMLURL is the web URL for viewing the comment") public String getHtmlUrl() { return htmlUrl; } @@ -148,11 +148,11 @@ public class Comment implements Serializable { } /** - * Get id + * ID is the unique identifier for the comment * * @return id */ - @Schema(description = "") + @Schema(description = "ID is the unique identifier for the comment") public Long getId() { return id; } @@ -167,11 +167,11 @@ public class Comment implements Serializable { } /** - * Get issueUrl + * IssueURL is the API URL for the issue * * @return issueUrl */ - @Schema(description = "") + @Schema(description = "IssueURL is the API URL for the issue") public String getIssueUrl() { return issueUrl; } @@ -186,11 +186,11 @@ public class Comment implements Serializable { } /** - * Get originalAuthor + * OriginalAuthor is the original author name (for imported comments) * * @return originalAuthor */ - @Schema(description = "") + @Schema(description = "OriginalAuthor is the original author name (for imported comments)") public String getOriginalAuthor() { return originalAuthor; } @@ -205,11 +205,11 @@ public class Comment implements Serializable { } /** - * Get originalAuthorId + * OriginalAuthorID is the original author ID (for imported comments) * * @return originalAuthorId */ - @Schema(description = "") + @Schema(description = "OriginalAuthorID is the original author ID (for imported comments)") public Long getOriginalAuthorId() { return originalAuthorId; } @@ -224,11 +224,11 @@ public class Comment implements Serializable { } /** - * Get pullRequestUrl + * PRURL is the API URL for the pull request (if applicable) * * @return pullRequestUrl */ - @Schema(description = "") + @Schema(description = "PRURL is the API URL for the pull request (if applicable)") public String getPullRequestUrl() { return pullRequestUrl; } 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 e095e40..c67468d 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/Commit.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/Commit.java @@ -144,11 +144,11 @@ public class Commit implements Serializable { } /** - * Get files + * Files contains information about files affected by the commit * * @return files */ - @Schema(description = "") + @Schema(description = "Files contains information about files affected by the commit") public List getFiles() { return files; } @@ -163,11 +163,11 @@ public class Commit implements Serializable { } /** - * Get htmlUrl + * HTMLURL is the web URL for viewing the commit * * @return htmlUrl */ - @Schema(description = "") + @Schema(description = "HTMLURL is the web URL for viewing the commit") public String getHtmlUrl() { return htmlUrl; } @@ -190,11 +190,11 @@ public class Commit implements Serializable { } /** - * Get parents + * Parents contains the parent commit information * * @return parents */ - @Schema(description = "") + @Schema(description = "Parents contains the parent commit information") public List getParents() { return parents; } @@ -209,11 +209,11 @@ public class Commit implements Serializable { } /** - * Get sha + * SHA is the commit SHA hash * * @return sha */ - @Schema(description = "") + @Schema(description = "SHA is the commit SHA hash") public String getSha() { return sha; } @@ -247,11 +247,11 @@ public class Commit implements Serializable { } /** - * Get url + * URL is the API URL for the commit * * @return url */ - @Schema(description = "") + @Schema(description = "URL is the API URL for the commit") public String getUrl() { return url; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/CommitAffectedFiles.java b/src/main/java/org/gitnex/tea4j/v2/models/CommitAffectedFiles.java index 475608c..c4d4760 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CommitAffectedFiles.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CommitAffectedFiles.java @@ -34,11 +34,11 @@ public class CommitAffectedFiles implements Serializable { } /** - * Get filename + * Filename is the path of the affected file * * @return filename */ - @Schema(description = "") + @Schema(description = "Filename is the path of the affected file") public String getFilename() { return filename; } @@ -53,11 +53,11 @@ public class CommitAffectedFiles implements Serializable { } /** - * Get status + * Status indicates how the file was affected (added, modified, deleted) * * @return status */ - @Schema(description = "") + @Schema(description = "Status indicates how the file was affected (added, modified, deleted)") public String getStatus() { return status; } 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 13ee284..a57d80c 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CommitMeta.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CommitMeta.java @@ -56,11 +56,11 @@ public class CommitMeta implements Serializable { } /** - * Get sha + * SHA is the commit SHA hash * * @return sha */ - @Schema(description = "") + @Schema(description = "SHA is the commit SHA hash") public String getSha() { return sha; } @@ -75,11 +75,11 @@ public class CommitMeta implements Serializable { } /** - * Get url + * URL is the API URL for the commit * * @return url */ - @Schema(description = "") + @Schema(description = "URL is the API URL for the commit") public String getUrl() { return url; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/CommitStats.java b/src/main/java/org/gitnex/tea4j/v2/models/CommitStats.java index e7ccd43..1be2251 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CommitStats.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CommitStats.java @@ -37,11 +37,11 @@ public class CommitStats implements Serializable { } /** - * Get additions + * Additions is the number of lines added * * @return additions */ - @Schema(description = "") + @Schema(description = "Additions is the number of lines added") public Long getAdditions() { return additions; } @@ -56,11 +56,11 @@ public class CommitStats implements Serializable { } /** - * Get deletions + * Deletions is the number of lines deleted * * @return deletions */ - @Schema(description = "") + @Schema(description = "Deletions is the number of lines deleted") public Long getDeletions() { return deletions; } @@ -75,11 +75,11 @@ public class CommitStats implements Serializable { } /** - * Get total + * Total is the total number of lines changed * * @return total */ - @Schema(description = "") + @Schema(description = "Total is the total number of lines changed") public Long getTotal() { return total; } 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 5037113..6cc0ad0 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CommitStatus.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CommitStatus.java @@ -43,7 +43,15 @@ public class CommitStatus implements Serializable { @SerializedName("id") private Long id = null; - /** Gets or Sets status */ + /** + * State represents the status state (pending, success, error, failure) pending + * CommitStatusPending CommitStatusPending is for when the CommitStatus is Pending success + * CommitStatusSuccess CommitStatusSuccess is for when the CommitStatus is Success error + * CommitStatusError CommitStatusError is for when the CommitStatus is Error failure + * CommitStatusFailure CommitStatusFailure is for when the CommitStatus is Failure warning + * CommitStatusWarning CommitStatusWarning is for when the CommitStatus is Warning skipped + * CommitStatusSkipped CommitStatusSkipped is for when CommitStatus is Skipped + */ @JsonAdapter(StatusEnum.Adapter.class) public enum StatusEnum { PENDING("pending"), @@ -110,11 +118,11 @@ public class CommitStatus implements Serializable { } /** - * Get context + * Context is the unique context identifier for the status * * @return context */ - @Schema(description = "") + @Schema(description = "Context is the unique context identifier for the status") public String getContext() { return context; } @@ -167,11 +175,11 @@ public class CommitStatus implements Serializable { } /** - * Get description + * Description provides a brief description of the status * * @return description */ - @Schema(description = "") + @Schema(description = "Description provides a brief description of the status") public String getDescription() { return description; } @@ -186,11 +194,11 @@ public class CommitStatus implements Serializable { } /** - * Get id + * ID is the unique identifier for the commit status * * @return id */ - @Schema(description = "") + @Schema(description = "ID is the unique identifier for the commit status") public Long getId() { return id; } @@ -205,11 +213,26 @@ public class CommitStatus implements Serializable { } /** - * Get status + * State represents the status state (pending, success, error, failure) pending + * CommitStatusPending CommitStatusPending is for when the CommitStatus is Pending success + * CommitStatusSuccess CommitStatusSuccess is for when the CommitStatus is Success error + * CommitStatusError CommitStatusError is for when the CommitStatus is Error failure + * CommitStatusFailure CommitStatusFailure is for when the CommitStatus is Failure warning + * CommitStatusWarning CommitStatusWarning is for when the CommitStatus is Warning skipped + * CommitStatusSkipped CommitStatusSkipped is for when CommitStatus is Skipped * * @return status */ - @Schema(description = "") + @Schema( + description = + "State represents the status state (pending, success, error, failure) pending" + + " CommitStatusPending CommitStatusPending is for when the CommitStatus is Pending" + + " success CommitStatusSuccess CommitStatusSuccess is for when the CommitStatus is" + + " Success error CommitStatusError CommitStatusError is for when the CommitStatus" + + " is Error failure CommitStatusFailure CommitStatusFailure is for when the" + + " CommitStatus is Failure warning CommitStatusWarning CommitStatusWarning is for" + + " when the CommitStatus is Warning skipped CommitStatusSkipped CommitStatusSkipped" + + " is for when CommitStatus is Skipped") public StatusEnum getStatus() { return status; } @@ -224,11 +247,11 @@ public class CommitStatus implements Serializable { } /** - * Get targetUrl + * TargetURL is the URL to link to for more details * * @return targetUrl */ - @Schema(description = "") + @Schema(description = "TargetURL is the URL to link to for more details") public String getTargetUrl() { return targetUrl; } @@ -262,11 +285,11 @@ public class CommitStatus implements Serializable { } /** - * Get url + * URL is the API URL for this status * * @return url */ - @Schema(description = "") + @Schema(description = "URL is the API URL for this status") public String getUrl() { return url; } 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 d94bb8b..d38789e 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CommitUser.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CommitUser.java @@ -36,11 +36,11 @@ public class CommitUser implements Serializable { } /** - * Get date + * Date is the commit date in string format * * @return date */ - @Schema(description = "") + @Schema(description = "Date is the commit date in string format") public String getDate() { return date; } @@ -74,11 +74,11 @@ public class CommitUser implements Serializable { } /** - * Get name + * Name is the person's name * * @return name */ - @Schema(description = "") + @Schema(description = "Name is the person's name") public String getName() { return name; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/ContentsExtResponse.java b/src/main/java/org/gitnex/tea4j/v2/models/ContentsExtResponse.java index 338f383..2796f87 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/ContentsExtResponse.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/ContentsExtResponse.java @@ -43,11 +43,12 @@ public class ContentsExtResponse implements Serializable { } /** - * Get dirContents + * DirContents contains directory listing when the path represents a directory * * @return dirContents */ - @Schema(description = "") + @Schema( + description = "DirContents contains directory listing when the path represents a directory") public List getDirContents() { return dirContents; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/ContentsResponse.java b/src/main/java/org/gitnex/tea4j/v2/models/ContentsResponse.java index 6e6fc98..0e9bace 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/ContentsResponse.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/ContentsResponse.java @@ -133,11 +133,11 @@ public class ContentsResponse implements Serializable { } /** - * Get downloadUrl + * DownloadURL is the direct download URL for this file * * @return downloadUrl */ - @Schema(description = "") + @Schema(description = "DownloadURL is the direct download URL for this file") public String getDownloadUrl() { return downloadUrl; } @@ -171,11 +171,11 @@ public class ContentsResponse implements Serializable { } /** - * Get gitUrl + * GitURL is the Git API URL for this blob or tree * * @return gitUrl */ - @Schema(description = "") + @Schema(description = "GitURL is the Git API URL for this blob or tree") public String getGitUrl() { return gitUrl; } @@ -190,11 +190,11 @@ public class ContentsResponse implements Serializable { } /** - * Get htmlUrl + * HTMLURL is the web URL for this file or directory * * @return htmlUrl */ - @Schema(description = "") + @Schema(description = "HTMLURL is the web URL for this file or directory") public String getHtmlUrl() { return htmlUrl; } @@ -228,11 +228,12 @@ public class ContentsResponse implements Serializable { } /** - * Get lastCommitMessage + * LastCommitMessage is the message of the last commit that affected this file * * @return lastCommitMessage */ - @Schema(description = "") + @Schema( + description = "LastCommitMessage is the message of the last commit that affected this file") public String getLastCommitMessage() { return lastCommitMessage; } @@ -247,11 +248,11 @@ public class ContentsResponse implements Serializable { } /** - * Get lastCommitSha + * LastCommitSHA is the SHA of the last commit that affected this file * * @return lastCommitSha */ - @Schema(description = "") + @Schema(description = "LastCommitSHA is the SHA of the last commit that affected this file") public String getLastCommitSha() { return lastCommitSha; } @@ -285,11 +286,11 @@ public class ContentsResponse implements Serializable { } /** - * Get lfsOid + * LfsOid is the Git LFS object ID if this file is stored in LFS * * @return lfsOid */ - @Schema(description = "") + @Schema(description = "LfsOid is the Git LFS object ID if this file is stored in LFS") public String getLfsOid() { return lfsOid; } @@ -304,11 +305,11 @@ public class ContentsResponse implements Serializable { } /** - * Get lfsSize + * LfsSize is the file size if this file is stored in LFS * * @return lfsSize */ - @Schema(description = "") + @Schema(description = "LfsSize is the file size if this file is stored in LFS") public Long getLfsSize() { return lfsSize; } @@ -323,11 +324,11 @@ public class ContentsResponse implements Serializable { } /** - * Get name + * Name is the file or directory name * * @return name */ - @Schema(description = "") + @Schema(description = "Name is the file or directory name") public String getName() { return name; } @@ -342,11 +343,11 @@ public class ContentsResponse implements Serializable { } /** - * Get path + * Path is the full path to the file or directory * * @return path */ - @Schema(description = "") + @Schema(description = "Path is the full path to the file or directory") public String getPath() { return path; } @@ -361,11 +362,11 @@ public class ContentsResponse implements Serializable { } /** - * Get sha + * SHA is the Git blob or tree SHA * * @return sha */ - @Schema(description = "") + @Schema(description = "SHA is the Git blob or tree SHA") public String getSha() { return sha; } @@ -380,11 +381,11 @@ public class ContentsResponse implements Serializable { } /** - * Get size + * Size is the file size in bytes * * @return size */ - @Schema(description = "") + @Schema(description = "Size is the file size in bytes") public Long getSize() { return size; } @@ -459,11 +460,11 @@ public class ContentsResponse implements Serializable { } /** - * Get url + * URL is the API URL for this file or directory * * @return url */ - @Schema(description = "") + @Schema(description = "URL is the API URL for this file or directory") public String getUrl() { return url; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/CreateGPGKeyOption.java b/src/main/java/org/gitnex/tea4j/v2/models/CreateGPGKeyOption.java index 6fca0df..415b96e 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CreateGPGKeyOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CreateGPGKeyOption.java @@ -53,11 +53,11 @@ public class CreateGPGKeyOption implements Serializable { } /** - * Get armoredSignature + * An optional armored signature for the GPG key * * @return armoredSignature */ - @Schema(description = "") + @Schema(description = "An optional armored signature for the GPG key") public String getArmoredSignature() { return armoredSignature; } 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 ad6482f..4f3be2a 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CreateHookOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CreateHookOption.java @@ -125,11 +125,11 @@ public class CreateHookOption implements Serializable { } /** - * Get authorizationHeader + * Authorization header to include in webhook requests * * @return authorizationHeader */ - @Schema(description = "") + @Schema(description = "Authorization header to include in webhook requests") public String getAuthorizationHeader() { return authorizationHeader; } @@ -144,11 +144,11 @@ public class CreateHookOption implements Serializable { } /** - * Get branchFilter + * Branch filter pattern to determine which branches trigger the webhook * * @return branchFilter */ - @Schema(description = "") + @Schema(description = "Branch filter pattern to determine which branches trigger the webhook") public String getBranchFilter() { return branchFilter; } @@ -190,11 +190,11 @@ public class CreateHookOption implements Serializable { } /** - * Get events + * List of events that will trigger this webhook * * @return events */ - @Schema(description = "") + @Schema(description = "List of events that will trigger this webhook") public List getEvents() { return events; } 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 a70bf46..9ae7d14 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CreateLabelOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CreateLabelOption.java @@ -62,11 +62,11 @@ public class CreateLabelOption implements Serializable { } /** - * Get description + * Description provides additional context about the label's purpose * * @return description */ - @Schema(description = "") + @Schema(description = "Description provides additional context about the label's purpose") public String getDescription() { return description; } 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 ee9f791..e89ba0b 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CreateMilestoneOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CreateMilestoneOption.java @@ -91,11 +91,11 @@ public class CreateMilestoneOption implements Serializable { } /** - * Get description + * Description provides details about the milestone * * @return description */ - @Schema(description = "") + @Schema(description = "Description provides details about the milestone") public String getDescription() { return description; } @@ -148,11 +148,11 @@ public class CreateMilestoneOption implements Serializable { } /** - * Get title + * Title is the title of the new milestone * * @return title */ - @Schema(description = "") + @Schema(description = "Title is the title of the new milestone") public String getTitle() { return title; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/CreateOAuth2ApplicationOptions.java b/src/main/java/org/gitnex/tea4j/v2/models/CreateOAuth2ApplicationOptions.java index 1974481..e292086 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CreateOAuth2ApplicationOptions.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CreateOAuth2ApplicationOptions.java @@ -43,11 +43,11 @@ public class CreateOAuth2ApplicationOptions implements Serializable { } /** - * Get confidentialClient + * Whether the client is confidential * * @return confidentialClient */ - @Schema(description = "") + @Schema(description = "Whether the client is confidential") public Boolean isConfidentialClient() { return confidentialClient; } @@ -62,11 +62,11 @@ public class CreateOAuth2ApplicationOptions implements Serializable { } /** - * Get name + * The name of the OAuth2 application * * @return name */ - @Schema(description = "") + @Schema(description = "The name of the OAuth2 application") public String getName() { return name; } @@ -89,11 +89,11 @@ public class CreateOAuth2ApplicationOptions implements Serializable { } /** - * Get redirectUris + * The list of allowed redirect URIs * * @return redirectUris */ - @Schema(description = "") + @Schema(description = "The list of allowed redirect URIs") public List getRedirectUris() { return redirectUris; } @@ -109,11 +109,11 @@ public class CreateOAuth2ApplicationOptions implements Serializable { } /** - * Get skipSecondaryAuthorization + * Whether to skip secondary authorization * * @return skipSecondaryAuthorization */ - @Schema(description = "") + @Schema(description = "Whether to skip secondary authorization") public Boolean isSkipSecondaryAuthorization() { return skipSecondaryAuthorization; } 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 0f5672a..03e2d04 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CreateOrgOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CreateOrgOption.java @@ -105,11 +105,11 @@ public class CreateOrgOption implements Serializable { } /** - * Get description + * The description of the organization * * @return description */ - @Schema(description = "") + @Schema(description = "The description of the organization") public String getDescription() { return description; } @@ -124,11 +124,11 @@ public class CreateOrgOption implements Serializable { } /** - * Get email + * The email address of the organization * * @return email */ - @Schema(description = "") + @Schema(description = "The email address of the organization") public String getEmail() { return email; } @@ -143,11 +143,11 @@ public class CreateOrgOption implements Serializable { } /** - * Get fullName + * The full display name of the organization * * @return fullName */ - @Schema(description = "") + @Schema(description = "The full display name of the organization") public String getFullName() { return fullName; } @@ -162,11 +162,11 @@ public class CreateOrgOption implements Serializable { } /** - * Get location + * The location of the organization * * @return location */ - @Schema(description = "") + @Schema(description = "The location of the organization") public String getLocation() { return location; } @@ -181,11 +181,11 @@ public class CreateOrgOption implements Serializable { } /** - * Get repoAdminChangeTeamAccess + * Whether repository administrators can change team access * * @return repoAdminChangeTeamAccess */ - @Schema(description = "") + @Schema(description = "Whether repository administrators can change team access") public Boolean isRepoAdminChangeTeamAccess() { return repoAdminChangeTeamAccess; } @@ -238,11 +238,11 @@ public class CreateOrgOption implements Serializable { } /** - * Get website + * The website URL of the organization * * @return website */ - @Schema(description = "") + @Schema(description = "The website URL of the organization") public String getWebsite() { return website; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/CreatePullRequestOption.java b/src/main/java/org/gitnex/tea4j/v2/models/CreatePullRequestOption.java index 0e9abe1..30455b5 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CreatePullRequestOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CreatePullRequestOption.java @@ -64,11 +64,11 @@ public class CreatePullRequestOption implements Serializable { } /** - * Get assignee + * The primary assignee username * * @return assignee */ - @Schema(description = "") + @Schema(description = "The primary assignee username") public String getAssignee() { return assignee; } @@ -91,11 +91,11 @@ public class CreatePullRequestOption implements Serializable { } /** - * Get assignees + * The list of assignee usernames * * @return assignees */ - @Schema(description = "") + @Schema(description = "The list of assignee usernames") public List getAssignees() { return assignees; } @@ -110,11 +110,11 @@ public class CreatePullRequestOption implements Serializable { } /** - * Get base + * The base branch for the pull request * * @return base */ - @Schema(description = "") + @Schema(description = "The base branch for the pull request") public String getBase() { return base; } @@ -129,11 +129,11 @@ public class CreatePullRequestOption implements Serializable { } /** - * Get body + * The description body of the pull request * * @return body */ - @Schema(description = "") + @Schema(description = "The description body of the pull request") public String getBody() { return body; } @@ -167,11 +167,17 @@ public class CreatePullRequestOption implements Serializable { } /** - * Get head + * The head branch for the pull request, it could be a branch name on the base repository or a + * form like `<username>:<branch>` which refers to the user's fork + * repository's branch. * * @return head */ - @Schema(description = "") + @Schema( + description = + "The head branch for the pull request, it could be a branch name on the base repository" + + " or a form like `:` which refers to the user's fork repository's" + + " branch.") public String getHead() { return head; } @@ -194,11 +200,11 @@ public class CreatePullRequestOption implements Serializable { } /** - * Get labels + * The list of label IDs to assign to the pull request * * @return labels */ - @Schema(description = "") + @Schema(description = "The list of label IDs to assign to the pull request") public List getLabels() { return labels; } @@ -213,11 +219,11 @@ public class CreatePullRequestOption implements Serializable { } /** - * Get milestone + * The milestone ID to assign to the pull request * * @return milestone */ - @Schema(description = "") + @Schema(description = "The milestone ID to assign to the pull request") public Long getMilestone() { return milestone; } @@ -240,11 +246,11 @@ public class CreatePullRequestOption implements Serializable { } /** - * Get reviewers + * The list of reviewer usernames * * @return reviewers */ - @Schema(description = "") + @Schema(description = "The list of reviewer usernames") public List getReviewers() { return reviewers; } @@ -267,11 +273,11 @@ public class CreatePullRequestOption implements Serializable { } /** - * Get teamReviewers + * The list of team reviewer names * * @return teamReviewers */ - @Schema(description = "") + @Schema(description = "The list of team reviewer names") public List getTeamReviewers() { return teamReviewers; } @@ -286,11 +292,11 @@ public class CreatePullRequestOption implements Serializable { } /** - * Get title + * The title of the pull request * * @return title */ - @Schema(description = "") + @Schema(description = "The title of the pull request") public String getTitle() { return title; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/CreatePushMirrorOption.java b/src/main/java/org/gitnex/tea4j/v2/models/CreatePushMirrorOption.java index 8f8107b..865ac88 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CreatePushMirrorOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CreatePushMirrorOption.java @@ -42,11 +42,11 @@ public class CreatePushMirrorOption implements Serializable { } /** - * Get interval + * The sync interval for automatic updates * * @return interval */ - @Schema(description = "") + @Schema(description = "The sync interval for automatic updates") public String getInterval() { return interval; } @@ -61,11 +61,11 @@ public class CreatePushMirrorOption implements Serializable { } /** - * Get remoteAddress + * The remote repository URL to push to * * @return remoteAddress */ - @Schema(description = "") + @Schema(description = "The remote repository URL to push to") public String getRemoteAddress() { return remoteAddress; } @@ -80,11 +80,11 @@ public class CreatePushMirrorOption implements Serializable { } /** - * Get remotePassword + * The password for authentication with the remote repository * * @return remotePassword */ - @Schema(description = "") + @Schema(description = "The password for authentication with the remote repository") public String getRemotePassword() { return remotePassword; } @@ -99,11 +99,11 @@ public class CreatePushMirrorOption implements Serializable { } /** - * Get remoteUsername + * The username for authentication with the remote repository * * @return remoteUsername */ - @Schema(description = "") + @Schema(description = "The username for authentication with the remote repository") public String getRemoteUsername() { return remoteUsername; } @@ -118,11 +118,11 @@ public class CreatePushMirrorOption implements Serializable { } /** - * Get syncOnCommit + * Whether to sync on every commit * * @return syncOnCommit */ - @Schema(description = "") + @Schema(description = "Whether to sync on every commit") public Boolean isSyncOnCommit() { return syncOnCommit; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/CreateReleaseOption.java b/src/main/java/org/gitnex/tea4j/v2/models/CreateReleaseOption.java index dbcca8d..00d6c72 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CreateReleaseOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CreateReleaseOption.java @@ -49,11 +49,11 @@ public class CreateReleaseOption implements Serializable { } /** - * Get body + * The release notes or description * * @return body */ - @Schema(description = "") + @Schema(description = "The release notes or description") public String getBody() { return body; } @@ -68,11 +68,11 @@ public class CreateReleaseOption implements Serializable { } /** - * Get draft + * Whether to create the release as a draft * * @return draft */ - @Schema(description = "") + @Schema(description = "Whether to create the release as a draft") public Boolean isDraft() { return draft; } @@ -87,11 +87,11 @@ public class CreateReleaseOption implements Serializable { } /** - * Get name + * The display title of the release * * @return name */ - @Schema(description = "") + @Schema(description = "The display title of the release") public String getName() { return name; } @@ -106,11 +106,11 @@ public class CreateReleaseOption implements Serializable { } /** - * Get prerelease + * Whether to mark the release as a prerelease * * @return prerelease */ - @Schema(description = "") + @Schema(description = "Whether to mark the release as a prerelease") public Boolean isPrerelease() { return prerelease; } @@ -125,11 +125,11 @@ public class CreateReleaseOption implements Serializable { } /** - * Get tagMessage + * The message for the git tag * * @return tagMessage */ - @Schema(description = "") + @Schema(description = "The message for the git tag") public String getTagMessage() { return tagMessage; } @@ -163,11 +163,11 @@ public class CreateReleaseOption implements Serializable { } /** - * Get targetCommitish + * The target commitish for the release * * @return targetCommitish */ - @Schema(description = "") + @Schema(description = "The target commitish for the release") public String getTargetCommitish() { return targetCommitish; } 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 a27ca50..c15d0de 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CreateStatusOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CreateStatusOption.java @@ -35,7 +35,15 @@ public class CreateStatusOption implements Serializable { @SerializedName("description") private String description = null; - /** Gets or Sets state */ + /** + * State represents the status state to set (pending, success, error, failure) pending + * CommitStatusPending CommitStatusPending is for when the CommitStatus is Pending success + * CommitStatusSuccess CommitStatusSuccess is for when the CommitStatus is Success error + * CommitStatusError CommitStatusError is for when the CommitStatus is Error failure + * CommitStatusFailure CommitStatusFailure is for when the CommitStatus is Failure warning + * CommitStatusWarning CommitStatusWarning is for when the CommitStatus is Warning skipped + * CommitStatusSkipped CommitStatusSkipped is for when CommitStatus is Skipped + */ @JsonAdapter(StateEnum.Adapter.class) public enum StateEnum { PENDING("pending"), @@ -96,11 +104,11 @@ public class CreateStatusOption implements Serializable { } /** - * Get context + * Context is the unique context identifier for the status * * @return context */ - @Schema(description = "") + @Schema(description = "Context is the unique context identifier for the status") public String getContext() { return context; } @@ -115,11 +123,11 @@ public class CreateStatusOption implements Serializable { } /** - * Get description + * Description provides a brief description of the status * * @return description */ - @Schema(description = "") + @Schema(description = "Description provides a brief description of the status") public String getDescription() { return description; } @@ -134,11 +142,26 @@ public class CreateStatusOption implements Serializable { } /** - * Get state + * State represents the status state to set (pending, success, error, failure) pending + * CommitStatusPending CommitStatusPending is for when the CommitStatus is Pending success + * CommitStatusSuccess CommitStatusSuccess is for when the CommitStatus is Success error + * CommitStatusError CommitStatusError is for when the CommitStatus is Error failure + * CommitStatusFailure CommitStatusFailure is for when the CommitStatus is Failure warning + * CommitStatusWarning CommitStatusWarning is for when the CommitStatus is Warning skipped + * CommitStatusSkipped CommitStatusSkipped is for when CommitStatus is Skipped * * @return state */ - @Schema(description = "") + @Schema( + description = + "State represents the status state to set (pending, success, error, failure) pending" + + " CommitStatusPending CommitStatusPending is for when the CommitStatus is Pending" + + " success CommitStatusSuccess CommitStatusSuccess is for when the CommitStatus is" + + " Success error CommitStatusError CommitStatusError is for when the CommitStatus" + + " is Error failure CommitStatusFailure CommitStatusFailure is for when the" + + " CommitStatus is Failure warning CommitStatusWarning CommitStatusWarning is for" + + " when the CommitStatus is Warning skipped CommitStatusSkipped CommitStatusSkipped" + + " is for when CommitStatus is Skipped") public StateEnum getState() { return state; } @@ -153,11 +176,11 @@ public class CreateStatusOption implements Serializable { } /** - * Get targetUrl + * TargetURL is the URL to link to for more details * * @return targetUrl */ - @Schema(description = "") + @Schema(description = "TargetURL is the URL to link to for more details") public String getTargetUrl() { return targetUrl; } 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 5d55fcf..3ce9643 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CreateTagOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CreateTagOption.java @@ -37,11 +37,11 @@ public class CreateTagOption implements Serializable { } /** - * Get message + * The message to associate with the tag * * @return message */ - @Schema(description = "") + @Schema(description = "The message to associate with the tag") public String getMessage() { return message; } @@ -75,11 +75,11 @@ public class CreateTagOption implements Serializable { } /** - * Get target + * The target commit SHA or branch name for the tag * * @return target */ - @Schema(description = "") + @Schema(description = "The target commit SHA or branch name for the tag") public String getTarget() { return target; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/CreateTagProtectionOption.java b/src/main/java/org/gitnex/tea4j/v2/models/CreateTagProtectionOption.java index 79447cf..8e07cb4 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CreateTagProtectionOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CreateTagProtectionOption.java @@ -39,11 +39,11 @@ public class CreateTagProtectionOption implements Serializable { } /** - * Get namePattern + * The pattern to match tag names for protection * * @return namePattern */ - @Schema(description = "") + @Schema(description = "The pattern to match tag names for protection") public String getNamePattern() { return namePattern; } @@ -66,11 +66,11 @@ public class CreateTagProtectionOption implements Serializable { } /** - * Get whitelistTeams + * List of team names allowed to create/delete protected tags * * @return whitelistTeams */ - @Schema(description = "") + @Schema(description = "List of team names allowed to create/delete protected tags") public List getWhitelistTeams() { return whitelistTeams; } @@ -93,11 +93,11 @@ public class CreateTagProtectionOption implements Serializable { } /** - * Get whitelistUsernames + * List of usernames allowed to create/delete protected tags * * @return whitelistUsernames */ - @Schema(description = "") + @Schema(description = "List of usernames allowed to create/delete protected tags") public List getWhitelistUsernames() { return whitelistUsernames; } 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 543f0ab..2ab29d1 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CreateTeamOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CreateTeamOption.java @@ -104,11 +104,11 @@ public class CreateTeamOption implements Serializable { } /** - * Get canCreateOrgRepo + * Whether the team can create repositories in the organization * * @return canCreateOrgRepo */ - @Schema(description = "") + @Schema(description = "Whether the team can create repositories in the organization") public Boolean isCanCreateOrgRepo() { return canCreateOrgRepo; } @@ -123,11 +123,11 @@ public class CreateTeamOption implements Serializable { } /** - * Get description + * The description of the team * * @return description */ - @Schema(description = "") + @Schema(description = "The description of the team") public String getDescription() { return description; } @@ -142,11 +142,11 @@ public class CreateTeamOption implements Serializable { } /** - * Get includesAllRepositories + * Whether the team has access to all repositories in the organization * * @return includesAllRepositories */ - @Schema(description = "") + @Schema(description = "Whether the team has access to all repositories in the organization") public Boolean isIncludesAllRepositories() { return includesAllRepositories; } 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 6c7abb1..57f2976 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/CreateUserOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/CreateUserOption.java @@ -105,11 +105,11 @@ public class CreateUserOption implements Serializable { } /** - * Get fullName + * The full display name of the user * * @return fullName */ - @Schema(description = "") + @Schema(description = "The full display name of the user") public String getFullName() { return fullName; } @@ -145,11 +145,11 @@ public class CreateUserOption implements Serializable { } /** - * Get mustChangePassword + * Whether the user must change password on first login * * @return mustChangePassword */ - @Schema(description = "") + @Schema(description = "Whether the user must change password on first login") public Boolean isMustChangePassword() { return mustChangePassword; } @@ -164,11 +164,11 @@ public class CreateUserOption implements Serializable { } /** - * Get password + * The plain text password for the user * * @return password */ - @Schema(description = "") + @Schema(description = "The plain text password for the user") public String getPassword() { return password; } @@ -183,11 +183,11 @@ public class CreateUserOption implements Serializable { } /** - * Get restricted + * Whether the user has restricted access privileges * * @return restricted */ - @Schema(description = "") + @Schema(description = "Whether the user has restricted access privileges") public Boolean isRestricted() { return restricted; } @@ -202,11 +202,11 @@ public class CreateUserOption implements Serializable { } /** - * Get sendNotify + * Whether to send welcome notification email to the user * * @return sendNotify */ - @Schema(description = "") + @Schema(description = "Whether to send welcome notification email to the user") public Boolean isSendNotify() { return sendNotify; } @@ -221,11 +221,11 @@ public class CreateUserOption implements Serializable { } /** - * Get sourceId + * The authentication source ID to associate with the user * * @return sourceId */ - @Schema(description = "") + @Schema(description = "The authentication source ID to associate with the user") public Long getSourceId() { return sourceId; } @@ -259,11 +259,11 @@ public class CreateUserOption implements Serializable { } /** - * Get visibility + * User visibility level: public, limited, or private * * @return visibility */ - @Schema(description = "") + @Schema(description = "User visibility level: public, limited, or private") public String getVisibility() { return visibility; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/Cron.java b/src/main/java/org/gitnex/tea4j/v2/models/Cron.java index 3cc7583..bdd161f 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/Cron.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/Cron.java @@ -44,11 +44,11 @@ public class Cron implements Serializable { } /** - * Get execTimes + * The total number of times this cron task has been executed * * @return execTimes */ - @Schema(description = "") + @Schema(description = "The total number of times this cron task has been executed") public Long getExecTimes() { return execTimes; } @@ -63,11 +63,11 @@ public class Cron implements Serializable { } /** - * Get name + * The name of the cron task * * @return name */ - @Schema(description = "") + @Schema(description = "The name of the cron task") public String getName() { return name; } @@ -82,11 +82,11 @@ public class Cron implements Serializable { } /** - * Get next + * The next scheduled execution time * * @return next */ - @Schema(description = "") + @Schema(description = "The next scheduled execution time") public Date getNext() { return next; } @@ -101,11 +101,11 @@ public class Cron implements Serializable { } /** - * Get prev + * The previous execution time * * @return prev */ - @Schema(description = "") + @Schema(description = "The previous execution time") public Date getPrev() { return prev; } @@ -120,11 +120,11 @@ public class Cron implements Serializable { } /** - * Get schedule + * The cron schedule expression (e.g., \"0 0 * * *\") * * @return schedule */ - @Schema(description = "") + @Schema(description = "The cron schedule expression (e.g., \"0 0 * * *\")") public String getSchedule() { return schedule; } 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 cc65555..ff4fec2 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/DeployKey.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/DeployKey.java @@ -75,11 +75,11 @@ public class DeployKey implements Serializable { } /** - * Get fingerprint + * Fingerprint is the key's fingerprint * * @return fingerprint */ - @Schema(description = "") + @Schema(description = "Fingerprint is the key's fingerprint") public String getFingerprint() { return fingerprint; } @@ -94,11 +94,11 @@ public class DeployKey implements Serializable { } /** - * Get id + * ID is the unique identifier for the deploy key * * @return id */ - @Schema(description = "") + @Schema(description = "ID is the unique identifier for the deploy key") public Long getId() { return id; } @@ -113,11 +113,11 @@ public class DeployKey implements Serializable { } /** - * Get key + * Key contains the actual SSH key content * * @return key */ - @Schema(description = "") + @Schema(description = "Key contains the actual SSH key content") public String getKey() { return key; } @@ -132,11 +132,11 @@ public class DeployKey implements Serializable { } /** - * Get keyId + * KeyID is the associated public key ID * * @return keyId */ - @Schema(description = "") + @Schema(description = "KeyID is the associated public key ID") public Long getKeyId() { return keyId; } @@ -151,11 +151,11 @@ public class DeployKey implements Serializable { } /** - * Get readOnly + * ReadOnly indicates if the key has read-only access * * @return readOnly */ - @Schema(description = "") + @Schema(description = "ReadOnly indicates if the key has read-only access") public Boolean isReadOnly() { return readOnly; } @@ -189,11 +189,11 @@ public class DeployKey implements Serializable { } /** - * Get title + * Title is the human-readable name for the key * * @return title */ - @Schema(description = "") + @Schema(description = "Title is the human-readable name for the key") public String getTitle() { return title; } @@ -208,11 +208,11 @@ public class DeployKey implements Serializable { } /** - * Get url + * URL is the API URL for this deploy key * * @return url */ - @Schema(description = "") + @Schema(description = "URL is the API URL for this deploy key") public String getUrl() { return url; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/EditAttachmentOptions.java b/src/main/java/org/gitnex/tea4j/v2/models/EditAttachmentOptions.java index e412e24..13496ef 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/EditAttachmentOptions.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/EditAttachmentOptions.java @@ -31,11 +31,11 @@ public class EditAttachmentOptions implements Serializable { } /** - * Get name + * Name is the new filename for the attachment * * @return name */ - @Schema(description = "") + @Schema(description = "Name is the new filename for the attachment") public String getName() { return name; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/EditGitHookOption.java b/src/main/java/org/gitnex/tea4j/v2/models/EditGitHookOption.java index 977faf1..ef210cc 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/EditGitHookOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/EditGitHookOption.java @@ -31,11 +31,11 @@ public class EditGitHookOption implements Serializable { } /** - * Get content + * Content is the new script content for the hook * * @return content */ - @Schema(description = "") + @Schema(description = "Content is the new script content for the hook") public String getContent() { return content; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/EditHookOption.java b/src/main/java/org/gitnex/tea4j/v2/models/EditHookOption.java index 3d2a618..64b63d5 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/EditHookOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/EditHookOption.java @@ -47,11 +47,11 @@ public class EditHookOption implements Serializable { } /** - * Get active + * Whether the webhook is active and will be triggered * * @return active */ - @Schema(description = "") + @Schema(description = "Whether the webhook is active and will be triggered") public Boolean isActive() { return active; } @@ -66,11 +66,11 @@ public class EditHookOption implements Serializable { } /** - * Get authorizationHeader + * Authorization header to include in webhook requests * * @return authorizationHeader */ - @Schema(description = "") + @Schema(description = "Authorization header to include in webhook requests") public String getAuthorizationHeader() { return authorizationHeader; } @@ -85,11 +85,11 @@ public class EditHookOption implements Serializable { } /** - * Get branchFilter + * Branch filter pattern to determine which branches trigger the webhook * * @return branchFilter */ - @Schema(description = "") + @Schema(description = "Branch filter pattern to determine which branches trigger the webhook") public String getBranchFilter() { return branchFilter; } @@ -112,11 +112,11 @@ public class EditHookOption implements Serializable { } /** - * Get config + * Configuration settings for the webhook * * @return config */ - @Schema(description = "") + @Schema(description = "Configuration settings for the webhook") public Map getConfig() { return config; } @@ -139,11 +139,11 @@ public class EditHookOption implements Serializable { } /** - * Get events + * List of events that trigger this webhook * * @return events */ - @Schema(description = "") + @Schema(description = "List of events that trigger this webhook") public List getEvents() { return events; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/EditLabelOption.java b/src/main/java/org/gitnex/tea4j/v2/models/EditLabelOption.java index 0458781..4d6b82c 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/EditLabelOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/EditLabelOption.java @@ -62,11 +62,11 @@ public class EditLabelOption implements Serializable { } /** - * Get description + * Description provides additional context about the label's purpose * * @return description */ - @Schema(description = "") + @Schema(description = "Description provides additional context about the label's purpose") public String getDescription() { return description; } @@ -119,11 +119,11 @@ public class EditLabelOption implements Serializable { } /** - * Get name + * Name is the new display name for the label * * @return name */ - @Schema(description = "") + @Schema(description = "Name is the new display name for the label") public String getName() { return name; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/EditMilestoneOption.java b/src/main/java/org/gitnex/tea4j/v2/models/EditMilestoneOption.java index 0b8f6fd..e55e222 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/EditMilestoneOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/EditMilestoneOption.java @@ -41,11 +41,11 @@ public class EditMilestoneOption implements Serializable { } /** - * Get description + * Description provides updated details about the milestone * * @return description */ - @Schema(description = "") + @Schema(description = "Description provides updated details about the milestone") public String getDescription() { return description; } @@ -60,11 +60,11 @@ public class EditMilestoneOption implements Serializable { } /** - * Get dueOn + * Deadline is the updated due date for the milestone * * @return dueOn */ - @Schema(description = "") + @Schema(description = "Deadline is the updated due date for the milestone") public Date getDueOn() { return dueOn; } @@ -79,11 +79,11 @@ public class EditMilestoneOption implements Serializable { } /** - * Get state + * State indicates the updated state of the milestone * * @return state */ - @Schema(description = "") + @Schema(description = "State indicates the updated state of the milestone") public String getState() { return state; } @@ -98,11 +98,11 @@ public class EditMilestoneOption implements Serializable { } /** - * Get title + * Title is the updated title of the milestone * * @return title */ - @Schema(description = "") + @Schema(description = "Title is the updated title of the milestone") public String getTitle() { return title; } 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 61e3930..86f588f 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/EditOrgOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/EditOrgOption.java @@ -100,11 +100,11 @@ public class EditOrgOption implements Serializable { } /** - * Get description + * The description of the organization * * @return description */ - @Schema(description = "") + @Schema(description = "The description of the organization") public String getDescription() { return description; } @@ -119,11 +119,11 @@ public class EditOrgOption implements Serializable { } /** - * Get email + * The email address of the organization * * @return email */ - @Schema(description = "") + @Schema(description = "The email address of the organization") public String getEmail() { return email; } @@ -138,11 +138,11 @@ public class EditOrgOption implements Serializable { } /** - * Get fullName + * The full display name of the organization * * @return fullName */ - @Schema(description = "") + @Schema(description = "The full display name of the organization") public String getFullName() { return fullName; } @@ -157,11 +157,11 @@ public class EditOrgOption implements Serializable { } /** - * Get location + * The location of the organization * * @return location */ - @Schema(description = "") + @Schema(description = "The location of the organization") public String getLocation() { return location; } @@ -176,11 +176,11 @@ public class EditOrgOption implements Serializable { } /** - * Get repoAdminChangeTeamAccess + * Whether repository administrators can change team access * * @return repoAdminChangeTeamAccess */ - @Schema(description = "") + @Schema(description = "Whether repository administrators can change team access") public Boolean isRepoAdminChangeTeamAccess() { return repoAdminChangeTeamAccess; } @@ -214,11 +214,11 @@ public class EditOrgOption implements Serializable { } /** - * Get website + * The website URL of the organization * * @return website */ - @Schema(description = "") + @Schema(description = "The website URL of the organization") public String getWebsite() { return website; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/EditPullRequestOption.java b/src/main/java/org/gitnex/tea4j/v2/models/EditPullRequestOption.java index 04ae876..650a766 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/EditPullRequestOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/EditPullRequestOption.java @@ -64,11 +64,11 @@ public class EditPullRequestOption implements Serializable { } /** - * Get allowMaintainerEdit + * Whether to allow maintainer edits * * @return allowMaintainerEdit */ - @Schema(description = "") + @Schema(description = "Whether to allow maintainer edits") public Boolean isAllowMaintainerEdit() { return allowMaintainerEdit; } @@ -83,11 +83,11 @@ public class EditPullRequestOption implements Serializable { } /** - * Get assignee + * The new primary assignee username * * @return assignee */ - @Schema(description = "") + @Schema(description = "The new primary assignee username") public String getAssignee() { return assignee; } @@ -110,11 +110,11 @@ public class EditPullRequestOption implements Serializable { } /** - * Get assignees + * The new list of assignee usernames * * @return assignees */ - @Schema(description = "") + @Schema(description = "The new list of assignee usernames") public List getAssignees() { return assignees; } @@ -129,11 +129,11 @@ public class EditPullRequestOption implements Serializable { } /** - * Get base + * The new base branch for the pull request * * @return base */ - @Schema(description = "") + @Schema(description = "The new base branch for the pull request") public String getBase() { return base; } @@ -148,11 +148,11 @@ public class EditPullRequestOption implements Serializable { } /** - * Get body + * The new description body for the pull request * * @return body */ - @Schema(description = "") + @Schema(description = "The new description body for the pull request") public String getBody() { return body; } @@ -194,11 +194,11 @@ public class EditPullRequestOption implements Serializable { } /** - * Get labels + * The new list of label IDs for the pull request * * @return labels */ - @Schema(description = "") + @Schema(description = "The new list of label IDs for the pull request") public List getLabels() { return labels; } @@ -213,11 +213,11 @@ public class EditPullRequestOption implements Serializable { } /** - * Get milestone + * The new milestone ID for the pull request * * @return milestone */ - @Schema(description = "") + @Schema(description = "The new milestone ID for the pull request") public Long getMilestone() { return milestone; } @@ -232,11 +232,11 @@ public class EditPullRequestOption implements Serializable { } /** - * Get state + * The new state for the pull request * * @return state */ - @Schema(description = "") + @Schema(description = "The new state for the pull request") public String getState() { return state; } @@ -251,11 +251,11 @@ public class EditPullRequestOption implements Serializable { } /** - * Get title + * The new title for the pull request * * @return title */ - @Schema(description = "") + @Schema(description = "The new title for the pull request") public String getTitle() { return title; } @@ -270,11 +270,11 @@ public class EditPullRequestOption implements Serializable { } /** - * Get unsetDueDate + * Whether to remove the current deadline * * @return unsetDueDate */ - @Schema(description = "") + @Schema(description = "Whether to remove the current deadline") public Boolean isUnsetDueDate() { return unsetDueDate; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/EditReactionOption.java b/src/main/java/org/gitnex/tea4j/v2/models/EditReactionOption.java index 09ce5c4..1971b03 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/EditReactionOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/EditReactionOption.java @@ -31,11 +31,11 @@ public class EditReactionOption implements Serializable { } /** - * Get content + * The reaction content (e.g., emoji or reaction type) * * @return content */ - @Schema(description = "") + @Schema(description = "The reaction content (e.g., emoji or reaction type)") public String getContent() { return content; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/EditReleaseOption.java b/src/main/java/org/gitnex/tea4j/v2/models/EditReleaseOption.java index df3df0e..5c86edf 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/EditReleaseOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/EditReleaseOption.java @@ -46,11 +46,11 @@ public class EditReleaseOption implements Serializable { } /** - * Get body + * The new release notes or description * * @return body */ - @Schema(description = "") + @Schema(description = "The new release notes or description") public String getBody() { return body; } @@ -65,11 +65,11 @@ public class EditReleaseOption implements Serializable { } /** - * Get draft + * Whether to change the draft status * * @return draft */ - @Schema(description = "") + @Schema(description = "Whether to change the draft status") public Boolean isDraft() { return draft; } @@ -84,11 +84,11 @@ public class EditReleaseOption implements Serializable { } /** - * Get name + * The new display title of the release * * @return name */ - @Schema(description = "") + @Schema(description = "The new display title of the release") public String getName() { return name; } @@ -103,11 +103,11 @@ public class EditReleaseOption implements Serializable { } /** - * Get prerelease + * Whether to change the prerelease status * * @return prerelease */ - @Schema(description = "") + @Schema(description = "Whether to change the prerelease status") public Boolean isPrerelease() { return prerelease; } @@ -122,11 +122,11 @@ public class EditReleaseOption implements Serializable { } /** - * Get tagName + * The new name of the git tag * * @return tagName */ - @Schema(description = "") + @Schema(description = "The new name of the git tag") public String getTagName() { return tagName; } @@ -141,11 +141,11 @@ public class EditReleaseOption implements Serializable { } /** - * Get targetCommitish + * The new target commitish for the release * * @return targetCommitish */ - @Schema(description = "") + @Schema(description = "The new target commitish for the release") public String getTargetCommitish() { return targetCommitish; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/EditTagProtectionOption.java b/src/main/java/org/gitnex/tea4j/v2/models/EditTagProtectionOption.java index 884a9c2..0950f6f 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/EditTagProtectionOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/EditTagProtectionOption.java @@ -39,11 +39,11 @@ public class EditTagProtectionOption implements Serializable { } /** - * Get namePattern + * The pattern to match tag names for protection * * @return namePattern */ - @Schema(description = "") + @Schema(description = "The pattern to match tag names for protection") public String getNamePattern() { return namePattern; } @@ -66,11 +66,11 @@ public class EditTagProtectionOption implements Serializable { } /** - * Get whitelistTeams + * List of team names allowed to create/delete protected tags * * @return whitelistTeams */ - @Schema(description = "") + @Schema(description = "List of team names allowed to create/delete protected tags") public List getWhitelistTeams() { return whitelistTeams; } @@ -93,11 +93,11 @@ public class EditTagProtectionOption implements Serializable { } /** - * Get whitelistUsernames + * List of usernames allowed to create/delete protected tags * * @return whitelistUsernames */ - @Schema(description = "") + @Schema(description = "List of usernames allowed to create/delete protected tags") public List getWhitelistUsernames() { return whitelistUsernames; } 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 f65678b..ff5feea 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/EditTeamOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/EditTeamOption.java @@ -104,11 +104,11 @@ public class EditTeamOption implements Serializable { } /** - * Get canCreateOrgRepo + * Whether the team can create repositories in the organization * * @return canCreateOrgRepo */ - @Schema(description = "") + @Schema(description = "Whether the team can create repositories in the organization") public Boolean isCanCreateOrgRepo() { return canCreateOrgRepo; } @@ -123,11 +123,11 @@ public class EditTeamOption implements Serializable { } /** - * Get description + * The description of the team * * @return description */ - @Schema(description = "") + @Schema(description = "The description of the team") public String getDescription() { return description; } @@ -142,11 +142,11 @@ public class EditTeamOption implements Serializable { } /** - * Get includesAllRepositories + * Whether the team has access to all repositories in the organization * * @return includesAllRepositories */ - @Schema(description = "") + @Schema(description = "Whether the team has access to all repositories in the organization") public Boolean isIncludesAllRepositories() { return includesAllRepositories; } 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 878e35c..dccde99 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/EditUserOption.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/EditUserOption.java @@ -82,11 +82,11 @@ public class EditUserOption implements Serializable { } /** - * Get active + * Whether the user account is active * * @return active */ - @Schema(description = "") + @Schema(description = "Whether the user account is active") public Boolean isActive() { return active; } @@ -101,11 +101,11 @@ public class EditUserOption implements Serializable { } /** - * Get admin + * Whether the user has administrator privileges * * @return admin */ - @Schema(description = "") + @Schema(description = "Whether the user has administrator privileges") public Boolean isAdmin() { return admin; } @@ -120,11 +120,11 @@ public class EditUserOption implements Serializable { } /** - * Get allowCreateOrganization + * Whether the user can create organizations * * @return allowCreateOrganization */ - @Schema(description = "") + @Schema(description = "Whether the user can create organizations") public Boolean isAllowCreateOrganization() { return allowCreateOrganization; } @@ -139,11 +139,11 @@ public class EditUserOption implements Serializable { } /** - * Get allowGitHook + * Whether the user can use Git hooks * * @return allowGitHook */ - @Schema(description = "") + @Schema(description = "Whether the user can use Git hooks") public Boolean isAllowGitHook() { return allowGitHook; } @@ -158,11 +158,11 @@ public class EditUserOption implements Serializable { } /** - * Get allowImportLocal + * Whether the user can import local repositories * * @return allowImportLocal */ - @Schema(description = "") + @Schema(description = "Whether the user can import local repositories") public Boolean isAllowImportLocal() { return allowImportLocal; } @@ -177,11 +177,11 @@ public class EditUserOption implements Serializable { } /** - * Get description + * The user's personal description or bio * * @return description */ - @Schema(description = "") + @Schema(description = "The user's personal description or bio") public String getDescription() { return description; } @@ -215,11 +215,11 @@ public class EditUserOption implements Serializable { } /** - * Get fullName + * The full display name of the user * * @return fullName */ - @Schema(description = "") + @Schema(description = "The full display name of the user") public String getFullName() { return fullName; } @@ -234,11 +234,11 @@ public class EditUserOption implements Serializable { } /** - * Get location + * The user's location or address * * @return location */ - @Schema(description = "") + @Schema(description = "The user's location or address") public String getLocation() { return location; } @@ -275,11 +275,11 @@ public class EditUserOption implements Serializable { } /** - * Get maxRepoCreation + * Maximum number of repositories the user can create * * @return maxRepoCreation */ - @Schema(description = "") + @Schema(description = "Maximum number of repositories the user can create") public Long getMaxRepoCreation() { return maxRepoCreation; } @@ -294,11 +294,11 @@ public class EditUserOption implements Serializable { } /** - * Get mustChangePassword + * Whether the user must change password on next login * * @return mustChangePassword */ - @Schema(description = "") + @Schema(description = "Whether the user must change password on next login") public Boolean isMustChangePassword() { return mustChangePassword; } @@ -313,11 +313,11 @@ public class EditUserOption implements Serializable { } /** - * Get password + * The plain text password for the user * * @return password */ - @Schema(description = "") + @Schema(description = "The plain text password for the user") public String getPassword() { return password; } @@ -332,11 +332,11 @@ public class EditUserOption implements Serializable { } /** - * Get prohibitLogin + * Whether the user is prohibited from logging in * * @return prohibitLogin */ - @Schema(description = "") + @Schema(description = "Whether the user is prohibited from logging in") public Boolean isProhibitLogin() { return prohibitLogin; } @@ -351,11 +351,11 @@ public class EditUserOption implements Serializable { } /** - * Get restricted + * Whether the user has restricted access privileges * * @return restricted */ - @Schema(description = "") + @Schema(description = "Whether the user has restricted access privileges") public Boolean isRestricted() { return restricted; } @@ -389,11 +389,11 @@ public class EditUserOption implements Serializable { } /** - * Get visibility + * User visibility level: public, limited, or private * * @return visibility */ - @Schema(description = "") + @Schema(description = "User visibility level: public, limited, or private") public String getVisibility() { return visibility; } @@ -408,11 +408,11 @@ public class EditUserOption implements Serializable { } /** - * Get website + * The user's personal website URL * * @return website */ - @Schema(description = "") + @Schema(description = "The user's personal website URL") public String getWebsite() { return website; } 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 ff57b34..002596c 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/Email.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/Email.java @@ -62,11 +62,11 @@ public class Email implements Serializable { } /** - * Get primary + * Whether this is the primary email address * * @return primary */ - @Schema(description = "") + @Schema(description = "Whether this is the primary email address") public Boolean isPrimary() { return primary; } @@ -81,11 +81,11 @@ public class Email implements Serializable { } /** - * Get userId + * The unique identifier of the user who owns this email * * @return userId */ - @Schema(description = "") + @Schema(description = "The unique identifier of the user who owns this email") public Long getUserId() { return userId; } @@ -119,11 +119,11 @@ public class Email implements Serializable { } /** - * Get verified + * Whether the email address has been verified * * @return verified */ - @Schema(description = "") + @Schema(description = "Whether the email address has been verified") public Boolean isVerified() { return verified; } 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 1641911..16df951 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/FileCommitResponse.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/FileCommitResponse.java @@ -114,11 +114,11 @@ public class FileCommitResponse implements Serializable { } /** - * Get htmlUrl + * HTMLURL is the web URL for viewing this commit * * @return htmlUrl */ - @Schema(description = "") + @Schema(description = "HTMLURL is the web URL for viewing this commit") public String getHtmlUrl() { return htmlUrl; } @@ -133,11 +133,11 @@ public class FileCommitResponse implements Serializable { } /** - * Get message + * Message is the commit message * * @return message */ - @Schema(description = "") + @Schema(description = "Message is the commit message") public String getMessage() { return message; } @@ -160,11 +160,11 @@ public class FileCommitResponse implements Serializable { } /** - * Get parents + * Parents contains parent commit metadata * * @return parents */ - @Schema(description = "") + @Schema(description = "Parents contains parent commit metadata") public List getParents() { return parents; } @@ -179,11 +179,11 @@ public class FileCommitResponse implements Serializable { } /** - * Get sha + * SHA is the commit SHA hash * * @return sha */ - @Schema(description = "") + @Schema(description = "SHA is the commit SHA hash") public String getSha() { return sha; } @@ -217,11 +217,11 @@ public class FileCommitResponse implements Serializable { } /** - * Get url + * URL is the API URL for the commit * * @return url */ - @Schema(description = "") + @Schema(description = "URL is the API URL for the commit") public String getUrl() { return url; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/FileDeleteResponse.java b/src/main/java/org/gitnex/tea4j/v2/models/FileDeleteResponse.java index 14a0b4e..bd04472 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/FileDeleteResponse.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/FileDeleteResponse.java @@ -57,11 +57,11 @@ public class FileDeleteResponse implements Serializable { } /** - * Get content + * Content is always null for delete operations * * @return content */ - @Schema(description = "") + @Schema(description = "Content is always null for delete operations") public Object getContent() { return content; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/FileLinksResponse.java b/src/main/java/org/gitnex/tea4j/v2/models/FileLinksResponse.java index 4f84008..5ead967 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/FileLinksResponse.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/FileLinksResponse.java @@ -37,11 +37,11 @@ public class FileLinksResponse implements Serializable { } /** - * Get git + * GitURL is the Git API URL for this file * * @return git */ - @Schema(description = "") + @Schema(description = "GitURL is the Git API URL for this file") public String getGit() { return git; } @@ -56,11 +56,11 @@ public class FileLinksResponse implements Serializable { } /** - * Get html + * HTMLURL is the web URL for this file * * @return html */ - @Schema(description = "") + @Schema(description = "HTMLURL is the web URL for this file") public String getHtml() { return html; } @@ -75,11 +75,11 @@ public class FileLinksResponse implements Serializable { } /** - * Get self + * Self is the API URL for this file * * @return self */ - @Schema(description = "") + @Schema(description = "Self is the API URL for this file") public String getSelf() { return self; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/FilesResponse.java b/src/main/java/org/gitnex/tea4j/v2/models/FilesResponse.java index d76e1bd..58e57e5 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/FilesResponse.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/FilesResponse.java @@ -66,11 +66,11 @@ public class FilesResponse implements Serializable { } /** - * Get files + * Files contains the list of file contents and metadata * * @return files */ - @Schema(description = "") + @Schema(description = "Files contains the list of file contents and metadata") public List getFiles() { return files; } 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 b5c4635..6d39f2e 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/GPGKey.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/GPGKey.java @@ -70,11 +70,11 @@ public class GPGKey implements Serializable { } /** - * Get canCertify + * Whether the key can be used for certification * * @return canCertify */ - @Schema(description = "") + @Schema(description = "Whether the key can be used for certification") public Boolean isCanCertify() { return canCertify; } @@ -89,11 +89,11 @@ public class GPGKey implements Serializable { } /** - * Get canEncryptComms + * Whether the key can be used for encrypting communications * * @return canEncryptComms */ - @Schema(description = "") + @Schema(description = "Whether the key can be used for encrypting communications") public Boolean isCanEncryptComms() { return canEncryptComms; } @@ -108,11 +108,11 @@ public class GPGKey implements Serializable { } /** - * Get canEncryptStorage + * Whether the key can be used for encrypting storage * * @return canEncryptStorage */ - @Schema(description = "") + @Schema(description = "Whether the key can be used for encrypting storage") public Boolean isCanEncryptStorage() { return canEncryptStorage; } @@ -127,11 +127,11 @@ public class GPGKey implements Serializable { } /** - * Get canSign + * Whether the key can be used for signing * * @return canSign */ - @Schema(description = "") + @Schema(description = "Whether the key can be used for signing") public Boolean isCanSign() { return canSign; } @@ -173,11 +173,11 @@ public class GPGKey implements Serializable { } /** - * Get emails + * List of email addresses associated with this GPG key * * @return emails */ - @Schema(description = "") + @Schema(description = "List of email addresses associated with this GPG key") public List getEmails() { return emails; } @@ -211,11 +211,11 @@ public class GPGKey implements Serializable { } /** - * Get id + * The unique identifier of the GPG key * * @return id */ - @Schema(description = "") + @Schema(description = "The unique identifier of the GPG key") public Long getId() { return id; } @@ -230,11 +230,11 @@ public class GPGKey implements Serializable { } /** - * Get keyId + * The key ID of the GPG key * * @return keyId */ - @Schema(description = "") + @Schema(description = "The key ID of the GPG key") public String getKeyId() { return keyId; } @@ -249,11 +249,11 @@ public class GPGKey implements Serializable { } /** - * Get primaryKeyId + * The primary key ID of the GPG key * * @return primaryKeyId */ - @Schema(description = "") + @Schema(description = "The primary key ID of the GPG key") public String getPrimaryKeyId() { return primaryKeyId; } @@ -268,11 +268,11 @@ public class GPGKey implements Serializable { } /** - * Get publicKey + * The public key content in armored format * * @return publicKey */ - @Schema(description = "") + @Schema(description = "The public key content in armored format") public String getPublicKey() { return publicKey; } @@ -295,11 +295,11 @@ public class GPGKey implements Serializable { } /** - * Get subkeys + * List of subkeys of this GPG key * * @return subkeys */ - @Schema(description = "") + @Schema(description = "List of subkeys of this GPG key") public List getSubkeys() { return subkeys; } @@ -314,11 +314,11 @@ public class GPGKey implements Serializable { } /** - * Get verified + * Whether the GPG key has been verified * * @return verified */ - @Schema(description = "") + @Schema(description = "Whether the GPG key has been verified") public Boolean isVerified() { return verified; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/GPGKeyEmail.java b/src/main/java/org/gitnex/tea4j/v2/models/GPGKeyEmail.java index 44d0ed5..66015f7 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/GPGKeyEmail.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/GPGKeyEmail.java @@ -34,11 +34,11 @@ public class GPGKeyEmail implements Serializable { } /** - * Get email + * The email address associated with the GPG key * * @return email */ - @Schema(description = "") + @Schema(description = "The email address associated with the GPG key") public String getEmail() { return email; } @@ -53,11 +53,11 @@ public class GPGKeyEmail implements Serializable { } /** - * Get verified + * Whether the email address has been verified * * @return verified */ - @Schema(description = "") + @Schema(description = "Whether the email address has been verified") public Boolean isVerified() { return verified; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/GeneralAPISettings.java b/src/main/java/org/gitnex/tea4j/v2/models/GeneralAPISettings.java index a8e066a..de4bc43 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/GeneralAPISettings.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/GeneralAPISettings.java @@ -43,11 +43,11 @@ public class GeneralAPISettings implements Serializable { } /** - * Get defaultGitTreesPerPage + * DefaultGitTreesPerPage is the default number of Git tree items per page * * @return defaultGitTreesPerPage */ - @Schema(description = "") + @Schema(description = "DefaultGitTreesPerPage is the default number of Git tree items per page") public Long getDefaultGitTreesPerPage() { return defaultGitTreesPerPage; } @@ -62,11 +62,11 @@ public class GeneralAPISettings implements Serializable { } /** - * Get defaultMaxBlobSize + * DefaultMaxBlobSize is the default maximum blob size for API responses * * @return defaultMaxBlobSize */ - @Schema(description = "") + @Schema(description = "DefaultMaxBlobSize is the default maximum blob size for API responses") public Long getDefaultMaxBlobSize() { return defaultMaxBlobSize; } @@ -81,11 +81,11 @@ public class GeneralAPISettings implements Serializable { } /** - * Get defaultMaxResponseSize + * DefaultMaxResponseSize is the default maximum response size * * @return defaultMaxResponseSize */ - @Schema(description = "") + @Schema(description = "DefaultMaxResponseSize is the default maximum response size") public Long getDefaultMaxResponseSize() { return defaultMaxResponseSize; } @@ -100,11 +100,11 @@ public class GeneralAPISettings implements Serializable { } /** - * Get defaultPagingNum + * DefaultPagingNum is the default number of items per page * * @return defaultPagingNum */ - @Schema(description = "") + @Schema(description = "DefaultPagingNum is the default number of items per page") public Long getDefaultPagingNum() { return defaultPagingNum; } @@ -119,11 +119,11 @@ public class GeneralAPISettings implements Serializable { } /** - * Get maxResponseItems + * MaxResponseItems is the maximum number of items returned in API responses * * @return maxResponseItems */ - @Schema(description = "") + @Schema(description = "MaxResponseItems is the maximum number of items returned in API responses") public Long getMaxResponseItems() { return maxResponseItems; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/GeneralAttachmentSettings.java b/src/main/java/org/gitnex/tea4j/v2/models/GeneralAttachmentSettings.java index 6157a13..737c9d2 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/GeneralAttachmentSettings.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/GeneralAttachmentSettings.java @@ -41,11 +41,11 @@ public class GeneralAttachmentSettings implements Serializable { } /** - * Get allowedTypes + * AllowedTypes contains the allowed file types for attachments * * @return allowedTypes */ - @Schema(description = "") + @Schema(description = "AllowedTypes contains the allowed file types for attachments") public String getAllowedTypes() { return allowedTypes; } @@ -60,11 +60,11 @@ public class GeneralAttachmentSettings implements Serializable { } /** - * Get enabled + * Enabled indicates if file attachments are enabled * * @return enabled */ - @Schema(description = "") + @Schema(description = "Enabled indicates if file attachments are enabled") public Boolean isEnabled() { return enabled; } @@ -79,11 +79,11 @@ public class GeneralAttachmentSettings implements Serializable { } /** - * Get maxFiles + * MaxFiles is the maximum number of files per attachment * * @return maxFiles */ - @Schema(description = "") + @Schema(description = "MaxFiles is the maximum number of files per attachment") public Long getMaxFiles() { return maxFiles; } @@ -98,11 +98,11 @@ public class GeneralAttachmentSettings implements Serializable { } /** - * Get maxSize + * MaxSize is the maximum size for individual attachments * * @return maxSize */ - @Schema(description = "") + @Schema(description = "MaxSize is the maximum size for individual attachments") public Long getMaxSize() { return maxSize; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/GeneralRepoSettings.java b/src/main/java/org/gitnex/tea4j/v2/models/GeneralRepoSettings.java index a5409c9..9f7a4fe 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/GeneralRepoSettings.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/GeneralRepoSettings.java @@ -46,11 +46,11 @@ public class GeneralRepoSettings implements Serializable { } /** - * Get httpGitDisabled + * HTTPGitDisabled indicates if HTTP Git operations are disabled * * @return httpGitDisabled */ - @Schema(description = "") + @Schema(description = "HTTPGitDisabled indicates if HTTP Git operations are disabled") public Boolean isHttpGitDisabled() { return httpGitDisabled; } @@ -65,11 +65,11 @@ public class GeneralRepoSettings implements Serializable { } /** - * Get lfsDisabled + * LFSDisabled indicates if Git LFS support is disabled * * @return lfsDisabled */ - @Schema(description = "") + @Schema(description = "LFSDisabled indicates if Git LFS support is disabled") public Boolean isLfsDisabled() { return lfsDisabled; } @@ -84,11 +84,11 @@ public class GeneralRepoSettings implements Serializable { } /** - * Get migrationsDisabled + * MigrationsDisabled indicates if repository migrations are disabled * * @return migrationsDisabled */ - @Schema(description = "") + @Schema(description = "MigrationsDisabled indicates if repository migrations are disabled") public Boolean isMigrationsDisabled() { return migrationsDisabled; } @@ -103,11 +103,11 @@ public class GeneralRepoSettings implements Serializable { } /** - * Get mirrorsDisabled + * MirrorsDisabled indicates if repository mirroring is disabled * * @return mirrorsDisabled */ - @Schema(description = "") + @Schema(description = "MirrorsDisabled indicates if repository mirroring is disabled") public Boolean isMirrorsDisabled() { return mirrorsDisabled; } @@ -122,11 +122,11 @@ public class GeneralRepoSettings implements Serializable { } /** - * Get starsDisabled + * StarsDisabled indicates if repository starring is disabled * * @return starsDisabled */ - @Schema(description = "") + @Schema(description = "StarsDisabled indicates if repository starring is disabled") public Boolean isStarsDisabled() { return starsDisabled; } @@ -141,11 +141,11 @@ public class GeneralRepoSettings implements Serializable { } /** - * Get timeTrackingDisabled + * TimeTrackingDisabled indicates if time tracking is disabled * * @return timeTrackingDisabled */ - @Schema(description = "") + @Schema(description = "TimeTrackingDisabled indicates if time tracking is disabled") public Boolean isTimeTrackingDisabled() { return timeTrackingDisabled; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/GeneralUISettings.java b/src/main/java/org/gitnex/tea4j/v2/models/GeneralUISettings.java index 200e489..a75c679 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/GeneralUISettings.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/GeneralUISettings.java @@ -47,11 +47,11 @@ public class GeneralUISettings implements Serializable { } /** - * Get allowedReactions + * AllowedReactions contains the list of allowed emoji reactions * * @return allowedReactions */ - @Schema(description = "") + @Schema(description = "AllowedReactions contains the list of allowed emoji reactions") public List getAllowedReactions() { return allowedReactions; } @@ -74,11 +74,11 @@ public class GeneralUISettings implements Serializable { } /** - * Get customEmojis + * CustomEmojis contains the list of custom emojis * * @return customEmojis */ - @Schema(description = "") + @Schema(description = "CustomEmojis contains the list of custom emojis") public List getCustomEmojis() { return customEmojis; } @@ -93,11 +93,11 @@ public class GeneralUISettings implements Serializable { } /** - * Get defaultTheme + * DefaultTheme is the default UI theme * * @return defaultTheme */ - @Schema(description = "") + @Schema(description = "DefaultTheme is the default UI theme") public String getDefaultTheme() { return defaultTheme; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/GetFilesOptions.java b/src/main/java/org/gitnex/tea4j/v2/models/GetFilesOptions.java index 2583207..3326d9e 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/GetFilesOptions.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/GetFilesOptions.java @@ -42,11 +42,11 @@ public class GetFilesOptions implements Serializable { } /** - * Get files + * Files is the list of file paths to retrieve * * @return files */ - @Schema(description = "") + @Schema(description = "Files is the list of file paths to retrieve") public List getFiles() { return files; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/GitBlobResponse.java b/src/main/java/org/gitnex/tea4j/v2/models/GitBlobResponse.java index 3f72141..d6dcf9b 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/GitBlobResponse.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/GitBlobResponse.java @@ -49,11 +49,11 @@ public class GitBlobResponse implements Serializable { } /** - * Get content + * The content of the git blob (may be base64 encoded) * * @return content */ - @Schema(description = "") + @Schema(description = "The content of the git blob (may be base64 encoded)") public String getContent() { return content; } @@ -68,11 +68,11 @@ public class GitBlobResponse implements Serializable { } /** - * Get encoding + * The encoding used for the content (e.g., \"base64\") * * @return encoding */ - @Schema(description = "") + @Schema(description = "The encoding used for the content (e.g., \"base64\")") public String getEncoding() { return encoding; } @@ -87,11 +87,11 @@ public class GitBlobResponse implements Serializable { } /** - * Get lfsOid + * The LFS object ID if this blob is stored in LFS * * @return lfsOid */ - @Schema(description = "") + @Schema(description = "The LFS object ID if this blob is stored in LFS") public String getLfsOid() { return lfsOid; } @@ -106,11 +106,11 @@ public class GitBlobResponse implements Serializable { } /** - * Get lfsSize + * The size of the LFS object if this blob is stored in LFS * * @return lfsSize */ - @Schema(description = "") + @Schema(description = "The size of the LFS object if this blob is stored in LFS") public Long getLfsSize() { return lfsSize; } @@ -125,11 +125,11 @@ public class GitBlobResponse implements Serializable { } /** - * Get sha + * The SHA hash of the git blob * * @return sha */ - @Schema(description = "") + @Schema(description = "The SHA hash of the git blob") public String getSha() { return sha; } @@ -144,11 +144,11 @@ public class GitBlobResponse implements Serializable { } /** - * Get size + * The size of the git blob in bytes * * @return size */ - @Schema(description = "") + @Schema(description = "The size of the git blob in bytes") public Long getSize() { return size; } @@ -163,11 +163,11 @@ public class GitBlobResponse implements Serializable { } /** - * Get url + * The URL to access this git blob * * @return url */ - @Schema(description = "") + @Schema(description = "The URL to access this git blob") public String getUrl() { return url; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/GitEntry.java b/src/main/java/org/gitnex/tea4j/v2/models/GitEntry.java index cc5e749..7db92fb 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/GitEntry.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/GitEntry.java @@ -46,11 +46,11 @@ public class GitEntry implements Serializable { } /** - * Get mode + * Mode is the file mode (permissions) * * @return mode */ - @Schema(description = "") + @Schema(description = "Mode is the file mode (permissions)") public String getMode() { return mode; } @@ -65,11 +65,11 @@ public class GitEntry implements Serializable { } /** - * Get path + * Path is the file or directory path * * @return path */ - @Schema(description = "") + @Schema(description = "Path is the file or directory path") public String getPath() { return path; } @@ -84,11 +84,11 @@ public class GitEntry implements Serializable { } /** - * Get sha + * SHA is the Git object SHA * * @return sha */ - @Schema(description = "") + @Schema(description = "SHA is the Git object SHA") public String getSha() { return sha; } @@ -103,11 +103,11 @@ public class GitEntry implements Serializable { } /** - * Get size + * Size is the file size in bytes * * @return size */ - @Schema(description = "") + @Schema(description = "Size is the file size in bytes") public Long getSize() { return size; } @@ -122,11 +122,11 @@ public class GitEntry implements Serializable { } /** - * Get type + * Type indicates if this is a file, directory, or symlink * * @return type */ - @Schema(description = "") + @Schema(description = "Type indicates if this is a file, directory, or symlink") public String getType() { return type; } @@ -141,11 +141,11 @@ public class GitEntry implements Serializable { } /** - * Get url + * URL is the API URL for this tree entry * * @return url */ - @Schema(description = "") + @Schema(description = "URL is the API URL for this tree entry") public String getUrl() { return url; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/GitHook.java b/src/main/java/org/gitnex/tea4j/v2/models/GitHook.java index c0d92df..03f7d7d 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/GitHook.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/GitHook.java @@ -37,11 +37,11 @@ public class GitHook implements Serializable { } /** - * Get content + * Content contains the script content of the hook * * @return content */ - @Schema(description = "") + @Schema(description = "Content contains the script content of the hook") public String getContent() { return content; } @@ -56,11 +56,11 @@ public class GitHook implements Serializable { } /** - * Get isActive + * IsActive indicates if the hook is active * * @return isActive */ - @Schema(description = "") + @Schema(description = "IsActive indicates if the hook is active") public Boolean isIsActive() { return isActive; } @@ -75,11 +75,11 @@ public class GitHook implements Serializable { } /** - * Get name + * Name is the name of the Git hook * * @return name */ - @Schema(description = "") + @Schema(description = "Name is the name of the Git hook") public String getName() { return name; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/GitObject.java b/src/main/java/org/gitnex/tea4j/v2/models/GitObject.java index ef0cf1e..909ac56 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/GitObject.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/GitObject.java @@ -36,11 +36,11 @@ public class GitObject implements Serializable { } /** - * Get sha + * The SHA hash of the Git object * * @return sha */ - @Schema(description = "") + @Schema(description = "The SHA hash of the Git object") public String getSha() { return sha; } @@ -55,11 +55,11 @@ public class GitObject implements Serializable { } /** - * Get type + * The type of the Git object (e.g., commit, tag, tree, blob) * * @return type */ - @Schema(description = "") + @Schema(description = "The type of the Git object (e.g., commit, tag, tree, blob)") public String getType() { return type; } @@ -74,11 +74,11 @@ public class GitObject implements Serializable { } /** - * Get url + * The URL to access this Git object * * @return url */ - @Schema(description = "") + @Schema(description = "The URL to access this Git object") public String getUrl() { return url; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/GitTreeResponse.java b/src/main/java/org/gitnex/tea4j/v2/models/GitTreeResponse.java index d6766a4..ecd9439 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/GitTreeResponse.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/GitTreeResponse.java @@ -48,11 +48,11 @@ public class GitTreeResponse implements Serializable { } /** - * Get page + * Page is the current page number for pagination * * @return page */ - @Schema(description = "") + @Schema(description = "Page is the current page number for pagination") public Long getPage() { return page; } @@ -67,11 +67,11 @@ public class GitTreeResponse implements Serializable { } /** - * Get sha + * SHA is the tree object SHA * * @return sha */ - @Schema(description = "") + @Schema(description = "SHA is the tree object SHA") public String getSha() { return sha; } @@ -86,11 +86,11 @@ public class GitTreeResponse implements Serializable { } /** - * Get totalCount + * TotalCount is the total number of entries in the tree * * @return totalCount */ - @Schema(description = "") + @Schema(description = "TotalCount is the total number of entries in the tree") public Long getTotalCount() { return totalCount; } @@ -113,11 +113,11 @@ public class GitTreeResponse implements Serializable { } /** - * Get tree + * Entries contains the tree entries (files and directories) * * @return tree */ - @Schema(description = "") + @Schema(description = "Entries contains the tree entries (files and directories)") public List getTree() { return tree; } @@ -132,11 +132,11 @@ public class GitTreeResponse implements Serializable { } /** - * Get truncated + * Truncated indicates if the response was truncated due to size * * @return truncated */ - @Schema(description = "") + @Schema(description = "Truncated indicates if the response was truncated due to size") public Boolean isTruncated() { return truncated; } @@ -151,11 +151,11 @@ public class GitTreeResponse implements Serializable { } /** - * Get url + * URL is the API URL for this tree * * @return url */ - @Schema(description = "") + @Schema(description = "URL is the API URL for this tree") public String getUrl() { return url; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/GitignoreTemplateInfo.java b/src/main/java/org/gitnex/tea4j/v2/models/GitignoreTemplateInfo.java index cd93bb7..d6c6894 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/GitignoreTemplateInfo.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/GitignoreTemplateInfo.java @@ -34,11 +34,11 @@ public class GitignoreTemplateInfo implements Serializable { } /** - * Get name + * Name is the name of the gitignore template * * @return name */ - @Schema(description = "") + @Schema(description = "Name is the name of the gitignore template") public String getName() { return name; } @@ -53,11 +53,11 @@ public class GitignoreTemplateInfo implements Serializable { } /** - * Get source + * Source contains the content of the gitignore template * * @return source */ - @Schema(description = "") + @Schema(description = "Source contains the content of the gitignore template") public String getSource() { return source; } 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 ff60261..80d4dfe 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/Hook.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/Hook.java @@ -60,11 +60,11 @@ public class Hook implements Serializable { } /** - * Get active + * Whether the webhook is active and will be triggered * * @return active */ - @Schema(description = "") + @Schema(description = "Whether the webhook is active and will be triggered") public Boolean isActive() { return active; } @@ -79,11 +79,11 @@ public class Hook implements Serializable { } /** - * Get authorizationHeader + * Authorization header to include in webhook requests * * @return authorizationHeader */ - @Schema(description = "") + @Schema(description = "Authorization header to include in webhook requests") public String getAuthorizationHeader() { return authorizationHeader; } @@ -98,11 +98,11 @@ public class Hook implements Serializable { } /** - * Get branchFilter + * Branch filter pattern to determine which branches trigger the webhook * * @return branchFilter */ - @Schema(description = "") + @Schema(description = "Branch filter pattern to determine which branches trigger the webhook") public String getBranchFilter() { return branchFilter; } @@ -125,11 +125,11 @@ public class Hook implements Serializable { } /** - * Get config + * Configuration settings for the webhook * * @return config */ - @Schema(description = "") + @Schema(description = "Configuration settings for the webhook") public Map getConfig() { return config; } @@ -171,11 +171,11 @@ public class Hook implements Serializable { } /** - * Get events + * List of events that trigger this webhook * * @return events */ - @Schema(description = "") + @Schema(description = "List of events that trigger this webhook") public List getEvents() { return events; } @@ -190,11 +190,11 @@ public class Hook implements Serializable { } /** - * Get id + * The unique identifier of the webhook * * @return id */ - @Schema(description = "") + @Schema(description = "The unique identifier of the webhook") public Long getId() { return id; } @@ -209,11 +209,11 @@ public class Hook implements Serializable { } /** - * Get type + * The type of the webhook (e.g., gitea, slack, discord) * * @return type */ - @Schema(description = "") + @Schema(description = "The type of the webhook (e.g., gitea, slack, discord)") public String getType() { return type; } 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 e9533aa..853f860 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/Identity.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/Identity.java @@ -53,11 +53,11 @@ public class Identity implements Serializable { } /** - * Get name + * Name is the person's name * * @return name */ - @Schema(description = "") + @Schema(description = "Name is the person's name") public String getName() { return name; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/Label.java b/src/main/java/org/gitnex/tea4j/v2/models/Label.java index 43337cb..6317b7a 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/Label.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/Label.java @@ -68,11 +68,11 @@ public class Label implements Serializable { } /** - * Get description + * Description provides additional context about the label's purpose * * @return description */ - @Schema(description = "") + @Schema(description = "Description provides additional context about the label's purpose") public String getDescription() { return description; } @@ -106,11 +106,11 @@ public class Label implements Serializable { } /** - * Get id + * ID is the unique identifier for the label * * @return id */ - @Schema(description = "") + @Schema(description = "ID is the unique identifier for the label") public Long getId() { return id; } @@ -144,11 +144,11 @@ public class Label implements Serializable { } /** - * Get name + * Name is the display name of the label * * @return name */ - @Schema(description = "") + @Schema(description = "Name is the display name of the label") public String getName() { return name; } @@ -163,11 +163,11 @@ public class Label implements Serializable { } /** - * Get url + * URL is the API endpoint for accessing this label * * @return url */ - @Schema(description = "") + @Schema(description = "URL is the API endpoint for accessing this label") public String getUrl() { return url; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/LabelTemplate.java b/src/main/java/org/gitnex/tea4j/v2/models/LabelTemplate.java index 01d0c8c..3866c84 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/LabelTemplate.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/LabelTemplate.java @@ -59,11 +59,12 @@ public class LabelTemplate implements Serializable { } /** - * Get description + * Description provides additional context about the label template's purpose * * @return description */ - @Schema(description = "") + @Schema( + description = "Description provides additional context about the label template's purpose") public String getDescription() { return description; } @@ -97,11 +98,11 @@ public class LabelTemplate implements Serializable { } /** - * Get name + * Name is the display name of the label template * * @return name */ - @Schema(description = "") + @Schema(description = "Name is the display name of the label template") public String getName() { return name; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/LicenseTemplateInfo.java b/src/main/java/org/gitnex/tea4j/v2/models/LicenseTemplateInfo.java index fee2e74..8bd090a 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/LicenseTemplateInfo.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/LicenseTemplateInfo.java @@ -43,11 +43,11 @@ public class LicenseTemplateInfo implements Serializable { } /** - * Get body + * Body contains the full text of the license * * @return body */ - @Schema(description = "") + @Schema(description = "Body contains the full text of the license") public String getBody() { return body; } @@ -62,11 +62,11 @@ public class LicenseTemplateInfo implements Serializable { } /** - * Get implementation + * Implementation contains license implementation details * * @return implementation */ - @Schema(description = "") + @Schema(description = "Implementation contains license implementation details") public String getImplementation() { return implementation; } @@ -81,11 +81,11 @@ public class LicenseTemplateInfo implements Serializable { } /** - * Get key + * Key is the unique identifier for the license template * * @return key */ - @Schema(description = "") + @Schema(description = "Key is the unique identifier for the license template") public String getKey() { return key; } @@ -100,11 +100,11 @@ public class LicenseTemplateInfo implements Serializable { } /** - * Get name + * Name is the display name of the license * * @return name */ - @Schema(description = "") + @Schema(description = "Name is the display name of the license") public String getName() { return name; } @@ -119,11 +119,11 @@ public class LicenseTemplateInfo implements Serializable { } /** - * Get url + * URL is the reference URL for the license * * @return url */ - @Schema(description = "") + @Schema(description = "URL is the reference URL for the license") public String getUrl() { return url; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/LicensesTemplateListEntry.java b/src/main/java/org/gitnex/tea4j/v2/models/LicensesTemplateListEntry.java index 40cec81..f99521d 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/LicensesTemplateListEntry.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/LicensesTemplateListEntry.java @@ -37,11 +37,11 @@ public class LicensesTemplateListEntry implements Serializable { } /** - * Get key + * Key is the unique identifier for the license template * * @return key */ - @Schema(description = "") + @Schema(description = "Key is the unique identifier for the license template") public String getKey() { return key; } @@ -56,11 +56,11 @@ public class LicensesTemplateListEntry implements Serializable { } /** - * Get name + * Name is the display name of the license * * @return name */ - @Schema(description = "") + @Schema(description = "Name is the display name of the license") public String getName() { return name; } @@ -75,11 +75,11 @@ public class LicensesTemplateListEntry implements Serializable { } /** - * Get url + * URL is the reference URL for the license * * @return url */ - @Schema(description = "") + @Schema(description = "URL is the reference URL for the license") public String getUrl() { return url; } 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 a3b7947..3689444 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/Milestone.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/Milestone.java @@ -78,11 +78,11 @@ public class Milestone implements Serializable { } /** - * Get closedIssues + * ClosedIssues is the number of closed issues in this milestone * * @return closedIssues */ - @Schema(description = "") + @Schema(description = "ClosedIssues is the number of closed issues in this milestone") public Long getClosedIssues() { return closedIssues; } @@ -116,11 +116,11 @@ public class Milestone implements Serializable { } /** - * Get description + * Description provides details about the milestone * * @return description */ - @Schema(description = "") + @Schema(description = "Description provides details about the milestone") public String getDescription() { return description; } @@ -154,11 +154,11 @@ public class Milestone implements Serializable { } /** - * Get id + * ID is the unique identifier for the milestone * * @return id */ - @Schema(description = "") + @Schema(description = "ID is the unique identifier for the milestone") public Long getId() { return id; } @@ -173,11 +173,11 @@ public class Milestone implements Serializable { } /** - * Get openIssues + * OpenIssues is the number of open issues in this milestone * * @return openIssues */ - @Schema(description = "") + @Schema(description = "OpenIssues is the number of open issues in this milestone") public Long getOpenIssues() { return openIssues; } @@ -211,11 +211,11 @@ public class Milestone implements Serializable { } /** - * Get title + * Title is the title of the milestone * * @return title */ - @Schema(description = "") + @Schema(description = "Title is the title of the milestone") public String getTitle() { return title; } 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 259d9d4..253cf83 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/ModelPackage.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/ModelPackage.java @@ -94,11 +94,11 @@ public class ModelPackage implements Serializable { } /** - * Get htmlUrl + * The HTML URL to view the package * * @return htmlUrl */ - @Schema(description = "") + @Schema(description = "The HTML URL to view the package") public String getHtmlUrl() { return htmlUrl; } @@ -113,11 +113,11 @@ public class ModelPackage implements Serializable { } /** - * Get id + * The unique identifier of the package * * @return id */ - @Schema(description = "") + @Schema(description = "The unique identifier of the package") public Long getId() { return id; } @@ -132,11 +132,11 @@ public class ModelPackage implements Serializable { } /** - * Get name + * The name of the package * * @return name */ - @Schema(description = "") + @Schema(description = "The name of the package") public String getName() { return name; } @@ -189,11 +189,11 @@ public class ModelPackage implements Serializable { } /** - * Get type + * The type of the package (e.g., npm, maven, docker) * * @return type */ - @Schema(description = "") + @Schema(description = "The type of the package (e.g., npm, maven, docker)") public String getType() { return type; } @@ -208,11 +208,11 @@ public class ModelPackage implements Serializable { } /** - * Get version + * The version of the package * * @return version */ - @Schema(description = "") + @Schema(description = "The version of the package") public String getVersion() { return version; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/NodeInfo.java b/src/main/java/org/gitnex/tea4j/v2/models/NodeInfo.java index ddd211a..515abea 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/NodeInfo.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/NodeInfo.java @@ -57,11 +57,11 @@ public class NodeInfo implements Serializable { } /** - * Get metadata + * Metadata contains free form key value pairs for software specific values * * @return metadata */ - @Schema(description = "") + @Schema(description = "Metadata contains free form key value pairs for software specific values") public Object getMetadata() { return metadata; } @@ -76,11 +76,11 @@ public class NodeInfo implements Serializable { } /** - * Get openRegistrations + * OpenRegistrations indicates if new user registrations are accepted * * @return openRegistrations */ - @Schema(description = "") + @Schema(description = "OpenRegistrations indicates if new user registrations are accepted") public Boolean isOpenRegistrations() { return openRegistrations; } @@ -103,11 +103,11 @@ public class NodeInfo implements Serializable { } /** - * Get protocols + * Protocols lists the protocols supported by this server * * @return protocols */ - @Schema(description = "") + @Schema(description = "Protocols lists the protocols supported by this server") public List getProtocols() { return protocols; } @@ -179,11 +179,11 @@ public class NodeInfo implements Serializable { } /** - * Get version + * Version specifies the schema version * * @return version */ - @Schema(description = "") + @Schema(description = "Version specifies the schema version") public String getVersion() { return version; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/NodeInfoServices.java b/src/main/java/org/gitnex/tea4j/v2/models/NodeInfoServices.java index de8ab67..339a76e 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/NodeInfoServices.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/NodeInfoServices.java @@ -50,11 +50,11 @@ public class NodeInfoServices implements Serializable { } /** - * Get inbound + * Inbound lists services that can deliver content to this server * * @return inbound */ - @Schema(description = "") + @Schema(description = "Inbound lists services that can deliver content to this server") public List getInbound() { return inbound; } @@ -77,11 +77,11 @@ public class NodeInfoServices implements Serializable { } /** - * Get outbound + * Outbound lists services this server can deliver content to * * @return outbound */ - @Schema(description = "") + @Schema(description = "Outbound lists services this server can deliver content to") public List getOutbound() { return outbound; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/NodeInfoSoftware.java b/src/main/java/org/gitnex/tea4j/v2/models/NodeInfoSoftware.java index 7381caf..d86150d 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/NodeInfoSoftware.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/NodeInfoSoftware.java @@ -40,11 +40,11 @@ public class NodeInfoSoftware implements Serializable { } /** - * Get homepage + * Homepage is the URL to the homepage of this server software * * @return homepage */ - @Schema(description = "") + @Schema(description = "Homepage is the URL to the homepage of this server software") public String getHomepage() { return homepage; } @@ -59,11 +59,11 @@ public class NodeInfoSoftware implements Serializable { } /** - * Get name + * Name is the canonical name of this server software * * @return name */ - @Schema(description = "") + @Schema(description = "Name is the canonical name of this server software") public String getName() { return name; } @@ -78,11 +78,11 @@ public class NodeInfoSoftware implements Serializable { } /** - * Get repository + * Repository is the URL to the source code repository * * @return repository */ - @Schema(description = "") + @Schema(description = "Repository is the URL to the source code repository") public String getRepository() { return repository; } @@ -97,11 +97,11 @@ public class NodeInfoSoftware implements Serializable { } /** - * Get version + * Version is the version of this server software * * @return version */ - @Schema(description = "") + @Schema(description = "Version is the version of this server software") public String getVersion() { return version; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/NodeInfoUsage.java b/src/main/java/org/gitnex/tea4j/v2/models/NodeInfoUsage.java index 8215c89..198925e 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/NodeInfoUsage.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/NodeInfoUsage.java @@ -37,11 +37,13 @@ public class NodeInfoUsage implements Serializable { } /** - * Get localComments + * LocalComments is the total amount of comments made by users local to this server * * @return localComments */ - @Schema(description = "") + @Schema( + description = + "LocalComments is the total amount of comments made by users local to this server") public Long getLocalComments() { return localComments; } @@ -56,11 +58,12 @@ public class NodeInfoUsage implements Serializable { } /** - * Get localPosts + * LocalPosts is the total amount of posts made by users local to this server * * @return localPosts */ - @Schema(description = "") + @Schema( + description = "LocalPosts is the total amount of posts made by users local to this server") public Long getLocalPosts() { return localPosts; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/NodeInfoUsageUsers.java b/src/main/java/org/gitnex/tea4j/v2/models/NodeInfoUsageUsers.java index 48428ea..d855b1a 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/NodeInfoUsageUsers.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/NodeInfoUsageUsers.java @@ -37,11 +37,13 @@ public class NodeInfoUsageUsers implements Serializable { } /** - * Get activeHalfyear + * ActiveHalfyear is the amount of users that signed in at least once in the last 180 days * * @return activeHalfyear */ - @Schema(description = "") + @Schema( + description = + "ActiveHalfyear is the amount of users that signed in at least once in the last 180 days") public Long getActiveHalfyear() { return activeHalfyear; } @@ -56,11 +58,13 @@ public class NodeInfoUsageUsers implements Serializable { } /** - * Get activeMonth + * ActiveMonth is the amount of users that signed in at least once in the last 30 days * * @return activeMonth */ - @Schema(description = "") + @Schema( + description = + "ActiveMonth is the amount of users that signed in at least once in the last 30 days") public Long getActiveMonth() { return activeMonth; } @@ -75,11 +79,11 @@ public class NodeInfoUsageUsers implements Serializable { } /** - * Get total + * Total is the total amount of users on this server * * @return total */ - @Schema(description = "") + @Schema(description = "Total is the total amount of users on this server") public Long getTotal() { return total; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/Note.java b/src/main/java/org/gitnex/tea4j/v2/models/Note.java index 952c0e3..fb537b5 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/Note.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/Note.java @@ -53,11 +53,11 @@ public class Note implements Serializable { } /** - * Get message + * The content message of the git note * * @return message */ - @Schema(description = "") + @Schema(description = "The content message of the git note") public String getMessage() { return message; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/NotificationCount.java b/src/main/java/org/gitnex/tea4j/v2/models/NotificationCount.java index 4f4bcb3..c3a3663 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/NotificationCount.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/NotificationCount.java @@ -31,11 +31,11 @@ public class NotificationCount implements Serializable { } /** - * Get _new + * New is the number of unread notifications * * @return _new */ - @Schema(description = "") + @Schema(description = "New is the number of unread notifications") public Long getNew() { return _new; } 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 10d8b45..db22cd1 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/NotificationSubject.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/NotificationSubject.java @@ -49,11 +49,11 @@ public class NotificationSubject implements Serializable { } /** - * Get htmlUrl + * HTMLURL is the web URL for the notification subject * * @return htmlUrl */ - @Schema(description = "") + @Schema(description = "HTMLURL is the web URL for the notification subject") public String getHtmlUrl() { return htmlUrl; } @@ -68,11 +68,11 @@ public class NotificationSubject implements Serializable { } /** - * Get latestCommentHtmlUrl + * LatestCommentHTMLURL is the web URL for the latest comment * * @return latestCommentHtmlUrl */ - @Schema(description = "") + @Schema(description = "LatestCommentHTMLURL is the web URL for the latest comment") public String getLatestCommentHtmlUrl() { return latestCommentHtmlUrl; } @@ -87,11 +87,11 @@ public class NotificationSubject implements Serializable { } /** - * Get latestCommentUrl + * LatestCommentURL is the API URL for the latest comment * * @return latestCommentUrl */ - @Schema(description = "") + @Schema(description = "LatestCommentURL is the API URL for the latest comment") public String getLatestCommentUrl() { return latestCommentUrl; } @@ -125,11 +125,11 @@ public class NotificationSubject implements Serializable { } /** - * Get title + * Title is the title of the notification subject * * @return title */ - @Schema(description = "") + @Schema(description = "Title is the title of the notification subject") public String getTitle() { return title; } @@ -163,11 +163,11 @@ public class NotificationSubject implements Serializable { } /** - * Get url + * URL is the API URL for the notification subject * * @return url */ - @Schema(description = "") + @Schema(description = "URL is the API URL for the notification subject") public String getUrl() { return url; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/NotificationThread.java b/src/main/java/org/gitnex/tea4j/v2/models/NotificationThread.java index a7974b4..54d6a83 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/NotificationThread.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/NotificationThread.java @@ -50,11 +50,11 @@ public class NotificationThread implements Serializable { } /** - * Get id + * ID is the unique identifier for the notification thread * * @return id */ - @Schema(description = "") + @Schema(description = "ID is the unique identifier for the notification thread") public Long getId() { return id; } @@ -69,11 +69,11 @@ public class NotificationThread implements Serializable { } /** - * Get pinned + * Pinned indicates if the notification is pinned * * @return pinned */ - @Schema(description = "") + @Schema(description = "Pinned indicates if the notification is pinned") public Boolean isPinned() { return pinned; } @@ -126,11 +126,11 @@ public class NotificationThread implements Serializable { } /** - * Get unread + * Unread indicates if the notification has been read * * @return unread */ - @Schema(description = "") + @Schema(description = "Unread indicates if the notification has been read") public Boolean isUnread() { return unread; } @@ -145,11 +145,11 @@ public class NotificationThread implements Serializable { } /** - * Get updatedAt + * UpdatedAt is the time when the notification was last updated * * @return updatedAt */ - @Schema(description = "") + @Schema(description = "UpdatedAt is the time when the notification was last updated") public Date getUpdatedAt() { return updatedAt; } @@ -164,11 +164,11 @@ public class NotificationThread implements Serializable { } /** - * Get url + * URL is the API URL for this notification thread * * @return url */ - @Schema(description = "") + @Schema(description = "URL is the API URL for this notification thread") public String getUrl() { return url; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/OAuth2Application.java b/src/main/java/org/gitnex/tea4j/v2/models/OAuth2Application.java index f670b4a..05ed28b 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/OAuth2Application.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/OAuth2Application.java @@ -54,11 +54,11 @@ public class OAuth2Application implements Serializable { } /** - * Get clientId + * The client ID of the OAuth2 application * * @return clientId */ - @Schema(description = "") + @Schema(description = "The client ID of the OAuth2 application") public String getClientId() { return clientId; } @@ -73,11 +73,11 @@ public class OAuth2Application implements Serializable { } /** - * Get clientSecret + * The client secret of the OAuth2 application * * @return clientSecret */ - @Schema(description = "") + @Schema(description = "The client secret of the OAuth2 application") public String getClientSecret() { return clientSecret; } @@ -92,11 +92,11 @@ public class OAuth2Application implements Serializable { } /** - * Get confidentialClient + * Whether the client is confidential * * @return confidentialClient */ - @Schema(description = "") + @Schema(description = "Whether the client is confidential") public Boolean isConfidentialClient() { return confidentialClient; } @@ -111,11 +111,11 @@ public class OAuth2Application implements Serializable { } /** - * Get created + * The timestamp when the application was created * * @return created */ - @Schema(description = "") + @Schema(description = "The timestamp when the application was created") public Date getCreated() { return created; } @@ -130,11 +130,11 @@ public class OAuth2Application implements Serializable { } /** - * Get id + * The unique identifier of the OAuth2 application * * @return id */ - @Schema(description = "") + @Schema(description = "The unique identifier of the OAuth2 application") public Long getId() { return id; } @@ -149,11 +149,11 @@ public class OAuth2Application implements Serializable { } /** - * Get name + * The name of the OAuth2 application * * @return name */ - @Schema(description = "") + @Schema(description = "The name of the OAuth2 application") public String getName() { return name; } @@ -176,11 +176,11 @@ public class OAuth2Application implements Serializable { } /** - * Get redirectUris + * The list of allowed redirect URIs * * @return redirectUris */ - @Schema(description = "") + @Schema(description = "The list of allowed redirect URIs") public List getRedirectUris() { return redirectUris; } @@ -195,11 +195,11 @@ public class OAuth2Application implements Serializable { } /** - * Get skipSecondaryAuthorization + * Whether to skip secondary authorization * * @return skipSecondaryAuthorization */ - @Schema(description = "") + @Schema(description = "Whether to skip secondary authorization") public Boolean isSkipSecondaryAuthorization() { return skipSecondaryAuthorization; } 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 12ac84c..593a9f3 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/Organization.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/Organization.java @@ -61,11 +61,11 @@ public class Organization implements Serializable { } /** - * Get avatarUrl + * The URL of the organization's avatar * * @return avatarUrl */ - @Schema(description = "") + @Schema(description = "The URL of the organization's avatar") public String getAvatarUrl() { return avatarUrl; } @@ -80,11 +80,11 @@ public class Organization implements Serializable { } /** - * Get description + * The description of the organization * * @return description */ - @Schema(description = "") + @Schema(description = "The description of the organization") public String getDescription() { return description; } @@ -99,11 +99,11 @@ public class Organization implements Serializable { } /** - * Get email + * The email address of the organization * * @return email */ - @Schema(description = "") + @Schema(description = "The email address of the organization") public String getEmail() { return email; } @@ -118,11 +118,11 @@ public class Organization implements Serializable { } /** - * Get fullName + * The full display name of the organization * * @return fullName */ - @Schema(description = "") + @Schema(description = "The full display name of the organization") public String getFullName() { return fullName; } @@ -137,11 +137,11 @@ public class Organization implements Serializable { } /** - * Get id + * The unique identifier of the organization * * @return id */ - @Schema(description = "") + @Schema(description = "The unique identifier of the organization") public Long getId() { return id; } @@ -156,11 +156,11 @@ public class Organization implements Serializable { } /** - * Get location + * The location of the organization * * @return location */ - @Schema(description = "") + @Schema(description = "The location of the organization") public String getLocation() { return location; } @@ -175,11 +175,11 @@ public class Organization implements Serializable { } /** - * Get name + * The name of the organization * * @return name */ - @Schema(description = "") + @Schema(description = "The name of the organization") public String getName() { return name; } @@ -194,11 +194,11 @@ public class Organization implements Serializable { } /** - * Get repoAdminChangeTeamAccess + * Whether repository administrators can change team access * * @return repoAdminChangeTeamAccess */ - @Schema(description = "") + @Schema(description = "Whether repository administrators can change team access") public Boolean isRepoAdminChangeTeamAccess() { return repoAdminChangeTeamAccess; } @@ -232,11 +232,11 @@ public class Organization implements Serializable { } /** - * Get visibility + * The visibility level of the organization (public, limited, private) * * @return visibility */ - @Schema(description = "") + @Schema(description = "The visibility level of the organization (public, limited, private)") public String getVisibility() { return visibility; } @@ -251,11 +251,11 @@ public class Organization implements Serializable { } /** - * Get website + * The website URL of the organization * * @return website */ - @Schema(description = "") + @Schema(description = "The website URL of the organization") public String getWebsite() { return website; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/OrganizationPermissions.java b/src/main/java/org/gitnex/tea4j/v2/models/OrganizationPermissions.java index f9a9c99..4a4ad94 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/OrganizationPermissions.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/OrganizationPermissions.java @@ -43,11 +43,11 @@ public class OrganizationPermissions implements Serializable { } /** - * Get canCreateRepository + * Whether the user can create repositories in the organization * * @return canCreateRepository */ - @Schema(description = "") + @Schema(description = "Whether the user can create repositories in the organization") public Boolean isCanCreateRepository() { return canCreateRepository; } @@ -62,11 +62,11 @@ public class OrganizationPermissions implements Serializable { } /** - * Get canRead + * Whether the user can read the organization * * @return canRead */ - @Schema(description = "") + @Schema(description = "Whether the user can read the organization") public Boolean isCanRead() { return canRead; } @@ -81,11 +81,11 @@ public class OrganizationPermissions implements Serializable { } /** - * Get canWrite + * Whether the user can write to the organization * * @return canWrite */ - @Schema(description = "") + @Schema(description = "Whether the user can write to the organization") public Boolean isCanWrite() { return canWrite; } @@ -100,11 +100,11 @@ public class OrganizationPermissions implements Serializable { } /** - * Get isAdmin + * Whether the user is an admin of the organization * * @return isAdmin */ - @Schema(description = "") + @Schema(description = "Whether the user is an admin of the organization") public Boolean isIsAdmin() { return isAdmin; } @@ -119,11 +119,11 @@ public class OrganizationPermissions implements Serializable { } /** - * Get isOwner + * Whether the user is an owner of the organization * * @return isOwner */ - @Schema(description = "") + @Schema(description = "Whether the user is an owner of the organization") public Boolean isIsOwner() { return isOwner; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/PRBranchInfo.java b/src/main/java/org/gitnex/tea4j/v2/models/PRBranchInfo.java index 5c4a4be..47f971e 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/PRBranchInfo.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/PRBranchInfo.java @@ -43,11 +43,11 @@ public class PRBranchInfo implements Serializable { } /** - * Get label + * The display name of the branch * * @return label */ - @Schema(description = "") + @Schema(description = "The display name of the branch") public String getLabel() { return label; } @@ -62,11 +62,11 @@ public class PRBranchInfo implements Serializable { } /** - * Get ref + * The git reference of the branch * * @return ref */ - @Schema(description = "") + @Schema(description = "The git reference of the branch") public String getRef() { return ref; } @@ -100,11 +100,11 @@ public class PRBranchInfo implements Serializable { } /** - * Get repoId + * The unique identifier of the repository * * @return repoId */ - @Schema(description = "") + @Schema(description = "The unique identifier of the repository") public Long getRepoId() { return repoId; } @@ -119,11 +119,11 @@ public class PRBranchInfo implements Serializable { } /** - * Get sha + * The commit SHA of the branch head * * @return sha */ - @Schema(description = "") + @Schema(description = "The commit SHA of the branch head") public String getSha() { return sha; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/PackageFile.java b/src/main/java/org/gitnex/tea4j/v2/models/PackageFile.java index a7efc49..36a2a2f 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/PackageFile.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/PackageFile.java @@ -49,11 +49,11 @@ public class PackageFile implements Serializable { } /** - * Get id + * The unique identifier of the package file * * @return id */ - @Schema(description = "") + @Schema(description = "The unique identifier of the package file") public Long getId() { return id; } @@ -68,11 +68,11 @@ public class PackageFile implements Serializable { } /** - * Get md5 + * The MD5 hash of the package file * * @return md5 */ - @Schema(description = "") + @Schema(description = "The MD5 hash of the package file") public String getMd5() { return md5; } @@ -87,11 +87,11 @@ public class PackageFile implements Serializable { } /** - * Get name + * The name of the package file * * @return name */ - @Schema(description = "") + @Schema(description = "The name of the package file") public String getName() { return name; } @@ -106,11 +106,11 @@ public class PackageFile implements Serializable { } /** - * Get sha1 + * The SHA1 hash of the package file * * @return sha1 */ - @Schema(description = "") + @Schema(description = "The SHA1 hash of the package file") public String getSha1() { return sha1; } @@ -125,11 +125,11 @@ public class PackageFile implements Serializable { } /** - * Get sha256 + * The SHA256 hash of the package file * * @return sha256 */ - @Schema(description = "") + @Schema(description = "The SHA256 hash of the package file") public String getSha256() { return sha256; } @@ -144,11 +144,11 @@ public class PackageFile implements Serializable { } /** - * Get sha512 + * The SHA512 hash of the package file * * @return sha512 */ - @Schema(description = "") + @Schema(description = "The SHA512 hash of the package file") public String getSha512() { return sha512; } @@ -163,11 +163,11 @@ public class PackageFile implements Serializable { } /** - * Get size + * The size of the package file in bytes * * @return size */ - @Schema(description = "") + @Schema(description = "The size of the package file in bytes") public Long getSize() { return size; } 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 94d3b96..fda81b5 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/PayloadCommit.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/PayloadCommit.java @@ -69,11 +69,11 @@ public class PayloadCommit implements Serializable { } /** - * Get added + * List of files added in this commit * * @return added */ - @Schema(description = "") + @Schema(description = "List of files added in this commit") public List getAdded() { return added; } @@ -145,11 +145,11 @@ public class PayloadCommit implements Serializable { } /** - * Get message + * The commit message * * @return message */ - @Schema(description = "") + @Schema(description = "The commit message") public String getMessage() { return message; } @@ -172,11 +172,11 @@ public class PayloadCommit implements Serializable { } /** - * Get modified + * List of files modified in this commit * * @return modified */ - @Schema(description = "") + @Schema(description = "List of files modified in this commit") public List getModified() { return modified; } @@ -199,11 +199,11 @@ public class PayloadCommit implements Serializable { } /** - * Get removed + * List of files removed in this commit * * @return removed */ - @Schema(description = "") + @Schema(description = "List of files removed in this commit") public List getRemoved() { return removed; } @@ -237,11 +237,11 @@ public class PayloadCommit implements Serializable { } /** - * Get url + * The URL to view this commit * * @return url */ - @Schema(description = "") + @Schema(description = "The URL to view this commit") public String getUrl() { return url; } diff --git a/src/main/java/org/gitnex/tea4j/v2/models/PayloadCommitVerification.java b/src/main/java/org/gitnex/tea4j/v2/models/PayloadCommitVerification.java index 0586446..7097c68 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/PayloadCommitVerification.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/PayloadCommitVerification.java @@ -43,11 +43,11 @@ public class PayloadCommitVerification implements Serializable { } /** - * Get payload + * The signed payload content * * @return payload */ - @Schema(description = "") + @Schema(description = "The signed payload content") public String getPayload() { return payload; } @@ -62,11 +62,11 @@ public class PayloadCommitVerification implements Serializable { } /** - * Get reason + * The reason for the verification status * * @return reason */ - @Schema(description = "") + @Schema(description = "The reason for the verification status") public String getReason() { return reason; } @@ -81,11 +81,11 @@ public class PayloadCommitVerification implements Serializable { } /** - * Get signature + * The GPG signature of the commit * * @return signature */ - @Schema(description = "") + @Schema(description = "The GPG signature of the commit") public String getSignature() { return signature; } @@ -119,11 +119,11 @@ public class PayloadCommitVerification implements Serializable { } /** - * Get verified + * Whether the commit signature is verified * * @return verified */ - @Schema(description = "") + @Schema(description = "Whether the commit signature is verified") public Boolean isVerified() { return verified; } 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 4b15110..ab8155d 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/PublicKey.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/PublicKey.java @@ -78,11 +78,11 @@ public class PublicKey implements Serializable { } /** - * Get fingerprint + * Fingerprint is the key's fingerprint * * @return fingerprint */ - @Schema(description = "") + @Schema(description = "Fingerprint is the key's fingerprint") public String getFingerprint() { return fingerprint; } @@ -97,11 +97,11 @@ public class PublicKey implements Serializable { } /** - * Get id + * ID is the unique identifier for the public key * * @return id */ - @Schema(description = "") + @Schema(description = "ID is the unique identifier for the public key") public Long getId() { return id; } @@ -116,11 +116,11 @@ public class PublicKey implements Serializable { } /** - * Get key + * Key contains the actual SSH public key content * * @return key */ - @Schema(description = "") + @Schema(description = "Key contains the actual SSH public key content") public String getKey() { return key; } @@ -135,11 +135,11 @@ public class PublicKey implements Serializable { } /** - * Get keyType + * KeyType indicates the type of the SSH key * * @return keyType */ - @Schema(description = "") + @Schema(description = "KeyType indicates the type of the SSH key") public String getKeyType() { return keyType; } @@ -154,11 +154,11 @@ public class PublicKey implements Serializable { } /** - * Get lastUsedAt + * Updated is the time when the key was last used * * @return lastUsedAt */ - @Schema(description = "") + @Schema(description = "Updated is the time when the key was last used") public Date getLastUsedAt() { return lastUsedAt; } @@ -173,11 +173,11 @@ public class PublicKey implements Serializable { } /** - * Get readOnly + * ReadOnly indicates if the key has read-only access * * @return readOnly */ - @Schema(description = "") + @Schema(description = "ReadOnly indicates if the key has read-only access") public Boolean isReadOnly() { return readOnly; } @@ -192,11 +192,11 @@ public class PublicKey implements Serializable { } /** - * Get title + * Title is the human-readable name for the key * * @return title */ - @Schema(description = "") + @Schema(description = "Title is the human-readable name for the key") public String getTitle() { return title; } @@ -211,11 +211,11 @@ public class PublicKey implements Serializable { } /** - * Get url + * URL is the API URL for this key * * @return url */ - @Schema(description = "") + @Schema(description = "URL is the API URL for this key") public String getUrl() { return url; } 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 434e6f4..237246b 100644 --- a/src/main/java/org/gitnex/tea4j/v2/models/PullRequest.java +++ b/src/main/java/org/gitnex/tea4j/v2/models/PullRequest.java @@ -142,11 +142,11 @@ public class PullRequest implements Serializable { } /** - * Get additions + * The number of lines added in the pull request * * @return additions */ - @Schema(description = "") + @Schema(description = "The number of lines added in the pull request") public Long getAdditions() { return additions; } @@ -161,11 +161,11 @@ public class PullRequest implements Serializable { } /** - * Get allowMaintainerEdit + * Whether maintainers can edit the pull request * * @return allowMaintainerEdit */ - @Schema(description = "") + @Schema(description = "Whether maintainers can edit the pull request") public Boolean isAllowMaintainerEdit() { return allowMaintainerEdit; } @@ -207,11 +207,11 @@ public class PullRequest implements Serializable { } /** - * Get assignees + * The list of users assigned to the pull request * * @return assignees */ - @Schema(description = "") + @Schema(description = "The list of users assigned to the pull request") public List getAssignees() { return assignees; } @@ -245,11 +245,11 @@ public class PullRequest implements Serializable { } /** - * Get body + * The description body of the pull request * * @return body */ - @Schema(description = "") + @Schema(description = "The description body of the pull request") public String getBody() { return body; } @@ -264,11 +264,11 @@ public class PullRequest implements Serializable { } /** - * Get changedFiles + * The number of files changed in the pull request * * @return changedFiles */ - @Schema(description = "") + @Schema(description = "The number of files changed in the pull request") public Long getChangedFiles() { return changedFiles; } @@ -302,11 +302,11 @@ public class PullRequest implements Serializable { } /** - * Get comments + * The number of comments on the pull request * * @return comments */ - @Schema(description = "") + @Schema(description = "The number of comments on the pull request") public Long getComments() { return comments; } @@ -340,11 +340,11 @@ public class PullRequest implements Serializable { } /** - * Get deletions + * The number of lines deleted in the pull request * * @return deletions */ - @Schema(description = "") + @Schema(description = "The number of lines deleted in the pull request") public Long getDeletions() { return deletions; } @@ -359,11 +359,11 @@ public class PullRequest implements Serializable { } /** - * Get diffUrl + * The URL to download the diff patch * * @return diffUrl */ - @Schema(description = "") + @Schema(description = "The URL to download the diff patch") public String getDiffUrl() { return diffUrl; } @@ -378,11 +378,11 @@ public class PullRequest implements Serializable { } /** - * Get draft + * Whether the pull request is a draft * * @return draft */ - @Schema(description = "") + @Schema(description = "Whether the pull request is a draft") public Boolean isDraft() { return draft; } @@ -435,11 +435,11 @@ public class PullRequest implements Serializable { } /** - * Get htmlUrl + * The HTML URL to view the pull request * * @return htmlUrl */ - @Schema(description = "") + @Schema(description = "The HTML URL to view the pull request") public String getHtmlUrl() { return htmlUrl; } @@ -454,11 +454,11 @@ public class PullRequest implements Serializable { } /** - * Get id + * The unique identifier of the pull request * * @return id */ - @Schema(description = "") + @Schema(description = "The unique identifier of the pull request") public Long getId() { return id; } @@ -473,11 +473,11 @@ public class PullRequest implements Serializable { } /** - * Get isLocked + * Whether the pull request conversation is locked * * @return isLocked */ - @Schema(description = "") + @Schema(description = "Whether the pull request conversation is locked") public Boolean isIsLocked() { return isLocked; } @@ -500,11 +500,11 @@ public class PullRequest implements Serializable { } /** - * Get labels + * The labels attached to the pull request * * @return labels */ - @Schema(description = "") + @Schema(description = "The labels attached to the pull request") public List