rusty-gitea/docs/RepositoryApi.md

\RepositoryApi

All URIs are relative to http://localhost/api/v1

Method	HTTP request	Description
create_current_user_repo	Post /user/repos	Create a repository
create_fork	Post /repos/{owner}/{repo}/forks	Fork a repository
get_blob	Get /repos/{owner}/{repo}/git/blobs/{sha}	Gets the blob of a repository.
get_tag	Get /repos/{owner}/{repo}/git/tags/{sha}	Gets the tag object of an annotated tag (not lightweight tags)
get_tree	Get /repos/{owner}/{repo}/git/trees/{sha}	Gets the tree of a repository.
list_forks	Get /repos/{owner}/{repo}/forks	List a repository's forks
repo_add_collaborator	Put /repos/{owner}/{repo}/collaborators/{collaborator}	Add a collaborator to a repository
repo_add_topc	Put /repos/{owner}/{repo}/topics/{topic}	Add a topic to a repository
repo_check_collaborator	Get /repos/{owner}/{repo}/collaborators/{collaborator}	Check if a user is a collaborator of a repository
repo_create_file	Post /repos/{owner}/{repo}/contents/{filepath}	Create a file in a repository
repo_create_hook	Post /repos/{owner}/{repo}/hooks	Create a hook
repo_create_key	Post /repos/{owner}/{repo}/keys	Add a key to a repository
repo_create_pull_request	Post /repos/{owner}/{repo}/pulls	Create a pull request
repo_create_release	Post /repos/{owner}/{repo}/releases	Create a release
repo_create_release_attachment	Post /repos/{owner}/{repo}/releases/{id}/assets	Create a release attachment
repo_create_status	Post /repos/{owner}/{repo}/statuses/{sha}	Create a commit status
repo_delete	Delete /repos/{owner}/{repo}	Delete a repository
repo_delete_collaborator	Delete /repos/{owner}/{repo}/collaborators/{collaborator}	Delete a collaborator from a repository
repo_delete_file	Delete /repos/{owner}/{repo}/contents/{filepath}	Delete a file in a repository
repo_delete_git_hook	Delete /repos/{owner}/{repo}/hooks/git/{id}	Delete a Git hook in a repository
repo_delete_hook	Delete /repos/{owner}/{repo}/hooks/{id}	Delete a hook in a repository
repo_delete_key	Delete /repos/{owner}/{repo}/keys/{id}	Delete a key from a repository
repo_delete_release	Delete /repos/{owner}/{repo}/releases/{id}	Delete a release
repo_delete_release_attachment	Delete /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}	Delete a release attachment
repo_delete_topic	Delete /repos/{owner}/{repo}/topics/{topic}	Delete a topic from a repository
repo_edit	Patch /repos/{owner}/{repo}	Edit a repository's properties. Only fields that are set will be changed.
repo_edit_git_hook	Patch /repos/{owner}/{repo}/hooks/git/{id}	Edit a Git hook in a repository
repo_edit_hook	Patch /repos/{owner}/{repo}/hooks/{id}	Edit a hook in a repository
repo_edit_pull_request	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.
repo_edit_release	Patch /repos/{owner}/{repo}/releases/{id}	Update a release
repo_edit_release_attachment	Patch /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}	Edit a release attachment
repo_get	Get /repos/{owner}/{repo}	Get a repository
repo_get_all_commits	Get /repos/{owner}/{repo}/commits	Get a list of all commits from a repository
repo_get_archive	Get /repos/{owner}/{repo}/archive/{archive}	Get an archive of a repository
repo_get_branch	Get /repos/{owner}/{repo}/branches/{branch}	Retrieve a specific branch from a repository, including its effective branch protection
repo_get_by_id	Get /repositories/{id}	Get a repository by id
repo_get_combined_status_by_ref	Get /repos/{owner}/{repo}/commits/{ref}/statuses	Get a commit's combined status, by branch/tag/commit reference
repo_get_contents	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
repo_get_contents_list	Get /repos/{owner}/{repo}/contents	Gets the metadata of all the entries of the root dir
repo_get_editor_config	Get /repos/{owner}/{repo}/editorconfig/{filepath}	Get the EditorConfig definitions of a file in a repository
repo_get_git_hook	Get /repos/{owner}/{repo}/hooks/git/{id}	Get a Git hook
repo_get_hook	Get /repos/{owner}/{repo}/hooks/{id}	Get a hook
repo_get_key	Get /repos/{owner}/{repo}/keys/{id}	Get a repository's key by id
repo_get_pull_request	Get /repos/{owner}/{repo}/pulls/{index}	Get a pull request
repo_get_raw_file	Get /repos/{owner}/{repo}/raw/{filepath}	Get a file from a repository
repo_get_release	Get /repos/{owner}/{repo}/releases/{id}	Get a release
repo_get_release_attachment	Get /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}	Get a release attachment
repo_get_single_commit	Get /repos/{owner}/{repo}/git/commits/{sha}	Get a single commit from a repository
repo_list_all_git_refs	Get /repos/{owner}/{repo}/git/refs	Get specified ref or filtered repository's refs
repo_list_branches	Get /repos/{owner}/{repo}/branches	List a repository's branches
repo_list_collaborators	Get /repos/{owner}/{repo}/collaborators	List a repository's collaborators
repo_list_git_hooks	Get /repos/{owner}/{repo}/hooks/git	List the Git hooks in a repository
repo_list_git_refs	Get /repos/{owner}/{repo}/git/refs/{ref}	Get specified ref or filtered repository's refs
repo_list_hooks	Get /repos/{owner}/{repo}/hooks	List the hooks in a repository
repo_list_keys	Get /repos/{owner}/{repo}/keys	List a repository's keys
repo_list_pull_requests	Get /repos/{owner}/{repo}/pulls	List a repo's pull requests
repo_list_release_attachments	Get /repos/{owner}/{repo}/releases/{id}/assets	List release's attachments
repo_list_releases	Get /repos/{owner}/{repo}/releases	List a repo's releases
repo_list_stargazers	Get /repos/{owner}/{repo}/stargazers	List a repo's stargazers
repo_list_statuses	Get /repos/{owner}/{repo}/statuses/{sha}	Get a commit's statuses
repo_list_subscribers	Get /repos/{owner}/{repo}/subscribers	List a repo's watchers
repo_list_tags	Get /repos/{owner}/{repo}/tags	List a repository's tags
repo_list_topics	Get /repos/{owner}/{repo}/topics	Get list of topics that a repository has
repo_merge_pull_request	Post /repos/{owner}/{repo}/pulls/{index}/merge	Merge a pull request
repo_migrate	Post /repos/migrate	Migrate a remote git repository
repo_mirror_sync	Post /repos/{owner}/{repo}/mirror-sync	Sync a mirrored repository
repo_pull_request_is_merged	Get /repos/{owner}/{repo}/pulls/{index}/merge	Check if a pull request has been merged
repo_search	Get /repos/search	Search for repositories
repo_signing_key	Get /repos/{owner}/{repo}/signing-key.gpg	Get signing-key.gpg for given repository
repo_test_hook	Post /repos/{owner}/{repo}/hooks/{id}/tests	Test a push webhook
repo_tracked_times	Get /repos/{owner}/{repo}/times	List a repo's tracked times
repo_update_file	Put /repos/{owner}/{repo}/contents/{filepath}	Update a file in a repository
repo_update_topics	Put /repos/{owner}/{repo}/topics	Replace list of topics for a repository
topic_search	Get /topics/search	search topics via keyword
user_current_check_subscription	Get /repos/{owner}/{repo}/subscription	Check if the current user is watching a repo
user_current_delete_subscription	Delete /repos/{owner}/{repo}/subscription	Unwatch a repo
user_current_put_subscription	Put /repos/{owner}/{repo}/subscription	Watch a repo

create_current_user_repo

::models::Repository create_current_user_repo(ctx, ctx, ctx, ctx, ctx, ctx, optional) Create a repository

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
body	CreateRepoOption

Return type

::models::Repository

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]

create_fork

::models::Repository create_fork(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, optional) Fork a repository

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo to fork
repo	String	name of the repo to fork
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
owner	String	owner of the repo to fork
repo	String	name of the repo to fork
body	CreateForkOption

Return type

::models::Repository

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]

get_blob

::models::GitBlobResponse get_blob(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, sha) Gets the blob of a repository.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
sha	String	sha of the commit

Return type

::models::GitBlobResponse

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]

get_tag

::models::AnnotatedTag get_tag(ctx, ctx, ctx, ctx, ctx, 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 containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
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

::models::AnnotatedTag

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]

get_tree

::models::GitTreeResponse get_tree(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, sha, optional) Gets the tree of a repository.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
sha	String	sha of the commit
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
owner	String	owner of the repo
repo	String	name of the repo
sha	String	sha of the commit
recursive	bool	show all directories and files
page	i32	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
per_page	i32	number of items per page; default is 1000 or what is set in app.ini as DEFAULT_GIT_TREES_PER_PAGE

Return type

::models::GitTreeResponse

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]

list_forks

Vec<::models::Repository> list_forks(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo) List a repository's forks

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo

Return type

Vec<::models::Repository>

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]

repo_add_collaborator

repo_add_collaborator(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, collaborator, optional) Add a collaborator to a repository

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
collaborator	String	username of the collaborator to add
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
owner	String	owner of the repo
repo	String	name of the repo
collaborator	String	username of the collaborator to add
body	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]

repo_add_topc

repo_add_topc(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, topic) Add a topic to a repository

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
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]

repo_check_collaborator

repo_check_collaborator(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, collaborator) Check if a user is a collaborator of a repository

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
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]

repo_create_file

::models::FileResponse repo_create_file(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, filepath, body) Create a file in a repository

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
filepath	String	path of the file to create
body	CreateFileOptions

Return type

::models::FileResponse

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]

repo_create_hook

::models::Hook repo_create_hook(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, optional) Create a hook

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
owner	String	owner of the repo
repo	String	name of the repo
body	CreateHookOption

Return type

::models::Hook

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]

repo_create_key

::models::DeployKey repo_create_key(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, optional) Add a key to a repository

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
owner	String	owner of the repo
repo	String	name of the repo
body	CreateKeyOption

Return type

::models::DeployKey

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]

repo_create_pull_request

::models::PullRequest repo_create_pull_request(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, optional) Create a pull request

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
owner	String	owner of the repo
repo	String	name of the repo
body	CreatePullRequestOption

Return type

::models::PullRequest

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]

repo_create_release

::models::Release repo_create_release(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, optional) Create a release

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
owner	String	owner of the repo
repo	String	name of the repo
body	CreateReleaseOption

Return type

::models::Release

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]

repo_create_release_attachment

::models::Attachment repo_create_release_attachment(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, id, attachment, optional) Create a release attachment

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
id	i64	id of the release
attachment	File	attachment to upload
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
owner	String	owner of the repo
repo	String	name of the repo
id	i64	id of the release
attachment	File	attachment to upload
name	String	name of the attachment

Return type

::models::Attachment

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]

repo_create_status

::models::Status repo_create_status(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, sha, optional) Create a commit status

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
sha	String	sha of the commit
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
owner	String	owner of the repo
repo	String	name of the repo
sha	String	sha of the commit
body	CreateStatusOption

Return type

::models::Status

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]

repo_delete

repo_delete(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo) Delete a repository

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
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]

repo_delete_collaborator

repo_delete_collaborator(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, collaborator) Delete a collaborator from a repository

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
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]

repo_delete_file

::models::FileDeleteResponse repo_delete_file(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, filepath, body) Delete a file in a repository

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
filepath	String	path of the file to delete
body	DeleteFileOptions

Return type

::models::FileDeleteResponse

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]

repo_delete_git_hook

repo_delete_git_hook(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, id) Delete a Git hook in a repository

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
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]

repo_delete_hook

repo_delete_hook(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, id) Delete a hook in a repository

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
id	i64	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]

repo_delete_key

repo_delete_key(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, id) Delete a key from a repository

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
id	i64	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]

repo_delete_release

repo_delete_release(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, id) Delete a release

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
id	i64	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]

repo_delete_release_attachment

repo_delete_release_attachment(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, id, attachment_id) Delete a release attachment

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
id	i64	id of the release
attachment_id	i64	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]

repo_delete_topic

repo_delete_topic(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, topic) Delete a topic from a repository

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
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]

repo_edit

::models::Repository repo_edit(ctx, ctx, ctx, ctx, ctx, 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 containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo to edit
repo	String	name of the repo to edit
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
owner	String	owner of the repo to edit
repo	String	name of the repo to edit
body	EditRepoOption	Properties of a repo that you can edit

Return type

::models::Repository

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]

repo_edit_git_hook

::models::GitHook repo_edit_git_hook(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, id, optional) Edit a Git hook in a repository

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
id	String	id of the hook to get
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
owner	String	owner of the repo
repo	String	name of the repo
id	String	id of the hook to get
body	EditGitHookOption

Return type

::models::GitHook

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]

repo_edit_hook

::models::Hook repo_edit_hook(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, id, optional) Edit a hook in a repository

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
id	i64	index of the hook
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
owner	String	owner of the repo
repo	String	name of the repo
id	i64	index of the hook
body	EditHookOption

Return type

::models::Hook

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]

repo_edit_pull_request

::models::PullRequest repo_edit_pull_request(ctx, ctx, ctx, ctx, ctx, 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 containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
index	i64	index of the pull request to edit
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
owner	String	owner of the repo
repo	String	name of the repo
index	i64	index of the pull request to edit
body	EditPullRequestOption

Return type

::models::PullRequest

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]

repo_edit_release

::models::Release repo_edit_release(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, id, optional) Update a release

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
id	i64	id of the release to edit
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
owner	String	owner of the repo
repo	String	name of the repo
id	i64	id of the release to edit
body	EditReleaseOption

Return type

::models::Release

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]

repo_edit_release_attachment

::models::Attachment repo_edit_release_attachment(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, id, attachment_id, optional) Edit a release attachment

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
id	i64	id of the release
attachment_id	i64	id of the attachment to edit
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
owner	String	owner of the repo
repo	String	name of the repo
id	i64	id of the release
attachment_id	i64	id of the attachment to edit
body	EditAttachmentOptions

Return type

::models::Attachment

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]

repo_get

::models::Repository repo_get(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo) Get a repository

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo

Return type

::models::Repository

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]

repo_get_all_commits

Vec<::models::Commit> repo_get_all_commits(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, optional) Get a list of all commits from a repository

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
owner	String	owner of the repo
repo	String	name of the repo
sha	String	SHA or branch to start listing commits from (usually 'master')
page	i32	page number of requested commits

Return type

Vec<::models::Commit>

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]

repo_get_archive

repo_get_archive(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, archive) Get an archive of a repository

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
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]

repo_get_branch

::models::Branch repo_get_branch(ctx, ctx, ctx, ctx, ctx, 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 containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
branch	String	branch to get

Return type

::models::Branch

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]

repo_get_by_id

::models::Repository repo_get_by_id(ctx, ctx, ctx, ctx, ctx, ctx, id) Get a repository by id

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
id	i64	id of the repo to get

Return type

::models::Repository

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]

repo_get_combined_status_by_ref

::models::Status repo_get_combined_status_by_ref(ctx, ctx, ctx, ctx, ctx, 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 containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
_ref	String	name of branch/tag/commit
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
owner	String	owner of the repo
repo	String	name of the repo
_ref	String	name of branch/tag/commit
page	i32	page number of results

Return type

::models::Status

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]

repo_get_contents

::models::ContentsResponse repo_get_contents(ctx, ctx, ctx, ctx, ctx, 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 containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
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	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
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
_ref	String	The name of the commit/branch/tag. Default the repository’s default branch (usually master)

Return type

::models::ContentsResponse

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]

repo_get_contents_list

Vec<::models::ContentsResponse> repo_get_contents_list(ctx, ctx, ctx, ctx, ctx, 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 containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
owner	String	owner of the repo
repo	String	name of the repo
_ref	String	The name of the commit/branch/tag. Default the repository’s default branch (usually master)

Return type

Vec<::models::ContentsResponse>

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]

repo_get_editor_config

repo_get_editor_config(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, filepath) Get the EditorConfig definitions of a file in a repository

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
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]

repo_get_git_hook

::models::GitHook repo_get_git_hook(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, id) Get a Git hook

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
id	String	id of the hook to get

Return type

::models::GitHook

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]

repo_get_hook

::models::Hook repo_get_hook(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, id) Get a hook

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
id	i64	id of the hook to get

Return type

::models::Hook

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]

repo_get_key

::models::DeployKey repo_get_key(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, id) Get a repository's key by id

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
id	i64	id of the key to get

Return type

::models::DeployKey

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]

repo_get_pull_request

::models::PullRequest repo_get_pull_request(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, index) Get a pull request

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
index	i64	index of the pull request to get

Return type

::models::PullRequest

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]

repo_get_raw_file

repo_get_raw_file(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, filepath) Get a file from a repository

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
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]

repo_get_release

::models::Release repo_get_release(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, id) Get a release

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
id	i64	id of the release to get

Return type

::models::Release

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]

repo_get_release_attachment

::models::Attachment repo_get_release_attachment(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, id, attachment_id) Get a release attachment

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
id	i64	id of the release
attachment_id	i64	id of the attachment to get

Return type

::models::Attachment

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]

repo_get_single_commit

::models::Commit repo_get_single_commit(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, sha) Get a single commit from a repository

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
sha	String	the commit hash

Return type

::models::Commit

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]

repo_list_all_git_refs

Vec<::models::Reference> repo_list_all_git_refs(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo) Get specified ref or filtered repository's refs

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo

Return type

Vec<::models::Reference>

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]

repo_list_branches

Vec<::models::Branch> repo_list_branches(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo) List a repository's branches

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo

Return type

Vec<::models::Branch>

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]

repo_list_collaborators

Vec<::models::User> repo_list_collaborators(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo) List a repository's collaborators

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo

Return type

Vec<::models::User>

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]

repo_list_git_hooks

Vec<::models::GitHook> repo_list_git_hooks(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo) List the Git hooks in a repository

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo

Return type

Vec<::models::GitHook>

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]

repo_list_git_refs

Vec<::models::Reference> repo_list_git_refs(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, _ref) Get specified ref or filtered repository's refs

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
_ref	String	part or full name of the ref

Return type

Vec<::models::Reference>

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]

repo_list_hooks

Vec<::models::Hook> repo_list_hooks(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo) List the hooks in a repository

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo

Return type

Vec<::models::Hook>

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]

repo_list_keys

Vec<::models::DeployKey> repo_list_keys(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, optional) List a repository's keys

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
owner	String	owner of the repo
repo	String	name of the repo
key_id	i32	the key_id to search for
fingerprint	String	fingerprint of the key

Return type

Vec<::models::DeployKey>

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]

repo_list_pull_requests

Vec<::models::PullRequest> repo_list_pull_requests(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, optional) List a repo's pull requests

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
owner	String	owner of the repo
repo	String	name of the repo
page	i32	Page number
state	String	State of pull request: open or closed (optional)
sort	String	Type of sort
milestone	i64	ID of the milestone
labels	Vec<i64>	Label IDs

Return type

Vec<::models::PullRequest>

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]

repo_list_release_attachments

Vec<::models::Attachment> repo_list_release_attachments(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, id) List release's attachments

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
id	i64	id of the release

Return type

Vec<::models::Attachment>

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]

repo_list_releases

Vec<::models::Release> repo_list_releases(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, optional) List a repo's releases

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
owner	String	owner of the repo
repo	String	name of the repo
page	i32	page wants to load
per_page	i32	items count every page wants to load

Return type

Vec<::models::Release>

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]

repo_list_stargazers

Vec<::models::User> repo_list_stargazers(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo) List a repo's stargazers

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo

Return type

Vec<::models::User>

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]

repo_list_statuses

Vec<::models::Status> repo_list_statuses(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, sha, optional) Get a commit's statuses

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
sha	String	sha of the commit
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
owner	String	owner of the repo
repo	String	name of the repo
sha	String	sha of the commit
page	i32	page number of results
sort	String	type of sort
state	String	type of state

Return type

Vec<::models::Status>

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]

repo_list_subscribers

Vec<::models::User> repo_list_subscribers(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo) List a repo's watchers

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo

Return type

Vec<::models::User>

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]

repo_list_tags

Vec<::models::Tag> repo_list_tags(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo) List a repository's tags

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo

Return type

Vec<::models::Tag>

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]

repo_list_topics

::models::TopicName repo_list_topics(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo) Get list of topics that a repository has

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo

Return type

::models::TopicName

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]

repo_merge_pull_request

repo_merge_pull_request(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, index, optional) Merge a pull request

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
index	i64	index of the pull request to merge
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
owner	String	owner of the repo
repo	String	name of the repo
index	i64	index of the pull request to merge
body	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]

repo_migrate

::models::Repository repo_migrate(ctx, ctx, ctx, ctx, ctx, ctx, optional) Migrate a remote git repository

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
body	MigrateRepoForm

Return type

::models::Repository

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]

repo_mirror_sync

repo_mirror_sync(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo) Sync a mirrored repository

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
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]

repo_pull_request_is_merged

repo_pull_request_is_merged(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, index) Check if a pull request has been merged

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
index	i64	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]

repo_search

::models::SearchResults repo_search(ctx, ctx, ctx, ctx, ctx, ctx, optional) Search for repositories

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
q	String	keyword
topic	bool	Limit search to repositories with keyword as topic
include_desc	bool	include search of keyword within repository description
uid	i64	search only for repos that the user with the given id owns or contributes to
priority_owner_id	i64	repo owner to prioritize in the results
starred_by	i64	search only for repos that the user with the given id has starred
private	bool	include private repositories this user has access to (defaults to true)
template	bool	include template repositories this user has access to (defaults to true)
page	i32	page number of results to return (1-based)
limit	i32	page size of results, maximum page size is 50
mode	String	type of repository to search for. Supported values are "fork", "source", "mirror" and "collaborative"
exclusive	bool	if `uid` is given, search only for repos that the user owns
sort	String	sort repos by attribute. Supported values are "alpha", "created", "updated", "size", and "id". Default is "alpha"
order	String	sort order, either "asc" (ascending) or "desc" (descending). Default is "asc", ignored if "sort" is not specified.

Return type

::models::SearchResults

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]

repo_signing_key

String repo_signing_key(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo) Get signing-key.gpg for given repository

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
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]

repo_test_hook

repo_test_hook(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, id) Test a push webhook

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
id	i64	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]

repo_tracked_times

Vec<::models::TrackedTime> repo_tracked_times(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo) List a repo's tracked times

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo

Return type

Vec<::models::TrackedTime>

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]

repo_update_file

::models::FileResponse repo_update_file(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, filepath, body) Update a file in a repository

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
filepath	String	path of the file to update
body	UpdateFileOptions

Return type

::models::FileResponse

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]

repo_update_topics

repo_update_topics(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo, optional) Replace list of topics for a repository

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
owner	String	owner of the repo
repo	String	name of the repo
body	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]

topic_search

Vec<::models::TopicResponse> topic_search(ctx, ctx, ctx, ctx, ctx, ctx, q) search topics via keyword

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
q	String	keywords to search

Return type

Vec<::models::TopicResponse>

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]

user_current_check_subscription

::models::WatchInfo user_current_check_subscription(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo) Check if the current user is watching a repo

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo

Return type

::models::WatchInfo

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]

user_current_delete_subscription

user_current_delete_subscription(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo) Unwatch a repo

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
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]

user_current_put_subscription

::models::WatchInfo user_current_put_subscription(ctx, ctx, ctx, ctx, ctx, ctx, owner, repo) Watch a repo

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
owner	String	owner of the repo
repo	String	name of the repo

Return type

::models::WatchInfo

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]