Structs§
- APIError
- APIError is an api error with a message
- APIForbidden
Error - APIInternal
Server Error - APIInvalid
Topics Error - APINot
Found - APIRepo
Archived Error - APIUnauthorized
Error - APIValidation
Error - APPerson
Follow Item - Access
Token - Access
Token List Headers - Action
Run - ActionRun represents an action run
- Action
RunJob - ActionRunJob represents a job of a run
- Action
Task - ActionTask represents a ActionTask
- Action
Task Response - ActionTaskResponse returns a ActionTask
- Action
Variable - ActionVariable return value of the query API
- Activity
- Activity
Feeds List Headers - Activity
Pub - ActivityPub type
- AddCollaborator
Option - AddCollaboratorOption options when adding a user as a collaborator of a repository
- AddTime
Option - AddTimeOption options for adding time to an issue
- Admin
Delete User Query - Admin
Search Emails Query - Admin
Search RunJobs Query - Admin
Search Users Query - Admin
Unadopted List Query - Annotated
Tag - AnnotatedTag represents an annotated tag
- Annotated
TagObject - AnnotatedTagObject contains meta information of the tag object
- Attachment
- Attachment a generic attachment
- Blocked
User - Blocked
User List Headers - Branch
- Branch represents a repository branch
- Branch
List Headers - Branch
Protection - BranchProtection represents a branch protection for a repository
- Change
File Operation - ChangeFileOperation for creating, updating or deleting a file
- Change
Files Options - ChangeFilesOptions options for creating, updating or deleting multiple files
- Changed
File - ChangedFile store information about files affected by the pull request
- Changed
File List Headers - Combined
Status - CombinedStatus holds the combined state of several statuses for a single commit
- Combined
Status Headers - Comment
- Comment represents a comment on a commit or issue
- Comment
List Headers - Commit
- Commit
Affected Files - CommitAffectedFiles store information about files affected by the commit
- Commit
Date Options - CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE
- Commit
List Headers - Commit
Meta - Commit
Stats - CommitStats is statistics for a RepoCommit
- Commit
Status - CommitStatus holds a single status of a single Commit
- Commit
Status List Headers - Commit
User - Compare
- Contents
Response - ContentsResponse contains information about a repo’s entry’s (dir, file, symlink, submodule) metadata and content
- Create
Access Token Option - CreateAccessTokenOption options when create access token
- Create
Branch Protection Option - CreateBranchProtectionOption options for creating a branch protection
- Create
Branch Repo Option - CreateBranchRepoOption options when creating a branch in a repository
- Create
Email Option - CreateEmailOption options when creating email addresses
- Create
File Options - CreateFileOptions options for creating files
- Create
Fork Option - CreateForkOption options for creating a fork
- CreateGPG
KeyOption - CreateGPGKeyOption options create user GPG key
- Create
Hook Option - CreateHookOption options when create a hook
- Create
Hook Option Config - CreateHookOptionConfig has all config options in it
- Create
Issue Comment Option - CreateIssueCommentOption options for creating a comment on an issue
- Create
Issue Option - CreateIssueOption options to create one issue
- Create
KeyOption - CreateKeyOption options when creating a key
- Create
Label Option - CreateLabelOption options for creating a label
- Create
Milestone Option - CreateMilestoneOption options for creating a milestone
- CreateO
Auth2 Application Options - CreateOAuth2ApplicationOptions holds options to create an oauth2 application
- Create
OrUpdate Secret Option - CreateOrUpdateSecretOption options when creating or updating secret
- Create
OrgOption - CreateOrgOption options for creating an organization
- Create
Pull Request Option - CreatePullRequestOption options when creating a pull request
- Create
Pull Review Comment - CreatePullReviewComment represent a review comment for creation api
- Create
Pull Review Options - CreatePullReviewOptions are options to create a pull review
- Create
Push Mirror Option - Create
Quota Group Options - CreateQutaGroupOptions represents the options for creating a quota group
- Create
Quota Rule Options - CreateQuotaRuleOptions represents the options for creating a quota rule
- Create
Release Option - CreateReleaseOption options when creating a release
- Create
Repo Option - CreateRepoOption options when creating repository
- Create
Status Option - CreateStatusOption holds the information needed to create a new CommitStatus for a Commit
- Create
TagOption - CreateTagOption options when creating a tag
- Create
TagProtection Option - CreateTagProtectionOption options for creating a tag protection
- Create
Team Option - CreateTeamOption options for creating a team
- Create
User Option - CreateUserOption create user options
- Create
Variable Option - CreateVariableOption the option when creating variable
- Create
Wiki Page Options - CreateWikiPageOptions form for creating wiki
- Cron
- Cron represents a Cron task
- Cron
List Headers - Delete
Email Option - DeleteEmailOption options when deleting email addresses
- Delete
File Options - DeleteFileOptions options for deleting files (used for other File structs below)
- Delete
Labels Option - DeleteLabelOption options for deleting a label
- Deploy
Key - DeployKey a deploy key
- Deploy
KeyList Headers - Dismiss
Pull Review Options - DismissPullReviewOptions are options to dismiss a pull review
- Dispatch
Workflow Option - DispatchWorkflowOption options when dispatching a workflow
- Dispatch
Workflow Run - DispatchWorkflowRun represents a workflow run
- Edit
Attachment Options - EditAttachmentOptions options for editing attachments
- Edit
Branch Protection Option - EditBranchProtectionOption options for editing a branch protection
- Edit
Deadline Option - EditDeadlineOption options for creating a deadline
- Edit
GitHook Option - EditGitHookOption options when modifying one Git hook
- Edit
Hook Option - EditHookOption options when modify one hook
- Edit
Issue Comment Option - EditIssueCommentOption options for editing a comment
- Edit
Issue Option - EditIssueOption options for editing an issue
- Edit
Label Option - EditLabelOption options for editing a label
- Edit
Milestone Option - EditMilestoneOption options for editing a milestone
- Edit
OrgOption - EditOrgOption options for editing an organization
- Edit
Pull Request Option - EditPullRequestOption options when modify pull request
- Edit
Quota Rule Options - EditQuotaRuleOptions represents the options for editing a quota rule
- Edit
Reaction Option - EditReactionOption contain the reaction type
- Edit
Release Option - EditReleaseOption options when editing a release
- Edit
Repo Option - EditRepoOption options when editing a repository’s properties
- Edit
TagProtection Option - EditTagProtectionOption options for editing a tag protection
- Edit
Team Option - EditTeamOption options for editing a team
- Edit
User Option - EditUserOption edit user options
- Email an email address belonging to a user
- External
Tracker - ExternalTracker represents settings for external tracker
- External
Wiki - ExternalWiki represents setting for external wiki
- File
Commit Response - File
Delete Response - FileDeleteResponse contains information about a repo’s file that was deleted
- File
Links Response - FileLinksResponse contains the links for a repo’s file
- File
Response - FileResponse contains information about a repo’s file
- Files
Response - FilesResponse contains information about multiple files from a repo
- Forge
Like - ForgeLike activity data type
- GPGKey
- GPGKey a user GPG key to sign commit and tag in repository
- GPGKey
Email - GPGKeyEmail an email attached to a GPGKey
- GeneralAPI
Settings - GeneralAPISettings contains global api settings exposed by it
- General
Attachment Settings - GeneralAttachmentSettings contains global Attachment settings exposed by API
- General
Repo Settings - GeneralRepoSettings contains global repository settings exposed by API
- GeneralUI
Settings - GeneralUISettings contains global ui settings exposed by API
- Generate
Repo Option - GenerateRepoOption options when creating repository using a template
- GetBlobs
Query - GetTree
Query - GitBlob
- GitBlob represents a git blob
- GitEntry
- GitEntry represents a git tree
- GitHook
- GitHook represents a Git repository hook
- GitHook
List Headers - GitObject
- GitTree
Response - GitTreeResponse returns a git tree
- Gitignore
Template Info - GitignoreTemplateInfo name and text of a gitignore template
- GpgKey
List Headers - Hook
- Hook a hook is a web hook when one repository changed
- Hook
List Headers - Identity
- Identity for a person’s identity like an author or committer
- Internal
Tracker - InternalTracker represents settings for internal tracker
- Issue
- Issue represents an issue in a repository
- Issue
Config - Issue
Config Contact Link - Issue
Config Validation - Issue
Create Issue Attachment Query - Issue
Create Issue Comment Attachment Query - Issue
Deadline - IssueDeadline represents an issue deadline
- Issue
Form Field - IssueFormField represents a form field
- Issue
GetComments AndTimeline Query - Issue
GetComments Query - Issue
GetMilestones List Query - Issue
GetRepo Comments Query - Issue
Labels Option - IssueLabelsOption a collection of labels
- Issue
List Headers - Issue
List Issues Query - Issue
List Labels Query - Issue
Meta - IssueMeta basic issue information
- Issue
Search Issues Query - Issue
Template - IssueTemplate represents an issue template for a repository
- Issue
Tracked Times Query - Label
- Label a label to an issue or a pr
- Label
List Headers - Label
Template - LabelTemplate info of a Label template
- License
Template Info - LicensesInfo contains information about a License
- Licenses
Template List Entry - LicensesListEntry is used for the API
- List
Action RunResponse - ListActionRunResponse return a list of ActionRun
- List
Action Runs Query - List
Packages Query - Markdown
Option - MarkdownOption markdown options
- Markup
Option - MarkupOption markup options
- Merge
Pull Request Option - MergePullRequestForm form for merging Pull Request
- Migrate
Repo Options - MigrateRepoOptions options for migrating repository’s
- Milestone
- Milestone milestone is a collection of issues on one repository
- Milestone
List Headers - NewIssue
Pins Allowed - NewIssuePinsAllowed represents an API response that says if new Issue Pins are allowed
- Node
Info - NodeInfo contains standardized way of exposing metadata about a server running one of the distributed social networks
- Node
Info Services - NodeInfoServices contains the third party sites this server can connect to via their application API
- Node
Info Software - NodeInfoSoftware contains Metadata about server software in use
- Node
Info Usage - NodeInfoUsage contains usage statistics for this server
- Node
Info Usage Users - NodeInfoUsageUsers contains statistics about the users of this server
- Note
- Note contains information related to a git note
- Note
Options - Notification
Count - NotificationCount number of unread notifications
- Notification
Subject - NotificationSubject contains the notification subject (Issue/Pull/Commit)
- Notification
Thread - NotificationThread expose Notification on API
- Notification
Thread List Headers - Notify
GetList Query - Notify
GetRepo List Query - Notify
Read List Query - Notify
Read Repo List Query - Notify
Read Thread Query - OAuth2
Application - OAuth2
Application List Headers - OAuth
Token - OrgCheck
Quota Query - OrgList
Activity Feeds Query - OrgList
Labels Query - OrgList
Team Activity Feeds Query - OrgSearch
RunJobs Query - Organization
- Organization represents an organization
- Organization
List Headers - Organization
Permissions - OrganizationPermissions list different users permissions on an organization
- PRBranch
Info - PRBranchInfo information about a branch
- Package
- Package represents a package
- Package
File - PackageFile represents a package file
- Package
File List Headers - Package
List Headers - Payload
Commit - PayloadCommit represents a commit
- Payload
Commit Verification - PayloadCommitVerification represents the GPG verification of a commit
- Payload
User - PayloadUser represents the author or committer of a commit
- Permission
- Permission represents a set of permissions
- Public
Key - PublicKey publickey is a user key to push code to repository
- Public
KeyList Headers - Pull
Request - PullRequest represents a pull request
- Pull
Request List Headers - Pull
Request Meta - PullRequestMeta PR info if an issue is a PR
- Pull
Review - PullReview represents a pull request review
- Pull
Review Comment - PullReviewComment represents a comment on a pull request review
- Pull
Review List Headers - Pull
Review Request Options - PullReviewRequestOptions are options to add or remove pull review requests
- Push
Mirror - PushMirror represents information of a push mirror
- Push
Mirror List Headers - Quota
Exceeded Headers - Quota
Group - QuotaGroup represents a quota group
- Quota
Group List Headers - Quota
Info - QuotaInfo represents information about a user’s quota
- Quota
Rule Info - QuotaRuleInfo contains information about a quota rule
- Quota
Rule Info List Headers - Quota
Used - QuotaUsed represents the quota usage of a user
- Quota
Used Artifact - QuotaUsedArtifact represents an artifact counting towards a user’s quota
- Quota
Used Artifact List Headers - Quota
Used Attachment - QuotaUsedAttachment represents an attachment counting towards a user’s quota
- Quota
Used Attachment Contained In - Context for the attachment: URLs to the containing object
- Quota
Used Attachment List Headers - Quota
Used Package - QuotaUsedPackage represents a package counting towards a user’s quota
- Quota
Used Package List Headers - Quota
Used Size - QuotaUsedSize represents the size-based quota usage of a user
- Quota
Used Size Assets - QuotaUsedSizeAssets represents the size-based asset usage of a user
- Quota
Used Size Assets Attachments - QuotaUsedSizeAssetsAttachments represents the size-based attachment quota usage of a user
- Quota
Used Size Assets Packages - QuotaUsedSizeAssetsPackages represents the size-based package quota usage of a user
- Quota
Used Size Git - QuotaUsedSizeGit represents the size-based git (lfs) quota usage of a user
- Quota
Used Size Repos - QuotaUsedSizeRepos represents the size-based repository quota usage of a user
- Reaction
- Reaction contain one reaction
- Reaction
List Headers - Reference
- Registration
Token - RegistrationToken is a string used to register a runner with a server
- Release
- Release represents a repository release
- Release
List Headers - Rename
OrgOption - RenameOrgOption options when renaming an organization
- Rename
User Option - RenameUserOption options when renaming a user
- Replace
Flags Option - ReplaceFlagsOption options when replacing the flags of a repository
- Repo
Collaborator Permission - RepoCollaboratorPermission to get repository permission for a collaborator
- Repo
Commit - Repo
Create Release Attachment Query - Repo
Download Pull Diff OrPatch Query - Repo
GetAll Commits Query - Repo
GetContents List Query - Repo
GetContents Query - Repo
GetEditor Config Query - Repo
GetNote Query - Repo
GetPull Request Commits Query - Repo
GetPull Request Files Query - Repo
GetRaw File OrLfs Query - Repo
GetRaw File Query - Repo
GetSingle Commit Query - Repo
List Activity Feeds Query - Repo
List Keys Query - Repo
List Pull Requests Query - Repo
List Releases Query - Repo
List Statuses ByRef Query - Repo
List Statuses Query - Repo
Search Query - Repo
Search RunJobs Query - Repo
Test Hook Query - Repo
Topic Options - RepoTopicOptions a collection of repo topic names
- Repo
Tracked Times Query - Repo
Transfer - RepoTransfer represents a pending repo transfer
- Repo
Update Pull Request Query - Repository
- Repository represents a repository
- Repository
List Headers - Repository
Meta - RepositoryMeta basic repository information
- Search
Results - SearchResults results of a successful search
- Secret
- Secret represents a secret
- Secret
List Headers - Server
Version - ServerVersion wraps the version of the server
- SetUser
Quota Groups Options - SetUserQuotaGroupsOptions represents the quota groups of a user
- Stop
Watch - StopWatch represent a running stopwatch
- Stop
Watch List Headers - Submit
Pull Review Options - SubmitPullReviewOptions are options to submit a pending pull review
- Sync
Fork Info - SyncForkInfo information about syncing a fork
- Tag
- Tag represents a repository tag
- TagArchive
Download Count - TagArchiveDownloadCount counts how many times a archive was downloaded
- TagList
Headers - TagProtection
- TagProtection represents a tag protection
- Team
- Team represents a team in an organization
- Team
List Headers - Team
Search Query - Team
Search Results - Timeline
Comment - TimelineComment represents a timeline comment (comment of any type) on a commit or issue
- Timeline
List Headers - Topic
Name - TopicName a list of repo topic names
- Topic
Response - TopicResponse for returning topics
- Topic
Search Query - Topic
Search Results - Tracked
Time - TrackedTime worked time for an issue / pr
- Tracked
Time List Headers - Transfer
Repo Option - TransferRepoOption options when transfer a repository’s ownership
- Update
Branch Repo Option - UpdateBranchRepoOption options when updating a branch in a repository
- Update
File Options - UpdateFileOptions options for updating files
- Update
Repo Avatar Option - UpdateRepoAvatarUserOption options when updating the repo avatar
- Update
User Avatar Option - UpdateUserAvatarUserOption options when updating the user avatar
- Update
Variable Option - UpdateVariableOption the option when updating variable
- User
- User represents a user
- User
Check Quota Query - User
Current List Keys Query - User
Current List Repos Query - User
Current Tracked Times Query - User
Heatmap Data - UserHeatmapData represents the data needed to create a heatmap
- User
List Activity Feeds Query - User
List Headers - User
List Keys Query - User
Search Query - User
Search Results - User
Search RunJobs Query - User
Settings - UserSettings represents user settings
- User
Settings Options - UserSettingsOptions represents options to change user settings
- Variable
List Headers - VerifyGPG
KeyOption - VerifyGPGKeyOption options verifies user GPG key
- Watch
Info - WatchInfo represents an API watch status of one repository
- Wiki
Commit - WikiCommit page commit/revision
- Wiki
Commit List - WikiCommitList commit/revision list
- Wiki
Commit List Headers - Wiki
Page - WikiPage a wiki page
- Wiki
Page List Headers - Wiki
Page Meta Data - WikiPageMetaData wiki page meta information
Enums§
- Activity
OpType - the type of action
- AddCollaborator
Option Permission - Admin
Search Users Query Sort - Attachment
Type - Change
File Operation Operation - indicates what to do with the file
- Commit
Status State - CommitStatusState holds the state of a CommitStatus
- Create
Hook Option Type - Create
Milestone Option State - Create
OrgOption Visibility - possible values are
public(default),limitedorprivate - Create
Quota Rule Options Subjects - Create
Repo Option Trust Model - TrustModel of the repository
- Create
Team Option Permission - Default
Merge Style - Edit
OrgOption Visibility - possible values are
public,limitedorprivate - Edit
Team Option Permission - Issue
Form Field Type - Issue
List Issues Query Sort - Issue
List Issues Query State - Issue
List Issues Query Type - Issue
List Labels Query Sort - Issue
Search Issues Query Sort - Issue
Search Issues Query State - Issue
Search Issues Query Type - List
Action Runs Query Status - List
Packages Query Type - Merge
Pull Request Option Do - Migrate
Repo Options Service - Notify
GetList Query Subject Type - Notify
GetRepo List Query Subject Type - Notify
Subject Type - NotifySubjectType represent type of notification subject
- OAuth
Token Request - A Request for a new OAuth2 access token
- Object
Format Name - ObjectFormatName of the underlying git repository
- OrgList
Labels Query Sort - Repo
GetPull Request Files Query Whitespace - Repo
List Pull Requests Query Sort - Repo
List Pull Requests Query State - Repo
List Statuses ByRef Query Sort - Repo
List Statuses ByRef Query State - Repo
List Statuses Query Sort - Repo
List Statuses Query State - Repo
Search Query Order - Repo
Search Query Sort - Repo
Update Pull Request Query Style - State
Type - StateType issue state type
- Team
Permission - User
Current List Repos Query Order By - User
Search Query Sort