111 KiB
\RepositoryApi
All URIs are relative to http://localhost/api/v1
| Method | HTTP request | Description |
|---|---|---|
| CreateCurrentUserRepo | Post /user/repos | Create a repository |
| CreateFork | Post /repos/{owner}/{repo}/forks | Fork a repository |
| GetBlob | Get /repos/{owner}/{repo}/git/blobs/{sha} | Gets the blob of a repository. |
| GetTag | Get /repos/{owner}/{repo}/git/tags/{sha} | Gets the tag object of an annotated tag (not lightweight tags) |
| GetTree | Get /repos/{owner}/{repo}/git/trees/{sha} | Gets the tree of a repository. |
| ListForks | Get /repos/{owner}/{repo}/forks | List a repository's forks |
| RepoAddCollaborator | Put /repos/{owner}/{repo}/collaborators/{collaborator} | Add a collaborator to a repository |
| RepoAddTopc | Put /repos/{owner}/{repo}/topics/{topic} | Add a topic to a repository |
| RepoCheckCollaborator | Get /repos/{owner}/{repo}/collaborators/{collaborator} | Check if a user is a collaborator of a repository |
| RepoCreateFile | Post /repos/{owner}/{repo}/contents/{filepath} | Create a file in a repository |
| RepoCreateHook | Post /repos/{owner}/{repo}/hooks | Create a hook |
| RepoCreateKey | Post /repos/{owner}/{repo}/keys | Add a key to a repository |
| RepoCreatePullRequest | Post /repos/{owner}/{repo}/pulls | Create a pull request |
| RepoCreateRelease | Post /repos/{owner}/{repo}/releases | Create a release |
| RepoCreateReleaseAttachment | Post /repos/{owner}/{repo}/releases/{id}/assets | Create a release attachment |
| RepoCreateStatus | Post /repos/{owner}/{repo}/statuses/{sha} | Create a commit status |
| RepoDelete | Delete /repos/{owner}/{repo} | Delete a repository |
| RepoDeleteCollaborator | Delete /repos/{owner}/{repo}/collaborators/{collaborator} | Delete a collaborator from a repository |
| RepoDeleteFile | Delete /repos/{owner}/{repo}/contents/{filepath} | Delete a file in a repository |
| RepoDeleteGitHook | Delete /repos/{owner}/{repo}/hooks/git/{id} | Delete a Git hook in a repository |
| RepoDeleteHook | Delete /repos/{owner}/{repo}/hooks/{id} | Delete a hook in a repository |
| RepoDeleteKey | Delete /repos/{owner}/{repo}/keys/{id} | Delete a key from a repository |
| RepoDeleteRelease | Delete /repos/{owner}/{repo}/releases/{id} | Delete a release |
| RepoDeleteReleaseAttachment | Delete /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id} | Delete a release attachment |
| RepoDeleteTopic | Delete /repos/{owner}/{repo}/topics/{topic} | Delete a topic from a repository |
| RepoEdit | Patch /repos/{owner}/{repo} | Edit a repository's properties. Only fields that are set will be changed. |
| RepoEditGitHook | Patch /repos/{owner}/{repo}/hooks/git/{id} | Edit a Git hook in a repository |
| RepoEditHook | Patch /repos/{owner}/{repo}/hooks/{id} | Edit a hook in a repository |
| RepoEditPullRequest | Patch /repos/{owner}/{repo}/pulls/{index} | Update a pull request. If using deadline only the date will be taken into account, and time of day ignored. |
| RepoEditRelease | Patch /repos/{owner}/{repo}/releases/{id} | Update a release |
| RepoEditReleaseAttachment | Patch /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id} | Edit a release attachment |
| RepoGet | Get /repos/{owner}/{repo} | Get a repository |
| RepoGetAllCommits | Get /repos/{owner}/{repo}/commits | Get a list of all commits from a repository |
| RepoGetArchive | Get /repos/{owner}/{repo}/archive/{archive} | Get an archive of a repository |
| RepoGetBranch | Get /repos/{owner}/{repo}/branches/{branch} | Retrieve a specific branch from a repository, including its effective branch protection |
| RepoGetByID | Get /repositories/{id} | Get a repository by id |
| RepoGetCombinedStatusByRef | Get /repos/{owner}/{repo}/commits/{ref}/statuses | Get a commit's combined status, by branch/tag/commit reference |
| RepoGetContents | Get /repos/{owner}/{repo}/contents/{filepath} | Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir |
| RepoGetContentsList | Get /repos/{owner}/{repo}/contents | Gets the metadata of all the entries of the root dir |
| RepoGetEditorConfig | Get /repos/{owner}/{repo}/editorconfig/{filepath} | Get the EditorConfig definitions of a file in a repository |
| RepoGetGitHook | Get /repos/{owner}/{repo}/hooks/git/{id} | Get a Git hook |
| RepoGetHook | Get /repos/{owner}/{repo}/hooks/{id} | Get a hook |
| RepoGetKey | Get /repos/{owner}/{repo}/keys/{id} | Get a repository's key by id |
| RepoGetPullRequest | Get /repos/{owner}/{repo}/pulls/{index} | Get a pull request |
| RepoGetRawFile | Get /repos/{owner}/{repo}/raw/{filepath} | Get a file from a repository |
| RepoGetRelease | Get /repos/{owner}/{repo}/releases/{id} | Get a release |
| RepoGetReleaseAttachment | Get /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id} | Get a release attachment |
| RepoGetSingleCommit | Get /repos/{owner}/{repo}/git/commits/{sha} | Get a single commit from a repository |
| RepoListAllGitRefs | Get /repos/{owner}/{repo}/git/refs | Get specified ref or filtered repository's refs |
| RepoListBranches | Get /repos/{owner}/{repo}/branches | List a repository's branches |
| RepoListCollaborators | Get /repos/{owner}/{repo}/collaborators | List a repository's collaborators |
| RepoListGitHooks | Get /repos/{owner}/{repo}/hooks/git | List the Git hooks in a repository |
| RepoListGitRefs | Get /repos/{owner}/{repo}/git/refs/{ref} | Get specified ref or filtered repository's refs |
| RepoListHooks | Get /repos/{owner}/{repo}/hooks | List the hooks in a repository |
| RepoListKeys | Get /repos/{owner}/{repo}/keys | List a repository's keys |
| RepoListPullRequests | Get /repos/{owner}/{repo}/pulls | List a repo's pull requests |
| RepoListReleaseAttachments | Get /repos/{owner}/{repo}/releases/{id}/assets | List release's attachments |
| RepoListReleases | Get /repos/{owner}/{repo}/releases | List a repo's releases |
| RepoListStargazers | Get /repos/{owner}/{repo}/stargazers | List a repo's stargazers |
| RepoListStatuses | Get /repos/{owner}/{repo}/statuses/{sha} | Get a commit's statuses |
| RepoListSubscribers | Get /repos/{owner}/{repo}/subscribers | List a repo's watchers |
| RepoListTags | Get /repos/{owner}/{repo}/tags | List a repository's tags |
| RepoListTopics | Get /repos/{owner}/{repo}/topics | Get list of topics that a repository has |
| RepoMergePullRequest | Post /repos/{owner}/{repo}/pulls/{index}/merge | Merge a pull request |
| RepoMigrate | Post /repos/migrate | Migrate a remote git repository |
| RepoMirrorSync | Post /repos/{owner}/{repo}/mirror-sync | Sync a mirrored repository |
| RepoPullRequestIsMerged | Get /repos/{owner}/{repo}/pulls/{index}/merge | Check if a pull request has been merged |
| RepoSearch | Get /repos/search | Search for repositories |
| RepoSigningKey | Get /repos/{owner}/{repo}/signing-key.gpg | Get signing-key.gpg for given repository |
| RepoTestHook | Post /repos/{owner}/{repo}/hooks/{id}/tests | Test a push webhook |
| RepoTrackedTimes | Get /repos/{owner}/{repo}/times | List a repo's tracked times |
| RepoTransfer | Post /repos/{owner}/{repo}/transfer | Transfer a repo ownership |
| RepoUpdateFile | Put /repos/{owner}/{repo}/contents/{filepath} | Update a file in a repository |
| RepoUpdateTopics | Put /repos/{owner}/{repo}/topics | Replace list of topics for a repository |
| TopicSearch | Get /topics/search | search topics via keyword |
| UserCurrentCheckSubscription | Get /repos/{owner}/{repo}/subscription | Check if the current user is watching a repo |
| UserCurrentDeleteSubscription | Delete /repos/{owner}/{repo}/subscription | Unwatch a repo |
| UserCurrentPutSubscription | Put /repos/{owner}/{repo}/subscription | Watch a repo |
| UserTrackedTimes | Get /repos/{owner}/{repo}/times/{user} | List a user's tracked times in a repo |
CreateCurrentUserRepo
Repository CreateCurrentUserRepo(ctx, optional) Create a repository
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *CreateCurrentUserRepoOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a CreateCurrentUserRepoOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| body | optional.Interface of CreateRepoOption |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateFork
Repository CreateFork(ctx, owner, repo, optional) Fork a repository
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo to fork | |
| repo | string | name of the repo to fork | |
| optional | *CreateForkOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a CreateForkOpts struct
| Name | Type | Description | Notes |
|---|
body | optional.Interface of CreateForkOption| |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetBlob
GitBlobResponse GetBlob(ctx, owner, repo, sha) Gets the blob of a repository.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| sha | string | sha of the commit |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetTag
AnnotatedTag GetTag(ctx, owner, repo, sha) Gets the tag object of an annotated tag (not lightweight tags)
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| sha | string | sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags. |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetTree
GitTreeResponse GetTree(ctx, owner, repo, sha, optional) Gets the tree of a repository.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| sha | string | sha of the commit | |
| optional | *GetTreeOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a GetTreeOpts struct
| Name | Type | Description | Notes |
|---|
recursive | optional.Bool| show all directories and files | page | optional.Int32| page number; the 'truncated' field in the response will be true if there are still more items after this page, false if the last page | perPage | optional.Int32| number of items per page; default is 1000 or what is set in app.ini as DEFAULT_GIT_TREES_PER_PAGE |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListForks
[]Repository ListForks(ctx, owner, repo, optional) List a repository's forks
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| optional | *ListForksOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a ListForksOpts struct
| Name | Type | Description | Notes |
|---|
page | optional.Int32| page number of results to return (1-based) | limit | optional.Int32| page size of results, maximum page size is 50 |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoAddCollaborator
RepoAddCollaborator(ctx, owner, repo, collaborator, optional) Add a collaborator to a repository
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| collaborator | string | username of the collaborator to add | |
| optional | *RepoAddCollaboratorOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RepoAddCollaboratorOpts struct
| Name | Type | Description | Notes |
|---|
body | optional.Interface of AddCollaboratorOption| |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoAddTopc
RepoAddTopc(ctx, owner, repo, topic) Add a topic to a repository
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| topic | string | name of the topic to add |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoCheckCollaborator
RepoCheckCollaborator(ctx, owner, repo, collaborator) Check if a user is a collaborator of a repository
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| collaborator | string | username of the collaborator |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoCreateFile
FileResponse RepoCreateFile(ctx, owner, repo, filepath, body) Create a file in a repository
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| filepath | string | path of the file to create | |
| body | CreateFileOptions |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoCreateHook
Hook RepoCreateHook(ctx, owner, repo, optional) Create a hook
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| optional | *RepoCreateHookOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RepoCreateHookOpts struct
| Name | Type | Description | Notes |
|---|
body | optional.Interface of CreateHookOption| |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoCreateKey
DeployKey RepoCreateKey(ctx, owner, repo, optional) Add a key to a repository
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| optional | *RepoCreateKeyOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RepoCreateKeyOpts struct
| Name | Type | Description | Notes |
|---|
body | optional.Interface of CreateKeyOption| |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoCreatePullRequest
PullRequest RepoCreatePullRequest(ctx, owner, repo, optional) Create a pull request
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| optional | *RepoCreatePullRequestOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RepoCreatePullRequestOpts struct
| Name | Type | Description | Notes |
|---|
body | optional.Interface of CreatePullRequestOption| |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoCreateRelease
Release RepoCreateRelease(ctx, owner, repo, optional) Create a release
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| optional | *RepoCreateReleaseOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RepoCreateReleaseOpts struct
| Name | Type | Description | Notes |
|---|
body | optional.Interface of CreateReleaseOption| |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoCreateReleaseAttachment
Attachment RepoCreateReleaseAttachment(ctx, owner, repo, id, attachment, optional) Create a release attachment
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| id | int64 | id of the release | |
| attachment | *os.File | attachment to upload | |
| optional | *RepoCreateReleaseAttachmentOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RepoCreateReleaseAttachmentOpts struct
| Name | Type | Description | Notes |
|---|
name | optional.String| name of the attachment |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: multipart/form-data
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoCreateStatus
Status RepoCreateStatus(ctx, owner, repo, sha, optional) Create a commit status
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| sha | string | sha of the commit | |
| optional | *RepoCreateStatusOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RepoCreateStatusOpts struct
| Name | Type | Description | Notes |
|---|
body | optional.Interface of CreateStatusOption| |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoDelete
RepoDelete(ctx, owner, repo) Delete a repository
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo to delete | |
| repo | string | name of the repo to delete |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoDeleteCollaborator
RepoDeleteCollaborator(ctx, owner, repo, collaborator) Delete a collaborator from a repository
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| collaborator | string | username of the collaborator to delete |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoDeleteFile
FileDeleteResponse RepoDeleteFile(ctx, owner, repo, filepath, body) Delete a file in a repository
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| filepath | string | path of the file to delete | |
| body | DeleteFileOptions |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoDeleteGitHook
RepoDeleteGitHook(ctx, owner, repo, id) Delete a Git hook in a repository
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| id | string | id of the hook to get |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoDeleteHook
RepoDeleteHook(ctx, owner, repo, id) Delete a hook in a repository
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| id | int64 | id of the hook to delete |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoDeleteKey
RepoDeleteKey(ctx, owner, repo, id) Delete a key from a repository
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| id | int64 | id of the key to delete |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json, text/html
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoDeleteRelease
RepoDeleteRelease(ctx, owner, repo, id) Delete a release
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| id | int64 | id of the release to delete |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json, text/html
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoDeleteReleaseAttachment
RepoDeleteReleaseAttachment(ctx, owner, repo, id, attachmentId) Delete a release attachment
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| id | int64 | id of the release | |
| attachmentId | int64 | id of the attachment to delete |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoDeleteTopic
RepoDeleteTopic(ctx, owner, repo, topic) Delete a topic from a repository
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| topic | string | name of the topic to delete |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoEdit
Repository RepoEdit(ctx, owner, repo, optional) Edit a repository's properties. Only fields that are set will be changed.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo to edit | |
| repo | string | name of the repo to edit | |
| optional | *RepoEditOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RepoEditOpts struct
| Name | Type | Description | Notes |
|---|
body | optional.Interface of EditRepoOption| Properties of a repo that you can edit |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoEditGitHook
GitHook RepoEditGitHook(ctx, owner, repo, id, optional) Edit a Git hook in a repository
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| id | string | id of the hook to get | |
| optional | *RepoEditGitHookOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RepoEditGitHookOpts struct
| Name | Type | Description | Notes |
|---|
body | optional.Interface of EditGitHookOption| |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoEditHook
Hook RepoEditHook(ctx, owner, repo, id, optional) Edit a hook in a repository
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| id | int64 | index of the hook | |
| optional | *RepoEditHookOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RepoEditHookOpts struct
| Name | Type | Description | Notes |
|---|
body | optional.Interface of EditHookOption| |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoEditPullRequest
PullRequest RepoEditPullRequest(ctx, owner, repo, index, optional) Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| index | int64 | index of the pull request to edit | |
| optional | *RepoEditPullRequestOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RepoEditPullRequestOpts struct
| Name | Type | Description | Notes |
|---|
body | optional.Interface of EditPullRequestOption| |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoEditRelease
Release RepoEditRelease(ctx, owner, repo, id, optional) Update a release
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| id | int64 | id of the release to edit | |
| optional | *RepoEditReleaseOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RepoEditReleaseOpts struct
| Name | Type | Description | Notes |
|---|
body | optional.Interface of EditReleaseOption| |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoEditReleaseAttachment
Attachment RepoEditReleaseAttachment(ctx, owner, repo, id, attachmentId, optional) Edit a release attachment
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| id | int64 | id of the release | |
| attachmentId | int64 | id of the attachment to edit | |
| optional | *RepoEditReleaseAttachmentOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RepoEditReleaseAttachmentOpts struct
| Name | Type | Description | Notes |
|---|
body | optional.Interface of EditAttachmentOptions| |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoGet
Repository RepoGet(ctx, owner, repo) Get a repository
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoGetAllCommits
[]Commit RepoGetAllCommits(ctx, owner, repo, optional) Get a list of all commits from a repository
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| optional | *RepoGetAllCommitsOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RepoGetAllCommitsOpts struct
| Name | Type | Description | Notes |
|---|
sha | optional.String| SHA or branch to start listing commits from (usually 'master') | page | optional.Int32| page number of results to return (1-based) | limit | optional.Int32| page size of results, maximum page size is 50 |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoGetArchive
RepoGetArchive(ctx, owner, repo, archive) Get an archive of a repository
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| archive | string | archive to download, consisting of a git reference and archive |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoGetBranch
Branch RepoGetBranch(ctx, owner, repo, branch) Retrieve a specific branch from a repository, including its effective branch protection
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| branch | string | branch to get |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoGetByID
Repository RepoGetByID(ctx, id) Get a repository by id
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int64 | id of the repo to get |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoGetCombinedStatusByRef
Status RepoGetCombinedStatusByRef(ctx, owner, repo, ref, optional) Get a commit's combined status, by branch/tag/commit reference
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| ref | string | name of branch/tag/commit | |
| optional | *RepoGetCombinedStatusByRefOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RepoGetCombinedStatusByRefOpts struct
| Name | Type | Description | Notes |
|---|
page | optional.Int32| page number of results |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoGetContents
ContentsResponse RepoGetContents(ctx, owner, repo, filepath, optional) Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| filepath | string | path of the dir, file, symlink or submodule in the repo | |
| optional | *RepoGetContentsOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RepoGetContentsOpts struct
| Name | Type | Description | Notes |
|---|
ref | optional.String| The name of the commit/branch/tag. Default the repository’s default branch (usually master) |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoGetContentsList
[]ContentsResponse RepoGetContentsList(ctx, owner, repo, optional) Gets the metadata of all the entries of the root dir
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| optional | *RepoGetContentsListOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RepoGetContentsListOpts struct
| Name | Type | Description | Notes |
|---|
ref | optional.String| The name of the commit/branch/tag. Default the repository’s default branch (usually master) |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoGetEditorConfig
RepoGetEditorConfig(ctx, owner, repo, filepath) Get the EditorConfig definitions of a file in a repository
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| filepath | string | filepath of file to get |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoGetGitHook
GitHook RepoGetGitHook(ctx, owner, repo, id) Get a Git hook
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| id | string | id of the hook to get |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoGetHook
Hook RepoGetHook(ctx, owner, repo, id) Get a hook
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| id | int64 | id of the hook to get |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoGetKey
DeployKey RepoGetKey(ctx, owner, repo, id) Get a repository's key by id
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| id | int64 | id of the key to get |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoGetPullRequest
PullRequest RepoGetPullRequest(ctx, owner, repo, index) Get a pull request
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| index | int64 | index of the pull request to get |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoGetRawFile
RepoGetRawFile(ctx, owner, repo, filepath) Get a file from a repository
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| filepath | string | filepath of the file to get |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoGetRelease
Release RepoGetRelease(ctx, owner, repo, id) Get a release
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| id | int64 | id of the release to get |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoGetReleaseAttachment
Attachment RepoGetReleaseAttachment(ctx, owner, repo, id, attachmentId) Get a release attachment
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| id | int64 | id of the release | |
| attachmentId | int64 | id of the attachment to get |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoGetSingleCommit
Commit RepoGetSingleCommit(ctx, owner, repo, sha) Get a single commit from a repository
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| sha | string | the commit hash |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoListAllGitRefs
[]Reference RepoListAllGitRefs(ctx, owner, repo) Get specified ref or filtered repository's refs
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoListBranches
[]Branch RepoListBranches(ctx, owner, repo) List a repository's branches
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoListCollaborators
[]User RepoListCollaborators(ctx, owner, repo, optional) List a repository's collaborators
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| optional | *RepoListCollaboratorsOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RepoListCollaboratorsOpts struct
| Name | Type | Description | Notes |
|---|
page | optional.Int32| page number of results to return (1-based) | limit | optional.Int32| page size of results, maximum page size is 50 |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoListGitHooks
[]GitHook RepoListGitHooks(ctx, owner, repo) List the Git hooks in a repository
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoListGitRefs
[]Reference RepoListGitRefs(ctx, owner, repo, ref) Get specified ref or filtered repository's refs
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| ref | string | part or full name of the ref |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoListHooks
[]Hook RepoListHooks(ctx, owner, repo, optional) List the hooks in a repository
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| optional | *RepoListHooksOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RepoListHooksOpts struct
| Name | Type | Description | Notes |
|---|
page | optional.Int32| page number of results to return (1-based) | limit | optional.Int32| page size of results, maximum page size is 50 |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoListKeys
[]DeployKey RepoListKeys(ctx, owner, repo, optional) List a repository's keys
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| optional | *RepoListKeysOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RepoListKeysOpts struct
| Name | Type | Description | Notes |
|---|
keyId | optional.Int32| the key_id to search for | fingerprint | optional.String| fingerprint of the key | page | optional.Int32| page number of results to return (1-based) | limit | optional.Int32| page size of results, maximum page size is 50 |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoListPullRequests
[]PullRequest RepoListPullRequests(ctx, owner, repo, optional) List a repo's pull requests
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| optional | *RepoListPullRequestsOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RepoListPullRequestsOpts struct
| Name | Type | Description | Notes |
|---|
state | optional.String| State of pull request: open or closed (optional) | sort | optional.String| Type of sort | milestone | optional.Int64| ID of the milestone | labels | **optional.Interface of []int64**| Label IDs | page | optional.Int32| page number of results to return (1-based) | limit | optional.Int32| page size of results, maximum page size is 50 |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoListReleaseAttachments
[]Attachment RepoListReleaseAttachments(ctx, owner, repo, id) List release's attachments
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| id | int64 | id of the release |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoListReleases
[]Release RepoListReleases(ctx, owner, repo, optional) List a repo's releases
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| optional | *RepoListReleasesOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RepoListReleasesOpts struct
| Name | Type | Description | Notes |
|---|
perPage | optional.Int32| items count every page wants to load | page | optional.Int32| page number of results to return (1-based) | limit | optional.Int32| page size of results, maximum page size is 50 |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoListStargazers
[]User RepoListStargazers(ctx, owner, repo, optional) List a repo's stargazers
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| optional | *RepoListStargazersOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RepoListStargazersOpts struct
| Name | Type | Description | Notes |
|---|
page | optional.Int32| page number of results to return (1-based) | limit | optional.Int32| page size of results, maximum page size is 50 |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoListStatuses
[]Status RepoListStatuses(ctx, owner, repo, sha, optional) Get a commit's statuses
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| sha | string | sha of the commit | |
| optional | *RepoListStatusesOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RepoListStatusesOpts struct
| Name | Type | Description | Notes |
|---|
sort | optional.String| type of sort | state | optional.String| type of state | page | optional.Int32| page number of results to return (1-based) | limit | optional.Int32| page size of results, maximum page size is 50 |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoListSubscribers
[]User RepoListSubscribers(ctx, owner, repo, optional) List a repo's watchers
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| optional | *RepoListSubscribersOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RepoListSubscribersOpts struct
| Name | Type | Description | Notes |
|---|
page | optional.Int32| page number of results to return (1-based) | limit | optional.Int32| page size of results, maximum page size is 50 |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoListTags
[]Tag RepoListTags(ctx, owner, repo) List a repository's tags
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoListTopics
TopicName RepoListTopics(ctx, owner, repo, optional) Get list of topics that a repository has
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| optional | *RepoListTopicsOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RepoListTopicsOpts struct
| Name | Type | Description | Notes |
|---|
page | optional.Int32| page number of results to return (1-based) | limit | optional.Int32| page size of results, maximum page size is 50 |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoMergePullRequest
RepoMergePullRequest(ctx, owner, repo, index, optional) Merge a pull request
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| index | int64 | index of the pull request to merge | |
| optional | *RepoMergePullRequestOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RepoMergePullRequestOpts struct
| Name | Type | Description | Notes |
|---|
body | optional.Interface of MergePullRequestOption| |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoMigrate
Repository RepoMigrate(ctx, optional) Migrate a remote git repository
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *RepoMigrateOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RepoMigrateOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| body | optional.Interface of MigrateRepoForm |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoMirrorSync
RepoMirrorSync(ctx, owner, repo) Sync a mirrored repository
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo to sync | |
| repo | string | name of the repo to sync |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoPullRequestIsMerged
RepoPullRequestIsMerged(ctx, owner, repo, index) Check if a pull request has been merged
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| index | int64 | index of the pull request |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoSearch
SearchResults RepoSearch(ctx, optional) Search for repositories
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *RepoSearchOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RepoSearchOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| q | optional.String | keyword | |
| topic | optional.Bool | Limit search to repositories with keyword as topic | |
| includeDesc | optional.Bool | include search of keyword within repository description | |
| uid | optional.Int64 | search only for repos that the user with the given id owns or contributes to | |
| priorityOwnerId | optional.Int64 | repo owner to prioritize in the results | |
| starredBy | optional.Int64 | search only for repos that the user with the given id has starred | |
| private | optional.Bool | include private repositories this user has access to (defaults to true) | |
| template | optional.Bool | include template repositories this user has access to (defaults to true) | |
| mode | optional.String | type of repository to search for. Supported values are "fork", "source", "mirror" and "collaborative" | |
| exclusive | optional.Bool | if `uid` is given, search only for repos that the user owns | |
| sort | optional.String | sort repos by attribute. Supported values are "alpha", "created", "updated", "size", and "id". Default is "alpha" | |
| order | optional.String | sort order, either "asc" (ascending) or "desc" (descending). Default is "asc", ignored if "sort" is not specified. | |
| page | optional.Int32 | page number of results to return (1-based) | |
| limit | optional.Int32 | page size of results, maximum page size is 50 |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoSigningKey
string RepoSigningKey(ctx, owner, repo) Get signing-key.gpg for given repository
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo |
Return type
string
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: text/plain
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoTestHook
RepoTestHook(ctx, owner, repo, id) Test a push webhook
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| id | int64 | id of the hook to test |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoTrackedTimes
[]TrackedTime RepoTrackedTimes(ctx, owner, repo, optional) List a repo's tracked times
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| optional | *RepoTrackedTimesOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RepoTrackedTimesOpts struct
| Name | Type | Description | Notes |
|---|
user | optional.String| optional filter by user | since | optional.Time| Only show times updated after the given time. This is a timestamp in RFC 3339 format | before | optional.Time| Only show times updated before the given time. This is a timestamp in RFC 3339 format | page | optional.Int32| page number of results to return (1-based) | limit | optional.Int32| page size of results, maximum page size is 50 |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoTransfer
Repository RepoTransfer(ctx, owner, repo, body) Transfer a repo ownership
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo to transfer | |
| repo | string | name of the repo to transfer | |
| body | TransferRepoOption | Transfer Options |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoUpdateFile
FileResponse RepoUpdateFile(ctx, owner, repo, filepath, body) Update a file in a repository
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| filepath | string | path of the file to update | |
| body | UpdateFileOptions |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoUpdateTopics
RepoUpdateTopics(ctx, owner, repo, optional) Replace list of topics for a repository
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| optional | *RepoUpdateTopicsOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a RepoUpdateTopicsOpts struct
| Name | Type | Description | Notes |
|---|
body | optional.Interface of RepoTopicOptions| |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TopicSearch
[]TopicResponse TopicSearch(ctx, q, optional) search topics via keyword
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| q | string | keywords to search | |
| optional | *TopicSearchOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a TopicSearchOpts struct
| Name | Type | Description | Notes |
|---|
page | optional.Int32| page number of results to return (1-based) | limit | optional.Int32| page size of results, maximum page size is 50 |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UserCurrentCheckSubscription
WatchInfo UserCurrentCheckSubscription(ctx, owner, repo) Check if the current user is watching a repo
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json, text/html
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UserCurrentDeleteSubscription
UserCurrentDeleteSubscription(ctx, owner, repo) Unwatch a repo
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json, text/html
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UserCurrentPutSubscription
WatchInfo UserCurrentPutSubscription(ctx, owner, repo) Watch a repo
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json, text/html
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UserTrackedTimes
[]TrackedTime UserTrackedTimes(ctx, owner, repo, user) List a user's tracked times in a repo
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| owner | string | owner of the repo | |
| repo | string | name of the repo | |
| user | string | username of user |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token
HTTP request headers
- Content-Type: application/json, text/plain
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]