core/go-forge
8
0
Fork 0
Code Issues 4 Pull requests Projects Releases Packages Wiki Activity Actions

docs(specs): add types RFC

Browse source
This commit is contained in:
Virgil 2026-03-27 21:51:01 +00:00
parent d73e3148c5
commit 565e807fb2
1 changed files with 245 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

245
specs/types/RFC.md Normal file
View file

@ -0,0 +1,245 @@
# types
**Import:** `dappco.re/go/core/forge/types`
**Files:** 36
## Types
| Kind | Name | Signature | Description |
| --- | --- | --- | --- |
| struct | APIError | `type APIError struct` | APIError is an api error with a message |
| struct | APIForbiddenError | `type APIForbiddenError struct` | No doc comment. |
| struct | APIInvalidTopicsError | `type APIInvalidTopicsError struct` | No doc comment. |
| struct | APINotFound | `type APINotFound struct` | No doc comment. |
| struct | APIRepoArchivedError | `type APIRepoArchivedError struct` | No doc comment. |
| struct | APIUnauthorizedError | `type APIUnauthorizedError struct` | No doc comment. |
| struct | APIValidationError | `type APIValidationError struct` | No doc comment. |
| struct | AccessToken | `type AccessToken struct` | No doc comment. |
| struct | ActionTask | `type ActionTask struct` | ActionTask represents a ActionTask |
| struct | ActionTaskResponse | `type ActionTaskResponse struct` | ActionTaskResponse returns a ActionTask |
| struct | ActionVariable | `type ActionVariable struct` | ActionVariable return value of the query API |
| struct | Activity | `type Activity struct` | No doc comment. |
| struct | ActivityPub | `type ActivityPub struct` | ActivityPub type |
| struct | AddCollaboratorOption | `type AddCollaboratorOption struct` | AddCollaboratorOption options when adding a user as a collaborator of a repository |
| struct | AddTimeOption | `type AddTimeOption struct` | AddTimeOption options for adding time to an issue |
| struct | AnnotatedTag | `type AnnotatedTag struct` | AnnotatedTag represents an annotated tag |
| struct | AnnotatedTagObject | `type AnnotatedTagObject struct` | AnnotatedTagObject contains meta information of the tag object |
| struct | Attachment | `type Attachment struct` | Attachment a generic attachment |
| struct | BlockedUser | `type BlockedUser struct` | No doc comment. |
| struct | Branch | `type Branch struct` | Branch represents a repository branch |
| struct | BranchProtection | `type BranchProtection struct` | BranchProtection represents a branch protection for a repository |
| struct | ChangeFileOperation | `type ChangeFileOperation struct` | ChangeFileOperation for creating, updating or deleting a file |
| struct | ChangeFilesOptions | `type ChangeFilesOptions struct` | ChangeFilesOptions options for creating, updating or deleting multiple files Note: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used) |
| struct | ChangedFile | `type ChangedFile struct` | ChangedFile store information about files affected by the pull request |
| struct | CombinedStatus | `type CombinedStatus struct` | CombinedStatus holds the combined state of several statuses for a single commit |
| struct | Comment | `type Comment struct` | Comment represents a comment on a commit or issue |
| struct | Commit | `type Commit struct` | No doc comment. |
| struct | CommitAffectedFiles | `type CommitAffectedFiles struct` | CommitAffectedFiles store information about files affected by the commit |
| struct | CommitDateOptions | `type CommitDateOptions struct` | CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE |
| struct | CommitMeta | `type CommitMeta struct` | No doc comment. |
| struct | CommitStats | `type CommitStats struct` | CommitStats is statistics for a RepoCommit |
| struct | CommitStatus | `type CommitStatus struct` | CommitStatus holds a single status of a single Commit |
| struct | CommitStatusState | `type CommitStatusState struct{}` | CommitStatusState holds the state of a CommitStatus It can be "pending", "success", "error" and "failure" CommitStatusState has no fields in the swagger spec. |
| struct | CommitUser | `type CommitUser struct` | No doc comment. |
| struct | Compare | `type Compare struct` | No doc comment. |
| struct | ContentsResponse | `type ContentsResponse struct` | ContentsResponse contains information about a repo's entry's (dir, file, symlink, submodule) metadata and content |
| struct | CreateAccessTokenOption | `type CreateAccessTokenOption struct` | CreateAccessTokenOption options when create access token |
| struct | CreateBranchProtectionOption | `type CreateBranchProtectionOption struct` | CreateBranchProtectionOption options for creating a branch protection |
| struct | CreateBranchRepoOption | `type CreateBranchRepoOption struct` | CreateBranchRepoOption options when creating a branch in a repository |
| struct | CreateEmailOption | `type CreateEmailOption struct` | CreateEmailOption options when creating email addresses |
| struct | CreateFileOptions | `type CreateFileOptions struct` | CreateFileOptions options for creating files Note: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used) |
| struct | CreateForkOption | `type CreateForkOption struct` | CreateForkOption options for creating a fork |
| struct | CreateGPGKeyOption | `type CreateGPGKeyOption struct` | CreateGPGKeyOption options create user GPG key |
| struct | CreateHookOption | `type CreateHookOption struct` | CreateHookOption options when create a hook |
| struct | CreateHookOptionConfig | `type CreateHookOptionConfig struct{}` | CreateHookOptionConfig has all config options in it required are "content_type" and "url" Required CreateHookOptionConfig has no fields in the swagger spec. |
| struct | CreateIssueCommentOption | `type CreateIssueCommentOption struct` | CreateIssueCommentOption options for creating a comment on an issue |
| struct | CreateIssueOption | `type CreateIssueOption struct` | CreateIssueOption options to create one issue |
| struct | CreateKeyOption | `type CreateKeyOption struct` | CreateKeyOption options when creating a key |
| struct | CreateLabelOption | `type CreateLabelOption struct` | CreateLabelOption options for creating a label |
| struct | CreateMilestoneOption | `type CreateMilestoneOption struct` | CreateMilestoneOption options for creating a milestone |
| struct | CreateOAuth2ApplicationOptions | `type CreateOAuth2ApplicationOptions struct` | CreateOAuth2ApplicationOptions holds options to create an oauth2 application |
| struct | CreateOrUpdateSecretOption | `type CreateOrUpdateSecretOption struct` | CreateOrUpdateSecretOption options when creating or updating secret |
| struct | CreateOrgOption | `type CreateOrgOption struct` | CreateOrgOption options for creating an organization |
| struct | CreatePullRequestOption | `type CreatePullRequestOption struct` | CreatePullRequestOption options when creating a pull request |
| struct | CreatePullReviewComment | `type CreatePullReviewComment struct` | CreatePullReviewComment represent a review comment for creation api |
| struct | CreatePullReviewCommentOptions | `type CreatePullReviewCommentOptions struct{}` | CreatePullReviewCommentOptions are options to create a pull review comment CreatePullReviewCommentOptions has no fields in the swagger spec. |
| struct | CreatePullReviewOptions | `type CreatePullReviewOptions struct` | CreatePullReviewOptions are options to create a pull review |
| struct | CreatePushMirrorOption | `type CreatePushMirrorOption struct` | No doc comment. |
| struct | CreateQuotaGroupOptions | `type CreateQuotaGroupOptions struct` | CreateQutaGroupOptions represents the options for creating a quota group |
| struct | CreateQuotaRuleOptions | `type CreateQuotaRuleOptions struct` | CreateQuotaRuleOptions represents the options for creating a quota rule |
| struct | CreateReleaseOption | `type CreateReleaseOption struct` | CreateReleaseOption options when creating a release |
| struct | CreateRepoOption | `type CreateRepoOption struct` | CreateRepoOption options when creating repository |
| struct | CreateStatusOption | `type CreateStatusOption struct` | CreateStatusOption holds the information needed to create a new CommitStatus for a Commit |
| struct | CreateTagOption | `type CreateTagOption struct` | CreateTagOption options when creating a tag |
| struct | CreateTagProtectionOption | `type CreateTagProtectionOption struct` | CreateTagProtectionOption options for creating a tag protection |
| struct | CreateTeamOption | `type CreateTeamOption struct` | CreateTeamOption options for creating a team |
| struct | CreateUserOption | `type CreateUserOption struct` | CreateUserOption create user options |
| struct | CreateVariableOption | `type CreateVariableOption struct` | CreateVariableOption the option when creating variable |
| struct | CreateWikiPageOptions | `type CreateWikiPageOptions struct` | CreateWikiPageOptions form for creating wiki |
| struct | Cron | `type Cron struct` | Cron represents a Cron task |
| struct | DeleteEmailOption | `type DeleteEmailOption struct` | DeleteEmailOption options when deleting email addresses |
| struct | DeleteFileOptions | `type DeleteFileOptions struct` | DeleteFileOptions options for deleting files (used for other File structs below) Note: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used) |
| struct | DeleteLabelsOption | `type DeleteLabelsOption struct` | DeleteLabelOption options for deleting a label |
| struct | DeployKey | `type DeployKey struct` | DeployKey a deploy key |
| struct | DismissPullReviewOptions | `type DismissPullReviewOptions struct` | DismissPullReviewOptions are options to dismiss a pull review |
| struct | DispatchWorkflowOption | `type DispatchWorkflowOption struct` | DispatchWorkflowOption options when dispatching a workflow |
| struct | EditAttachmentOptions | `type EditAttachmentOptions struct` | EditAttachmentOptions options for editing attachments |
| struct | EditBranchProtectionOption | `type EditBranchProtectionOption struct` | EditBranchProtectionOption options for editing a branch protection |
| struct | EditDeadlineOption | `type EditDeadlineOption struct` | EditDeadlineOption options for creating a deadline |
| struct | EditGitHookOption | `type EditGitHookOption struct` | EditGitHookOption options when modifying one Git hook |
| struct | EditHookOption | `type EditHookOption struct` | EditHookOption options when modify one hook |
| struct | EditIssueCommentOption | `type EditIssueCommentOption struct` | EditIssueCommentOption options for editing a comment |
| struct | EditIssueOption | `type EditIssueOption struct` | EditIssueOption options for editing an issue |
| struct | EditLabelOption | `type EditLabelOption struct` | EditLabelOption options for editing a label |
| struct | EditMilestoneOption | `type EditMilestoneOption struct` | EditMilestoneOption options for editing a milestone |
| struct | EditOrgOption | `type EditOrgOption struct` | EditOrgOption options for editing an organization |
| struct | EditPullRequestOption | `type EditPullRequestOption struct` | EditPullRequestOption options when modify pull request |
| struct | EditQuotaRuleOptions | `type EditQuotaRuleOptions struct` | EditQuotaRuleOptions represents the options for editing a quota rule |
| struct | EditReactionOption | `type EditReactionOption struct` | EditReactionOption contain the reaction type |
| struct | EditReleaseOption | `type EditReleaseOption struct` | EditReleaseOption options when editing a release |
| struct | EditRepoOption | `type EditRepoOption struct` | EditRepoOption options when editing a repository's properties |
| struct | EditTagProtectionOption | `type EditTagProtectionOption struct` | EditTagProtectionOption options for editing a tag protection |
| struct | EditTeamOption | `type EditTeamOption struct` | EditTeamOption options for editing a team |
| struct | EditUserOption | `type EditUserOption struct` | EditUserOption edit user options |
| struct | Email | `type Email struct` | Email an email address belonging to a user |
| struct | ExternalTracker | `type ExternalTracker struct` | ExternalTracker represents settings for external tracker |
| struct | ExternalWiki | `type ExternalWiki struct` | ExternalWiki represents setting for external wiki |
| struct | FileCommitResponse | `type FileCommitResponse struct` | No doc comment. |
| struct | FileDeleteResponse | `type FileDeleteResponse struct` | FileDeleteResponse contains information about a repo's file that was deleted |
| struct | FileLinksResponse | `type FileLinksResponse struct` | FileLinksResponse contains the links for a repo's file |
| struct | FileResponse | `type FileResponse struct` | FileResponse contains information about a repo's file |
| struct | FilesResponse | `type FilesResponse struct` | FilesResponse contains information about multiple files from a repo |
| struct | ForgeLike | `type ForgeLike struct{}` | ForgeLike activity data type ForgeLike has no fields in the swagger spec. |
| struct | GPGKey | `type GPGKey struct` | GPGKey a user GPG key to sign commit and tag in repository |
| struct | GPGKeyEmail | `type GPGKeyEmail struct` | GPGKeyEmail an email attached to a GPGKey |
| struct | GeneralAPISettings | `type GeneralAPISettings struct` | GeneralAPISettings contains global api settings exposed by it |
| struct | GeneralAttachmentSettings | `type GeneralAttachmentSettings struct` | GeneralAttachmentSettings contains global Attachment settings exposed by API |
| struct | GeneralRepoSettings | `type GeneralRepoSettings struct` | GeneralRepoSettings contains global repository settings exposed by API |
| struct | GeneralUISettings | `type GeneralUISettings struct` | GeneralUISettings contains global ui settings exposed by API |
| struct | GenerateRepoOption | `type GenerateRepoOption struct` | GenerateRepoOption options when creating repository using a template |
| struct | GitBlobResponse | `type GitBlobResponse struct` | GitBlobResponse represents a git blob |
| struct | GitEntry | `type GitEntry struct` | GitEntry represents a git tree |
| struct | GitHook | `type GitHook struct` | GitHook represents a Git repository hook |
| struct | GitObject | `type GitObject struct` | No doc comment. |
| struct | GitTreeResponse | `type GitTreeResponse struct` | GitTreeResponse returns a git tree |
| struct | GitignoreTemplateInfo | `type GitignoreTemplateInfo struct` | GitignoreTemplateInfo name and text of a gitignore template |
| struct | Hook | `type Hook struct` | Hook a hook is a web hook when one repository changed |
| struct | Identity | `type Identity struct` | Identity for a person's identity like an author or committer |
| struct | InternalTracker | `type InternalTracker struct` | InternalTracker represents settings for internal tracker |
| struct | Issue | `type Issue struct` | Issue represents an issue in a repository |
| struct | IssueConfig | `type IssueConfig struct` | No doc comment. |
| struct | IssueConfigContactLink | `type IssueConfigContactLink struct` | No doc comment. |
| struct | IssueConfigValidation | `type IssueConfigValidation struct` | No doc comment. |
| struct | IssueDeadline | `type IssueDeadline struct` | IssueDeadline represents an issue deadline |
| struct | IssueFormField | `type IssueFormField struct` | IssueFormField represents a form field |
| struct | IssueFormFieldType | `type IssueFormFieldType struct{}` | IssueFormFieldType has no fields in the swagger spec. |
| struct | IssueFormFieldVisible | `type IssueFormFieldVisible struct{}` | IssueFormFieldVisible defines issue form field visible IssueFormFieldVisible has no fields in the swagger spec. |
| struct | IssueLabelsOption | `type IssueLabelsOption struct` | IssueLabelsOption a collection of labels |
| struct | IssueMeta | `type IssueMeta struct` | IssueMeta basic issue information |
| struct | IssueTemplate | `type IssueTemplate struct` | IssueTemplate represents an issue template for a repository |
| struct | IssueTemplateLabels | `type IssueTemplateLabels struct{}` | IssueTemplateLabels has no fields in the swagger spec. |
| struct | Label | `type Label struct` | Label a label to an issue or a pr |
| struct | LabelTemplate | `type LabelTemplate struct` | LabelTemplate info of a Label template |
| struct | LicenseTemplateInfo | `type LicenseTemplateInfo struct` | LicensesInfo contains information about a License |
| struct | LicensesTemplateListEntry | `type LicensesTemplateListEntry struct` | LicensesListEntry is used for the API |
| struct | MarkdownOption | `type MarkdownOption struct` | MarkdownOption markdown options |
| struct | MarkupOption | `type MarkupOption struct` | MarkupOption markup options |
| struct | MergePullRequestOption | `type MergePullRequestOption struct` | MergePullRequestForm form for merging Pull Request |
| struct | MigrateRepoOptions | `type MigrateRepoOptions struct` | MigrateRepoOptions options for migrating repository's this is used to interact with api v1 |
| struct | Milestone | `type Milestone struct` | Milestone milestone is a collection of issues on one repository |
| struct | NewIssuePinsAllowed | `type NewIssuePinsAllowed struct` | NewIssuePinsAllowed represents an API response that says if new Issue Pins are allowed |
| struct | NodeInfo | `type NodeInfo struct` | NodeInfo contains standardized way of exposing metadata about a server running one of the distributed social networks |
| struct | NodeInfoServices | `type NodeInfoServices struct` | NodeInfoServices contains the third party sites this server can connect to via their application API |
| struct | NodeInfoSoftware | `type NodeInfoSoftware struct` | NodeInfoSoftware contains Metadata about server software in use |
| struct | NodeInfoUsage | `type NodeInfoUsage struct` | NodeInfoUsage contains usage statistics for this server |
| struct | NodeInfoUsageUsers | `type NodeInfoUsageUsers struct` | NodeInfoUsageUsers contains statistics about the users of this server |
| struct | Note | `type Note struct` | Note contains information related to a git note |
| struct | NoteOptions | `type NoteOptions struct` | No doc comment. |
| struct | NotificationCount | `type NotificationCount struct` | NotificationCount number of unread notifications |
| struct | NotificationSubject | `type NotificationSubject struct` | NotificationSubject contains the notification subject (Issue/Pull/Commit) |
| struct | NotificationThread | `type NotificationThread struct` | NotificationThread expose Notification on API |
| struct | NotifySubjectType | `type NotifySubjectType struct{}` | NotifySubjectType represent type of notification subject NotifySubjectType has no fields in the swagger spec. |
| struct | OAuth2Application | `type OAuth2Application struct` | No doc comment. |
| struct | Organization | `type Organization struct` | Organization represents an organization |
| struct | OrganizationPermissions | `type OrganizationPermissions struct` | OrganizationPermissions list different users permissions on an organization |
| struct | PRBranchInfo | `type PRBranchInfo struct` | PRBranchInfo information about a branch |
| struct | Package | `type Package struct` | Package represents a package |
| struct | PackageFile | `type PackageFile struct` | PackageFile represents a package file |
| struct | PayloadCommit | `type PayloadCommit struct` | PayloadCommit represents a commit |
| struct | PayloadCommitVerification | `type PayloadCommitVerification struct` | PayloadCommitVerification represents the GPG verification of a commit |
| struct | PayloadUser | `type PayloadUser struct` | PayloadUser represents the author or committer of a commit |
| struct | Permission | `type Permission struct` | Permission represents a set of permissions |
| struct | PublicKey | `type PublicKey struct` | PublicKey publickey is a user key to push code to repository |
| struct | PullRequest | `type PullRequest struct` | PullRequest represents a pull request |
| struct | PullRequestMeta | `type PullRequestMeta struct` | PullRequestMeta PR info if an issue is a PR |
| struct | PullReview | `type PullReview struct` | PullReview represents a pull request review |
| struct | PullReviewComment | `type PullReviewComment struct` | PullReviewComment represents a comment on a pull request review |
| struct | PullReviewRequestOptions | `type PullReviewRequestOptions struct` | PullReviewRequestOptions are options to add or remove pull review requests |
| struct | PushMirror | `type PushMirror struct` | PushMirror represents information of a push mirror |
| struct | QuotaGroup | `type QuotaGroup struct` | QuotaGroup represents a quota group |
| struct | QuotaGroupList | `type QuotaGroupList struct{}` | QuotaGroupList represents a list of quota groups QuotaGroupList has no fields in the swagger spec. |
| struct | QuotaInfo | `type QuotaInfo struct` | QuotaInfo represents information about a user's quota |
| struct | QuotaRuleInfo | `type QuotaRuleInfo struct` | QuotaRuleInfo contains information about a quota rule |
| struct | QuotaUsed | `type QuotaUsed struct` | QuotaUsed represents the quota usage of a user |
| struct | QuotaUsedArtifact | `type QuotaUsedArtifact struct` | QuotaUsedArtifact represents an artifact counting towards a user's quota |
| struct | QuotaUsedArtifactList | `type QuotaUsedArtifactList struct{}` | QuotaUsedArtifactList represents a list of artifacts counting towards a user's quota QuotaUsedArtifactList has no fields in the swagger spec. |
| struct | QuotaUsedAttachment | `type QuotaUsedAttachment struct` | QuotaUsedAttachment represents an attachment counting towards a user's quota |
| struct | QuotaUsedAttachmentList | `type QuotaUsedAttachmentList struct{}` | QuotaUsedAttachmentList represents a list of attachment counting towards a user's quota QuotaUsedAttachmentList has no fields in the swagger spec. |
| struct | QuotaUsedPackage | `type QuotaUsedPackage struct` | QuotaUsedPackage represents a package counting towards a user's quota |
| struct | QuotaUsedPackageList | `type QuotaUsedPackageList struct{}` | QuotaUsedPackageList represents a list of packages counting towards a user's quota QuotaUsedPackageList has no fields in the swagger spec. |
| struct | QuotaUsedSize | `type QuotaUsedSize struct` | QuotaUsedSize represents the size-based quota usage of a user |
| struct | QuotaUsedSizeAssets | `type QuotaUsedSizeAssets struct` | QuotaUsedSizeAssets represents the size-based asset usage of a user |
| struct | QuotaUsedSizeAssetsAttachments | `type QuotaUsedSizeAssetsAttachments struct` | QuotaUsedSizeAssetsAttachments represents the size-based attachment quota usage of a user |
| struct | QuotaUsedSizeAssetsPackages | `type QuotaUsedSizeAssetsPackages struct` | QuotaUsedSizeAssetsPackages represents the size-based package quota usage of a user |
| struct | QuotaUsedSizeGit | `type QuotaUsedSizeGit struct` | QuotaUsedSizeGit represents the size-based git (lfs) quota usage of a user |
| struct | QuotaUsedSizeRepos | `type QuotaUsedSizeRepos struct` | QuotaUsedSizeRepos represents the size-based repository quota usage of a user |
| struct | Reaction | `type Reaction struct` | Reaction contain one reaction |
| struct | Reference | `type Reference struct` | No doc comment. |
| struct | Release | `type Release struct` | Release represents a repository release |
| struct | RenameUserOption | `type RenameUserOption struct` | RenameUserOption options when renaming a user |
| struct | ReplaceFlagsOption | `type ReplaceFlagsOption struct` | ReplaceFlagsOption options when replacing the flags of a repository |
| struct | RepoCollaboratorPermission | `type RepoCollaboratorPermission struct` | RepoCollaboratorPermission to get repository permission for a collaborator |
| struct | RepoCommit | `type RepoCommit struct` | No doc comment. |
| struct | RepoTopicOptions | `type RepoTopicOptions struct` | RepoTopicOptions a collection of repo topic names |
| struct | RepoTransfer | `type RepoTransfer struct` | RepoTransfer represents a pending repo transfer |
| struct | Repository | `type Repository struct` | Repository represents a repository |
| struct | RepositoryMeta | `type RepositoryMeta struct` | RepositoryMeta basic repository information |
| struct | ReviewStateType | `type ReviewStateType struct{}` | ReviewStateType review state type ReviewStateType has no fields in the swagger spec. |
| struct | SearchResults | `type SearchResults struct` | SearchResults results of a successful search |
| struct | Secret | `type Secret struct` | Secret represents a secret |
| struct | ServerVersion | `type ServerVersion struct` | ServerVersion wraps the version of the server |
| struct | SetUserQuotaGroupsOptions | `type SetUserQuotaGroupsOptions struct` | SetUserQuotaGroupsOptions represents the quota groups of a user |
| type | StateType | `type StateType string` | StateType is the state of an issue or PR: "open", "closed". |
| struct | StopWatch | `type StopWatch struct` | StopWatch represent a running stopwatch |
| struct | SubmitPullReviewOptions | `type SubmitPullReviewOptions struct` | SubmitPullReviewOptions are options to submit a pending pull review |
| struct | Tag | `type Tag struct` | Tag represents a repository tag |
| struct | TagArchiveDownloadCount | `type TagArchiveDownloadCount struct` | TagArchiveDownloadCount counts how many times a archive was downloaded |
| struct | TagProtection | `type TagProtection struct` | TagProtection represents a tag protection |
| struct | Team | `type Team struct` | Team represents a team in an organization |
| type | TimeStamp | `type TimeStamp string` | TimeStamp is a Forgejo timestamp string. |
| struct | TimelineComment | `type TimelineComment struct` | TimelineComment represents a timeline comment (comment of any type) on a commit or issue |
| struct | TopicName | `type TopicName struct` | TopicName a list of repo topic names |
| struct | TopicResponse | `type TopicResponse struct` | TopicResponse for returning topics |
| struct | TrackedTime | `type TrackedTime struct` | TrackedTime worked time for an issue / pr |
| struct | TransferRepoOption | `type TransferRepoOption struct` | TransferRepoOption options when transfer a repository's ownership |
| struct | UpdateBranchRepoOption | `type UpdateBranchRepoOption struct` | UpdateBranchRepoOption options when updating a branch in a repository |
| struct | UpdateFileOptions | `type UpdateFileOptions struct` | UpdateFileOptions options for updating files Note: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used) |
| struct | UpdateRepoAvatarOption | `type UpdateRepoAvatarOption struct` | UpdateRepoAvatarUserOption options when updating the repo avatar |
| struct | UpdateUserAvatarOption | `type UpdateUserAvatarOption struct` | UpdateUserAvatarUserOption options when updating the user avatar |
| struct | UpdateVariableOption | `type UpdateVariableOption struct` | UpdateVariableOption the option when updating variable |
| struct | User | `type User struct` | User represents a user |
| struct | UserHeatmapData | `type UserHeatmapData struct` | UserHeatmapData represents the data needed to create a heatmap |
| struct | UserSettings | `type UserSettings struct` | UserSettings represents user settings |
| struct | UserSettingsOptions | `type UserSettingsOptions struct` | UserSettingsOptions represents options to change user settings |
| struct | WatchInfo | `type WatchInfo struct` | WatchInfo represents an API watch status of one repository |
| struct | WikiCommit | `type WikiCommit struct` | WikiCommit page commit/revision |
| struct | WikiCommitList | `type WikiCommitList struct` | WikiCommitList commit/revision list |
| struct | WikiPage | `type WikiPage struct` | WikiPage a wiki page |
| struct | WikiPageMetaData | `type WikiPageMetaData struct` | WikiPageMetaData wiki page meta information |
## Functions
| Kind | Name | Signature | Description |
| --- | --- | --- | --- |
| - | - | - | None. |