The identity and technical contract details declared by the specification.
CreateWikiPageOptions
object
CreateWikiPageOptions form for creating wiki
3 properties
WikiPageMetaData
object
WikiPageMetaData wiki page meta information
4 properties
RepositoryMeta
object
RepositoryMeta basic repository information
4 properties
User
object
User represents a user
22 properties
Release
object
Release represents a repository release
16 properties
ContentsResponse
object
ContentsResponse contains information about a repo's entry's (dir, file, symlink, submodule) metadata and content
20 properties
PullReviewComment
object
PullReviewComment represents a comment on a pull request review
15 properties
CreatePullRequestOption
object
CreatePullRequestOption options when creating a pull request
12 properties
BranchProtection
object
BranchProtection represents a branch protection for a repository
33 properties
DeleteFileOptions
object
DeleteFileOptions options for deleting a file Note: author and committer are optional (if only one is given, it will be used for the other, otherwise the authe…
9 properties
1 required
Issue
object
Issue represents an issue in a repository
27 properties
ChangedFile
object
ChangedFile store information about files affected by the pull request
9 properties
ActionWorkflowStep
object
ActionWorkflowStep represents a step of a WorkflowJob
6 properties
Note
object
Note contains information related to a git note
2 properties
ActionWorkflowJob
object
ActionWorkflowJob represents a WorkflowJob
18 properties
Tag
object
Tag represents a repository tag
6 properties
CreateActionWorkflowDispatch
object
CreateActionWorkflowDispatch represents the payload for triggering a workflow dispatch event
2 properties
1 required
InternalTracker
object
InternalTracker represents settings for internal tracker
3 properties
Identity
object
Identity for a person's identity like an author or committer
2 properties
TopicResponse
object
TopicResponse for returning topics
5 properties
Attachment
object
Attachment a generic attachment
7 properties
CommitStats
object
CommitStats is statistics for a RepoCommit
3 properties
GenerateRepoOption
object
GenerateRepoOption options when creating a repository using a template
12 properties
2 required
Compare
object
2 properties
CreateRepoOption
object
CreateRepoOption options when creating repository
12 properties
1 required
ApplyDiffPatchFileOptions
object
ApplyDiffPatchFileOptions options for applying a diff patch Note: author and committer are optional (if only one is given, it will be used for the other, other…
9 properties
1 required
SearchResults
object
SearchResults results of a successful search
2 properties
IssueTemplate
object
IssueTemplate represents an issue template for a repository
9 properties
PushMirror
object
PushMirror represents information of a push mirror
8 properties
EditActionRunnerOption
object
1 property
1 required
ActionArtifact
object
ActionArtifact represents a ActionArtifact
10 properties
CreateTagProtectionOption
object
CreateTagProtectionOption options for creating a tag protection
3 properties
DeployKey
object
DeployKey a deploy key
9 properties
PayloadCommit
object
PayloadCommit represents a commit
10 properties
PullReviewRequestOptions
object
PullReviewRequestOptions are options to add or remove pull request review requests
2 properties
TopicName
object
TopicName a list of repo topic names
1 property
ActionRunnersResponse
object
ActionRunnersResponse returns Runners
2 properties
UpdateBranchRepoOption
object
UpdateBranchRepoOption options when updating a branch reference in a repository
3 properties
1 required
UpdateRepoAvatarOption
object
UpdateRepoAvatarUserOption options when updating the repo avatar
1 property
CreateVariableOption
object
CreateVariableOption the option when creating variable
2 properties
1 required
MigrateRepoOptions
object
MigrateRepoOptions options for migrating repository's this is used to interact with api v1
22 properties
2 required
AnnotatedTagObject
object
AnnotatedTagObject contains meta information of the tag object
3 properties
ActionRunnerLabel
object
ActionRunnerLabel represents a Runner Label
3 properties
CombinedStatus
object
CombinedStatus holds the combined state of several statuses for a single commit
7 properties
TrackedTime
object
TrackedTime worked time for an issue / pr
7 properties
GitTreeResponse
object
GitTreeResponse returns a git tree
6 properties
MergeUpstreamRequest
object
2 properties
UpdateBranchProtectionPriories
object
UpdateBranchProtectionPriories a list to update the branch protection rule priorities
1 property
WatchInfo
object
WatchInfo represents an API watch status of one repository
6 properties
Milestone
object
Milestone milestone is a collection of issues on one repository
10 properties
EditPullRequestOption
object
EditPullRequestOption options when modify pull request
12 properties
FileCommitResponse
object
9 properties
TagProtection
object
TagProtection represents a tag protection
6 properties
ActionWorkflowRunsResponse
object
ActionWorkflowRunsResponse returns ActionWorkflowRuns
2 properties
CommitStatus
object
CommitStatus holds a single status of a single Commit
9 properties
CreateBranchProtectionOption
object
CreateBranchProtectionOption options for creating a branch protection
31 properties
ExternalWiki
object
ExternalWiki represents setting for external wiki
1 property
EditBranchProtectionOption
object
EditBranchProtectionOption options for editing a branch protection
29 properties
RepoTopicOptions
object
RepoTopicOptions a collection of repo topic names
1 property
CreateFileOptions
object
CreateFileOptions options for creating a file Note: author and committer are optional (if only one is given, it will be used for the other, otherwise the authe…
9 properties
1 required
IssueFormField
object
IssueFormField represents a form field
5 properties
Branch
object
Branch represents a repository branch
9 properties
MergePullRequestOption
object
MergePullRequestForm form for merging Pull Request
8 properties
1 required
NewIssuePinsAllowed
object
NewIssuePinsAllowed represents an API response that says if new Issue Pins are allowed
2 properties
CreateKeyOption
object
CreateKeyOption options when creating a key
3 properties
2 required
ActionTask
object
ActionTask represents a ActionTask
13 properties
EditAttachmentOptions
object
EditAttachmentOptions options for editing attachments
1 property
PayloadCommitVerification
object
PayloadCommitVerification represents the GPG verification of a commit
5 properties
PayloadUser
object
PayloadUser represents the author or committer of a commit
3 properties
PullReview
object
PullReview represents a pull request review
14 properties
ActionRunner
object
ActionRunner represents a Runner
7 properties
FileDeleteResponse
object
FileDeleteResponse contains information about a repo's file that was deleted
3 properties
CreateHookOption
object
CreateHookOption options when create a hook
7 properties
2 required
GitBlobResponse
object
GitBlobResponse represents a git blob
7 properties
TransferRepoOption
object
TransferRepoOption options when transfer a repository's ownership
2 properties
1 required
UpdateFileOptions
object
UpdateFileOptions options for updating or creating a file Note: author and committer are optional (if only one is given, it will be used for the other, otherwi…
11 properties
1 required
CommitDateOptions
object
CommitDateOptions store dates for GITAUTHORDATE and GITCOMMITTERDATE
2 properties
CreateBranchRepoOption
object
CreateBranchRepoOption options when creating a branch in a repository
3 properties
1 required
Hook
object
Hook a hook is a web hook when one repository changed
10 properties
Secret
object
Secret represents a secret
3 properties
CreatePushMirrorOption
object
5 properties
FileResponse
object
FileResponse contains information about a repo's file
3 properties
MergeUpstreamResponse
object
1 property
Activity
object
13 properties
ActionVariable
object
ActionVariable return value of the query API
5 properties
ContentsExtResponse
object
2 properties
CreatePullReviewOptions
object
CreatePullReviewOptions are options to create a pull request review
4 properties
EditReleaseOption
object
EditReleaseOption options when editing a release
6 properties
Permission
object
Permission represents a set of permissions
3 properties
EditRepoOption
object
EditRepoOption options when editing a repository's properties
33 properties
CreateHookOptionConfig
object
CreateHookOptionConfig has all config options in it required are "contenttype" and "url" Required
ActionWorkflowRun
object
ActionWorkflowRun represents a WorkflowRun
19 properties
CreateReleaseOption
object
CreateReleaseOption options when creating a release
7 properties
1 required
EditTagProtectionOption
object
EditTagProtectionOption options for editing a tag protection
3 properties
EditGitHookOption
object
EditGitHookOption options when modifying one Git hook
1 property
ExternalTracker
object
ExternalTracker represents settings for external tracker
4 properties
IssueConfigContactLink
object
3 properties
AddCollaboratorOption
object
AddCollaboratorOption options when adding a user as a collaborator of a repository
1 property
Repository
object
Repository represents a repository
67 properties
Comment
object
Comment represents a comment on a commit or issue
11 properties
ActionWorkflowResponse
object
ActionWorkflowResponse returns a ActionWorkflow
2 properties
Label
object
Label a label to an issue or a pr
7 properties
AnnotatedTag
object
AnnotatedTag represents an annotated tag
7 properties
CreateOrUpdateSecretOption
object
CreateOrUpdateSecretOption options when creating or updating secret
2 properties
1 required
CreateForkOption
object
CreateForkOption options for creating a fork
2 properties
ActionArtifactsResponse
object
ActionArtifactsResponse returns ActionArtifacts
2 properties
IssueTemplateStringSlice
array
UpdateVariableOption
object
UpdateVariableOption the option when updating variable
3 properties
1 required
SubmitPullReviewOptions
object
SubmitPullReviewOptions are options to submit a pending pull request review
2 properties
GitEntry
object
GitEntry represents a git tree
6 properties
ActionWorkflowJobsResponse
object
ActionWorkflowJobsResponse returns ActionWorkflowJobs
2 properties
CommitAffectedFiles
object
CommitAffectedFiles store information about files affected by the commit
2 properties
RepoCommit
object
6 properties
GitHook
object
GitHook represents a Git repository hook
3 properties
CommitMeta
object
3 properties
PullRequest
object
PullRequest represents a pull request
38 properties
RunDetails
object
RunDetails returns workflowdispatch runid and url
3 properties
CreateTagOption
object
CreateTagOption options when creating a tag
3 properties
1 required
ActionTaskResponse
object
ActionTaskResponse returns a ActionTask
2 properties
RepoTransfer
object
RepoTransfer represents a pending repo transfer
3 properties
GitObject
object
3 properties
IssueConfig
object
2 properties
WikiCommitList
object
WikiCommitList commit/revision list
2 properties
FilesResponse
object
FilesResponse contains information about multiple files from a repo
3 properties
Commit
object
10 properties
Team
object
Team represents a team in an organization
9 properties
WikiCommit
object
WikiCommit page commit/revision
4 properties
PullRequestMeta
object
PullRequestMeta PR info if an issue is a PR
4 properties
RenameBranchRepoOption
object
RenameBranchRepoOption options when renaming a branch in a repository
1 property
1 required
FileLinksResponse
object
FileLinksResponse contains the links for a repo's file
3 properties
CommitUser
object
3 properties
RepoCollaboratorPermission
object
RepoCollaboratorPermission to get repository permission for a collaborator
3 properties
ActionWorkflow
object
ActionWorkflow represents a ActionWorkflow
10 properties
GetFilesOptions
object
GetFilesOptions options for retrieving metadate and content of multiple files
1 property
IssueConfigValidation
object
2 properties
CreatePullReviewComment
object
CreatePullReviewComment represent a review comment for creation api
4 properties
PRBranchInfo
object
PRBranchInfo information about a branch
5 properties
Organization
object
Organization represents an organization
11 properties
CreateStatusOption
object
CreateStatusOption holds the information needed to create a new CommitStatus for a Commit
4 properties
ChangeFileOperation
object
ChangeFileOperation for creating, updating or deleting a file
5 properties
2 required
EditHookOption
object
EditHookOption options when modify one hook
6 properties
APIError
object
APIError is an api error with a message
2 properties
Reference
object
3 properties
ChangeFilesOptions
object
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…
9 properties
1 required
DismissPullReviewOptions
object
DismissPullReviewOptions are options to dismiss a pull request review
2 properties
WikiPage
object
WikiPage a wiki page
8 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Gitea publishes across the network.