gitea-rs/crates/gitea-client/docs/RepositoryApi.md

\RepositoryApi

All URIs are relative to /api/v1

Method	HTTP request	Description
accept_repo_transfer	POST /repos/{owner}/{repo}/transfer/accept	Accept a repo transfer
actions_disable_workflow	PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable	Disable a workflow
actions_dispatch_workflow	POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches	Create a workflow dispatch event
actions_enable_workflow	PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable	Enable a workflow
actions_get_workflow	GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}	Get a workflow
actions_list_repository_workflows	GET /repos/{owner}/{repo}/actions/workflows	List repository workflows
create_current_user_repo	POST /user/repos	Create a repository
create_fork	POST /repos/{owner}/{repo}/forks	Fork a repository
create_repo_variable	POST /repos/{owner}/{repo}/actions/variables/{variablename}	Create a repo-level variable
delete_action_run	DELETE /repos/{owner}/{repo}/actions/runs/{run}	Delete a workflow run
delete_artifact	DELETE /repos/{owner}/{repo}/actions/artifacts/{artifact_id}	Deletes a specific artifact for a workflow run
delete_repo_runner	DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}	Delete an repo-level runner
delete_repo_secret	DELETE /repos/{owner}/{repo}/actions/secrets/{secretname}	Delete a secret in a repository
delete_repo_variable	DELETE /repos/{owner}/{repo}/actions/variables/{variablename}	Delete a repo-level variable
download_actions_run_job_logs	GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs	Downloads the job logs for a workflow run
download_artifact	GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/zip	Downloads a specific artifact for a workflow run redirects to blob url
generate_repo	POST /repos/{template_owner}/{template_repo}/generate	Create a repository using a template
get_annotated_tag	GET /repos/{owner}/{repo}/git/tags/{sha}	Gets the tag object of an annotated tag (not lightweight tags)
get_artifact	GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}	Gets a specific artifact for a workflow run
get_artifacts	GET /repos/{owner}/{repo}/actions/artifacts	Lists all artifacts for a repository
get_artifacts_of_run	GET /repos/{owner}/{repo}/actions/runs/{run}/artifacts	Lists all artifacts for a repository run
get_blob	GET /repos/{owner}/{repo}/git/blobs/{sha}	Gets the blob of a repository.
get_repo_runner	GET /repos/{owner}/{repo}/actions/runners/{runner_id}	Get an repo-level runner
get_repo_runners	GET /repos/{owner}/{repo}/actions/runners	Get repo-level runners
get_repo_variable	GET /repos/{owner}/{repo}/actions/variables/{variablename}	Get a repo-level variable
get_repo_variables_list	GET /repos/{owner}/{repo}/actions/variables	Get repo-level variables list
get_tree	GET /repos/{owner}/{repo}/git/trees/{sha}	Gets the tree of a repository.
get_workflow_job	GET /repos/{owner}/{repo}/actions/jobs/{job_id}	Gets a specific workflow job for a workflow run
get_workflow_run	GET /repos/{owner}/{repo}/actions/runs/{run}	Gets a specific workflow run
get_workflow_runs	GET /repos/{owner}/{repo}/actions/runs	Lists all runs for a repository run
list_action_tasks	GET /repos/{owner}/{repo}/actions/tasks	List a repository's action tasks
list_forks	GET /repos/{owner}/{repo}/forks	List a repository's forks
list_workflow_jobs	GET /repos/{owner}/{repo}/actions/jobs	Lists all jobs for a repository
list_workflow_run_jobs	GET /repos/{owner}/{repo}/actions/runs/{run}/jobs	Lists all jobs for a workflow run
reject_repo_transfer	POST /repos/{owner}/{repo}/transfer/reject	Reject a repo transfer
repo_add_collaborator	PUT /repos/{owner}/{repo}/collaborators/{collaborator}	Add or Update a collaborator to a repository
repo_add_push_mirror	POST /repos/{owner}/{repo}/push_mirrors	add a push mirror to the repository
repo_add_team	PUT /repos/{owner}/{repo}/teams/{team}	Add a team to a repository
repo_add_topic	PUT /repos/{owner}/{repo}/topics/{topic}	Add a topic to a repository
repo_apply_diff_patch	POST /repos/{owner}/{repo}/diffpatch	Apply diff patch to repository
repo_cancel_scheduled_auto_merge	DELETE /repos/{owner}/{repo}/pulls/{index}/merge	Cancel the scheduled auto merge for the given pull request
repo_change_files	POST /repos/{owner}/{repo}/contents	Modify multiple files in a repository
repo_check_collaborator	GET /repos/{owner}/{repo}/collaborators/{collaborator}	Check if a user is a collaborator of a repository
repo_check_team	GET /repos/{owner}/{repo}/teams/{team}	Check if a team is assigned to a repository
repo_compare_diff	GET /repos/{owner}/{repo}/compare/{basehead}	Get commit comparison information
repo_create_branch	POST /repos/{owner}/{repo}/branches	Create a branch
repo_create_branch_protection	POST /repos/{owner}/{repo}/branch_protections	Create a branch protections for 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_pull_review	POST /repos/{owner}/{repo}/pulls/{index}/reviews	Create a review to an pull request
repo_create_pull_review_requests	POST /repos/{owner}/{repo}/pulls/{index}/requested_reviewers	create review requests for 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_runner_registration_token	POST /repos/{owner}/{repo}/actions/runners/registration-token	Get a repository's actions runner registration token
repo_create_status	POST /repos/{owner}/{repo}/statuses/{sha}	Create a commit status
repo_create_tag	POST /repos/{owner}/{repo}/tags	Create a new git tag in a repository
repo_create_tag_protection	POST /repos/{owner}/{repo}/tag_protections	Create a tag protections for a repository
repo_create_wiki_page	POST /repos/{owner}/{repo}/wiki/new	Create a wiki page
repo_delete	DELETE /repos/{owner}/{repo}	Delete a repository
repo_delete_avatar	DELETE /repos/{owner}/{repo}/avatar	Delete avatar
repo_delete_branch	DELETE /repos/{owner}/{repo}/branches/{branch}	Delete a specific branch from a repository
repo_delete_branch_protection	DELETE /repos/{owner}/{repo}/branch_protections/{name}	Delete a specific branch protection for the 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_pull_review	DELETE /repos/{owner}/{repo}/pulls/{index}/reviews/{id}	Delete a specific review from a pull request
repo_delete_pull_review_requests	DELETE /repos/{owner}/{repo}/pulls/{index}/requested_reviewers	cancel review requests for a pull request
repo_delete_push_mirror	DELETE /repos/{owner}/{repo}/push_mirrors/{name}	deletes a push mirror from a repository by remoteName
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_release_by_tag	DELETE /repos/{owner}/{repo}/releases/tags/{tag}	Delete a release by tag name
repo_delete_tag	DELETE /repos/{owner}/{repo}/tags/{tag}	Delete a repository's tag by name
repo_delete_tag_protection	DELETE /repos/{owner}/{repo}/tag_protections/{id}	Delete a specific tag protection for the repository
repo_delete_team	DELETE /repos/{owner}/{repo}/teams/{team}	Delete a team from a repository
repo_delete_topic	DELETE /repos/{owner}/{repo}/topics/{topic}	Delete a topic from a repository
repo_delete_wiki_page	DELETE /repos/{owner}/{repo}/wiki/page/{pageName}	Delete a wiki page
repo_dismiss_pull_review	POST /repos/{owner}/{repo}/pulls/{index}/reviews/{id}/dismissals	Dismiss a review for a pull request
repo_download_commit_diff_or_patch	GET /repos/{owner}/{repo}/git/commits/{sha}.{diffType}	Get a commit's diff or patch
repo_download_pull_diff_or_patch	GET /repos/{owner}/{repo}/pulls/{index}.{diffType}	Get a pull request diff or patch
repo_edit	PATCH /repos/{owner}/{repo}	Edit a repository's properties. Only fields that are set will be changed.
repo_edit_branch_protection	PATCH /repos/{owner}/{repo}/branch_protections/{name}	Edit a branch protections for a repository. 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_edit_tag_protection	PATCH /repos/{owner}/{repo}/tag_protections/{id}	Edit a tag protections for a repository. Only fields that are set will be changed
repo_edit_wiki_page	PATCH /repos/{owner}/{repo}/wiki/page/{pageName}	Edit a wiki page
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_assignees	GET /repos/{owner}/{repo}/assignees	Return all users that have write access and can be assigned to issues
repo_get_branch	GET /repos/{owner}/{repo}/branches/{branch}	Retrieve a specific branch from a repository, including its effective branch protection
repo_get_branch_protection	GET /repos/{owner}/{repo}/branch_protections/{name}	Get a specific branch protection for the repository
repo_get_by_id	GET /repositories/{id}	Get a repository by id
repo_get_combined_status_by_ref	GET /repos/{owner}/{repo}/commits/{ref}/status	Get a commit's combined status, by branch/tag/commit reference
repo_get_commit_pull_request	GET /repos/{owner}/{repo}/commits/{sha}/pull	Get the merged pull request of the commit
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_ext	GET /repos/{owner}/{repo}/contents-ext/{filepath}	The extended "contents" API, to get file metadata and/or content, or list a directory.
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_file_contents	GET /repos/{owner}/{repo}/file-contents	Get the metadata and contents of requested files
repo_get_file_contents_post	POST /repos/{owner}/{repo}/file-contents	Get the metadata and contents of requested files
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_issue_config	GET /repos/{owner}/{repo}/issue_config	Returns the issue config for a repo
repo_get_issue_templates	GET /repos/{owner}/{repo}/issue_templates	Get available issue templates for a repository
repo_get_key	GET /repos/{owner}/{repo}/keys/{id}	Get a repository's key by id
repo_get_languages	GET /repos/{owner}/{repo}/languages	Get languages and number of bytes of code written
repo_get_latest_release	GET /repos/{owner}/{repo}/releases/latest	Gets the most recent non-prerelease, non-draft release of a repository, sorted by created_at
repo_get_licenses	GET /repos/{owner}/{repo}/licenses	Get repo licenses
repo_get_note	GET /repos/{owner}/{repo}/git/notes/{sha}	Get a note corresponding to a single commit from a repository
repo_get_pull_request	GET /repos/{owner}/{repo}/pulls/{index}	Get a pull request
repo_get_pull_request_by_base_head	GET /repos/{owner}/{repo}/pulls/{base}/{head}	Get a pull request by base and head
repo_get_pull_request_commits	GET /repos/{owner}/{repo}/pulls/{index}/commits	Get commits for a pull request
repo_get_pull_request_files	GET /repos/{owner}/{repo}/pulls/{index}/files	Get changed files for a pull request
repo_get_pull_review	GET /repos/{owner}/{repo}/pulls/{index}/reviews/{id}	Get a specific review for a pull request
repo_get_pull_review_comments	GET /repos/{owner}/{repo}/pulls/{index}/reviews/{id}/comments	Get a specific review for a pull request
repo_get_push_mirror_by_remote_name	GET /repos/{owner}/{repo}/push_mirrors/{name}	Get push mirror of the repository by remoteName
repo_get_raw_file	GET /repos/{owner}/{repo}/raw/{filepath}	Get a file from a repository
repo_get_raw_file_or_lfs	GET /repos/{owner}/{repo}/media/{filepath}	Get a file or it's LFS object 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_release_by_tag	GET /repos/{owner}/{repo}/releases/tags/{tag}	Get a release by tag name
repo_get_repo_permissions	GET /repos/{owner}/{repo}/collaborators/{collaborator}/permission	Get repository permissions for a user
repo_get_reviewers	GET /repos/{owner}/{repo}/reviewers	Return all users that can be requested to review in this repo
repo_get_runner_registration_token	GET /repos/{owner}/{repo}/actions/runners/registration-token	Get a repository's actions runner registration token
repo_get_single_commit	GET /repos/{owner}/{repo}/git/commits/{sha}	Get a single commit from a repository
repo_get_tag	GET /repos/{owner}/{repo}/tags/{tag}	Get the tag of a repository by tag name
repo_get_tag_protection	GET /repos/{owner}/{repo}/tag_protections/{id}	Get a specific tag protection for the repository
repo_get_wiki_page	GET /repos/{owner}/{repo}/wiki/page/{pageName}	Get a wiki page
repo_get_wiki_page_revisions	GET /repos/{owner}/{repo}/wiki/revisions/{pageName}	Get revisions of a wiki page
repo_get_wiki_pages	GET /repos/{owner}/{repo}/wiki/pages	Get all wiki pages
repo_list_actions_secrets	GET /repos/{owner}/{repo}/actions/secrets	List an repo's actions secrets
repo_list_activity_feeds	GET /repos/{owner}/{repo}/activities/feeds	List a repository's activity feeds
repo_list_all_git_refs	GET /repos/{owner}/{repo}/git/refs	Get specified ref or filtered repository's refs
repo_list_branch_protection	GET /repos/{owner}/{repo}/branch_protections	List branch protections for a repository
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_pinned_issues	GET /repos/{owner}/{repo}/issues/pinned	List a repo's pinned issues
repo_list_pinned_pull_requests	GET /repos/{owner}/{repo}/pulls/pinned	List a repo's pinned pull requests
repo_list_pull_requests	GET /repos/{owner}/{repo}/pulls	List a repo's pull requests
repo_list_pull_reviews	GET /repos/{owner}/{repo}/pulls/{index}/reviews	List all reviews for a pull request
repo_list_push_mirrors	GET /repos/{owner}/{repo}/push_mirrors	Get all push mirrors of the repository
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_statuses_by_ref	GET /repos/{owner}/{repo}/commits/{ref}/statuses	Get a commit's statuses, by branch/tag/commit reference
repo_list_subscribers	GET /repos/{owner}/{repo}/subscribers	List a repo's watchers
repo_list_tag_protection	GET /repos/{owner}/{repo}/tag_protections	List tag protections for a repository
repo_list_tags	GET /repos/{owner}/{repo}/tags	List a repository's tags
repo_list_teams	GET /repos/{owner}/{repo}/teams	List a repository's teams
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_merge_upstream	POST /repos/{owner}/{repo}/merge-upstream	Merge a branch from upstream
repo_migrate	POST /repos/migrate	Migrate a remote git repository
repo_mirror_sync	POST /repos/{owner}/{repo}/mirror-sync	Sync a mirrored repository
repo_new_pin_allowed	GET /repos/{owner}/{repo}/new_pin_allowed	Returns if new Issue Pins are allowed
repo_pull_request_is_merged	GET /repos/{owner}/{repo}/pulls/{index}/merge	Check if a pull request has been merged
repo_push_mirror_sync	POST /repos/{owner}/{repo}/push_mirrors-sync	Sync all push mirrored repository
repo_rename_branch	PATCH /repos/{owner}/{repo}/branches/{branch}	Rename a branch
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_signing_key_ssh	GET /repos/{owner}/{repo}/signing-key.pub	Get signing-key.pub for given repository
repo_submit_pull_review	POST /repos/{owner}/{repo}/pulls/{index}/reviews/{id}	Submit a pending review to an pull request
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_transfer	POST /repos/{owner}/{repo}/transfer	Transfer a repo ownership
repo_un_dismiss_pull_review	POST /repos/{owner}/{repo}/pulls/{index}/reviews/{id}/undismissals	Cancel to dismiss a review for a pull request
repo_update_avatar	POST /repos/{owner}/{repo}/avatar	Update avatar
repo_update_branch_protection_priories	POST /repos/{owner}/{repo}/branch_protections/priority	Update the priorities of branch protections for a repository.
repo_update_file	PUT /repos/{owner}/{repo}/contents/{filepath}	Update a file in a repository
repo_update_pull_request	POST /repos/{owner}/{repo}/pulls/{index}/update	Merge PR's baseBranch into headBranch
repo_update_topics	PUT /repos/{owner}/{repo}/topics	Replace list of topics for a repository
repo_validate_issue_config	GET /repos/{owner}/{repo}/issue_config/validate	Returns the validation information for a issue config
topic_search	GET /topics/search	search topics via keyword
update_repo_secret	PUT /repos/{owner}/{repo}/actions/secrets/{secretname}	Create or Update a secret value in a repository
update_repo_variable	PUT /repos/{owner}/{repo}/actions/variables/{variablename}	Update a repo-level variable
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
user_tracked_times	GET /repos/{owner}/{repo}/times/{user}	List a user's tracked times in a repo

accept_repo_transfer

models::Repository accept_repo_transfer(owner, repo) Accept a repo transfer

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo to transfer	[required]
repo	String	name of the repo to transfer	[required]

Return type

models::Repository

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

actions_disable_workflow

actions_disable_workflow(owner, repo, workflow_id) Disable a workflow

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
workflow_id	String	id of the workflow	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

actions_dispatch_workflow

actions_dispatch_workflow(owner, repo, workflow_id, body) Create a workflow dispatch event

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
workflow_id	String	id of the workflow	[required]
body	Option<CreateActionWorkflowDispatch>

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: application/json, text/plain
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

actions_enable_workflow

actions_enable_workflow(owner, repo, workflow_id) Enable a workflow

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
workflow_id	String	id of the workflow	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

actions_get_workflow

models::ActionWorkflow actions_get_workflow(owner, repo, workflow_id) Get a workflow

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
workflow_id	String	id of the workflow	[required]

Return type

models::ActionWorkflow

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

actions_list_repository_workflows

models::ActionWorkflowResponse actions_list_repository_workflows(owner, repo) List repository workflows

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]

Return type

models::ActionWorkflowResponse

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_current_user_repo

models::Repository create_current_user_repo(body) Create a repository

Parameters

Name	Type	Description	Required	Notes
body	Option<CreateRepoOption>

Return type

models::Repository

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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(owner, repo, body) Fork a repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo to fork	[required]
repo	String	name of the repo to fork	[required]
body	Option<CreateForkOption>

Return type

models::Repository

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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]

create_repo_variable

create_repo_variable(owner, repo, variablename, body) Create a repo-level variable

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repository	[required]
variablename	String	name of the variable	[required]
body	Option<CreateVariableOption>

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: application/json, text/plain
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_action_run

delete_action_run(owner, repo, run) Delete a workflow run

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repository	[required]
run	i32	runid of the workflow run	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_artifact

delete_artifact(owner, repo, artifact_id) Deletes a specific artifact for a workflow run

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repository	[required]
artifact_id	String	id of the artifact	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_repo_runner

delete_repo_runner(owner, repo, runner_id) Delete an repo-level runner

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
runner_id	String	id of the runner	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_repo_secret

delete_repo_secret(owner, repo, secretname) Delete a secret in a repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repository	[required]
repo	String	name of the repository	[required]
secretname	String	name of the secret	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_repo_variable

models::ActionVariable delete_repo_variable(owner, repo, variablename) Delete a repo-level variable

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repository	[required]
variablename	String	name of the variable	[required]

Return type

models::ActionVariable

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

download_actions_run_job_logs

download_actions_run_job_logs(owner, repo, job_id) Downloads the job logs for a workflow run

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repository	[required]
job_id	i32	id of the job	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

download_artifact

download_artifact(owner, repo, artifact_id) Downloads a specific artifact for a workflow run redirects to blob url

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repository	[required]
artifact_id	String	id of the artifact	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

generate_repo

models::Repository generate_repo(template_owner, template_repo, body) Create a repository using a template

Parameters

Name	Type	Description	Required	Notes
template_owner	String	owner of the template repository	[required]
template_repo	String	name of the template repository	[required]
body	Option<GenerateRepoOption>

Return type

models::Repository

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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]

get_annotated_tag

models::AnnotatedTag get_annotated_tag(owner, repo, sha) Gets the tag object of an annotated tag (not lightweight tags)

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
sha	String	sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags.	[required]

Return type

models::AnnotatedTag

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_artifact

models::ActionArtifact get_artifact(owner, repo, artifact_id) Gets a specific artifact for a workflow run

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repository	[required]
artifact_id	String	id of the artifact	[required]

Return type

models::ActionArtifact

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_artifacts

models::ActionArtifactsResponse get_artifacts(owner, repo, name) Lists all artifacts for a repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repository	[required]
name	Option<String>	name of the artifact

Return type

models::ActionArtifactsResponse

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_artifacts_of_run

models::ActionArtifactsResponse get_artifacts_of_run(owner, repo, run, name) Lists all artifacts for a repository run

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repository	[required]
run	i32	runid of the workflow run	[required]
name	Option<String>	name of the artifact

Return type

models::ActionArtifactsResponse

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_blob

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

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
sha	String	sha of the commit	[required]

Return type

models::GitBlobResponse

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_repo_runner

get_repo_runner(owner, repo, runner_id) Get an repo-level runner

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
runner_id	String	id of the runner	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_repo_runners

get_repo_runners(owner, repo) Get repo-level runners

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_repo_variable

models::ActionVariable get_repo_variable(owner, repo, variablename) Get a repo-level variable

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repository	[required]
variablename	String	name of the variable	[required]

Return type

models::ActionVariable

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_repo_variables_list

Vecmodels::ActionVariable get_repo_variables_list(owner, repo, page, limit) Get repo-level variables list

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repository	[required]
page	Option<i32>	page number of results to return (1-based)
limit	Option<i32>	page size of results

Return type

Vecmodels::ActionVariable

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_tree

models::GitTreeResponse get_tree(owner, repo, sha, recursive, page, per_page) Gets the tree of a repository.

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
sha	String	sha of the commit	[required]
recursive	Option<bool>	show all directories and files
page	Option<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	Option<i32>	number of items per page

Return type

models::GitTreeResponse

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_workflow_job

models::ActionWorkflowJob get_workflow_job(owner, repo, job_id) Gets a specific workflow job for a workflow run

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repository	[required]
job_id	String	id of the job	[required]

Return type

models::ActionWorkflowJob

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_workflow_run

models::ActionWorkflowRun get_workflow_run(owner, repo, run) Gets a specific workflow run

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repository	[required]
run	String	id of the run	[required]

Return type

models::ActionWorkflowRun

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_workflow_runs

models::ActionWorkflowRunsResponse get_workflow_runs(owner, repo, event, branch, status, actor, head_sha, page, limit) Lists all runs for a repository run

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repository	[required]
event	Option<String>	workflow event name
branch	Option<String>	workflow branch
status	Option<String>	workflow status (pending, queued, in_progress, failure, success, skipped)
actor	Option<String>	triggered by user
head_sha	Option<String>	triggering sha of the workflow run
page	Option<i32>	page number of results to return (1-based)
limit	Option<i32>	page size of results

Return type

models::ActionWorkflowRunsResponse

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_action_tasks

models::ActionTaskResponse list_action_tasks(owner, repo, page, limit) List a repository's action tasks

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
page	Option<i32>	page number of results to return (1-based)
limit	Option<i32>	page size of results, default maximum page size is 50

Return type

models::ActionTaskResponse

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_forks

Vecmodels::Repository list_forks(owner, repo, page, limit) List a repository's forks

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
page	Option<i32>	page number of results to return (1-based)
limit	Option<i32>	page size of results

Return type

Vecmodels::Repository

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_workflow_jobs

models::ActionWorkflowJobsResponse list_workflow_jobs(owner, repo, status, page, limit) Lists all jobs for a repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repository	[required]
status	Option<String>	workflow status (pending, queued, in_progress, failure, success, skipped)
page	Option<i32>	page number of results to return (1-based)
limit	Option<i32>	page size of results

Return type

models::ActionWorkflowJobsResponse

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_workflow_run_jobs

models::ActionWorkflowJobsResponse list_workflow_run_jobs(owner, repo, run, status, page, limit) Lists all jobs for a workflow run

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repository	[required]
run	i32	runid of the workflow run	[required]
status	Option<String>	workflow status (pending, queued, in_progress, failure, success, skipped)
page	Option<i32>	page number of results to return (1-based)
limit	Option<i32>	page size of results

Return type

models::ActionWorkflowJobsResponse

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

reject_repo_transfer

models::Repository reject_repo_transfer(owner, repo) Reject a repo transfer

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo to transfer	[required]
repo	String	name of the repo to transfer	[required]

Return type

models::Repository

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_add_collaborator

repo_add_collaborator(owner, repo, collaborator, body) Add or Update a collaborator to a repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
collaborator	String	username of the user to add or update as a collaborator	[required]
body	Option<AddCollaboratorOption>

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: application/json, text/plain
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_add_push_mirror

models::PushMirror repo_add_push_mirror(owner, repo, body) add a push mirror to the repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
body	Option<CreatePushMirrorOption>

Return type

models::PushMirror

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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_add_team

repo_add_team(owner, repo, team) Add a team to a repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
team	String	team name	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_add_topic

repo_add_topic(owner, repo, topic) Add a topic to a repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
topic	String	name of the topic to add	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_apply_diff_patch

models::FileResponse repo_apply_diff_patch(owner, repo, body) Apply diff patch to repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
body	ApplyDiffPatchFileOptions		[required]

Return type

models::FileResponse

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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_cancel_scheduled_auto_merge

repo_cancel_scheduled_auto_merge(owner, repo, index) Cancel the scheduled auto merge for the given pull request

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
index	i64	index of the pull request to merge	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_change_files

models::FilesResponse repo_change_files(owner, repo, body) Modify multiple files in a repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
body	ChangeFilesOptions		[required]

Return type

models::FilesResponse

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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_check_collaborator

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

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
collaborator	String	username of the user to check for being a collaborator	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_check_team

models::Team repo_check_team(owner, repo, team) Check if a team is assigned to a repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
team	String	team name	[required]

Return type

models::Team

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_compare_diff

models::Compare repo_compare_diff(owner, repo, basehead) Get commit comparison information

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
basehead	String	compare two branches or commits	[required]

Return type

models::Compare

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_create_branch

models::Branch repo_create_branch(owner, repo, body) Create a branch

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
body	Option<CreateBranchRepoOption>

Return type

models::Branch

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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_branch_protection

models::BranchProtection repo_create_branch_protection(owner, repo, body) Create a branch protections for a repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
body	Option<CreateBranchProtectionOption>

Return type

models::BranchProtection

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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_file

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

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
filepath	String	path of the file to create	[required]
body	CreateFileOptions		[required]

Return type

models::FileResponse

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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(owner, repo, body) Create a hook

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
body	Option<CreateHookOption>

Return type

models::Hook

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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(owner, repo, body) Add a key to a repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
body	Option<CreateKeyOption>

Return type

models::DeployKey

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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(owner, repo, body) Create a pull request

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
body	Option<CreatePullRequestOption>

Return type

models::PullRequest

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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_review

models::PullReview repo_create_pull_review(owner, repo, index, body) Create a review to an pull request

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
index	i64	index of the pull request	[required]
body	CreatePullReviewOptions		[required]

Return type

models::PullReview

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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_pull_review_requests

Vecmodels::PullReview repo_create_pull_review_requests(owner, repo, index, body) create review requests for a pull request

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
index	i64	index of the pull request	[required]
body	PullReviewRequestOptions		[required]

Return type

Vecmodels::PullReview

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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_release

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

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
body	Option<CreateReleaseOption>

Return type

models::Release

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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(owner, repo, id, name, attachment) Create a release attachment

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
id	i64	id of the release	[required]
name	Option<String>	name of the attachment
attachment	Option<std::path::PathBuf>	attachment to upload

Return type

models::Attachment

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: multipart/form-data, application/octet-stream
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_create_runner_registration_token

repo_create_runner_registration_token(owner, repo) Get a repository's actions runner registration token

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_create_status

models::CommitStatus repo_create_status(owner, repo, sha, body) Create a commit status

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
sha	String	sha of the commit	[required]
body	Option<CreateStatusOption>

Return type

models::CommitStatus

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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_tag

models::Tag repo_create_tag(owner, repo, body) Create a new git tag in a repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
body	Option<CreateTagOption>

Return type

models::Tag

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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_tag_protection

models::TagProtection repo_create_tag_protection(owner, repo, body) Create a tag protections for a repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
body	Option<CreateTagProtectionOption>

Return type

models::TagProtection

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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_wiki_page

models::WikiPage repo_create_wiki_page(owner, repo, body) Create a wiki page

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
body	Option<CreateWikiPageOptions>

Return type

models::WikiPage

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: application/json
• Accept: application/json, text/html

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_delete

repo_delete(owner, repo) Delete a repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo to delete	[required]
repo	String	name of the repo to delete	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_delete_avatar

repo_delete_avatar(owner, repo) Delete avatar

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_delete_branch

repo_delete_branch(owner, repo, branch) Delete a specific branch from a repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
branch	String	branch to delete	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_delete_branch_protection

repo_delete_branch_protection(owner, repo, name) Delete a specific branch protection for the repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
name	String	name of protected branch	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_delete_collaborator

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

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
collaborator	String	username of the collaborator to delete	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_delete_file

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

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
filepath	String	path of the file to delete	[required]
body	DeleteFileOptions		[required]

Return type

models::FileDeleteResponse

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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(owner, repo, id) Delete a Git hook in a repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
id	String	id of the hook to get	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_delete_hook

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

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
id	i64	id of the hook to delete	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_delete_key

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

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
id	i64	id of the key to delete	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_delete_pull_review

repo_delete_pull_review(owner, repo, index, id) Delete a specific review from a pull request

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
index	i64	index of the pull request	[required]
id	i64	id of the review	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_delete_pull_review_requests

repo_delete_pull_review_requests(owner, repo, index, body) cancel review requests for a pull request

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
index	i64	index of the pull request	[required]
body	PullReviewRequestOptions		[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: application/json, text/plain
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_delete_push_mirror

repo_delete_push_mirror(owner, repo, name) deletes a push mirror from a repository by remoteName

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
name	String	remote name of the pushMirror	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_delete_release

repo_delete_release(owner, repo, id) Delete a release

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
id	i64	id of the release to delete	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_delete_release_attachment

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

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
id	i64	id of the release	[required]
attachment_id	i64	id of the attachment to delete	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_delete_release_by_tag

repo_delete_release_by_tag(owner, repo, tag) Delete a release by tag name

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
tag	String	tag name of the release to delete	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_delete_tag

repo_delete_tag(owner, repo, tag) Delete a repository's tag by name

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
tag	String	name of tag to delete	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_delete_tag_protection

repo_delete_tag_protection(owner, repo, id) Delete a specific tag protection for the repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
id	i32	id of protected tag	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_delete_team

repo_delete_team(owner, repo, team) Delete a team from a repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
team	String	team name	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_delete_topic

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

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
topic	String	name of the topic to delete	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_delete_wiki_page

repo_delete_wiki_page(owner, repo, page_name) Delete a wiki page

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
page_name	String	name of the page	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_dismiss_pull_review

models::PullReview repo_dismiss_pull_review(owner, repo, index, id, body) Dismiss a review for a pull request

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
index	i64	index of the pull request	[required]
id	i64	id of the review	[required]
body	DismissPullReviewOptions		[required]

Return type

models::PullReview

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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_download_commit_diff_or_patch

String repo_download_commit_diff_or_patch(owner, repo, sha, diff_type) Get a commit's diff or patch

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
sha	String	SHA of the commit to get	[required]
diff_type	String	whether the output is diff or patch	[required]

Return type

String

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_download_pull_diff_or_patch

String repo_download_pull_diff_or_patch(owner, repo, index, diff_type, binary) Get a pull request diff or patch

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
index	i64	index of the pull request to get	[required]
diff_type	String	whether the output is diff or patch	[required]
binary	Option<bool>	whether to include binary file changes. if true, the diff is applicable with git apply

Return type

String

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_edit

models::Repository repo_edit(owner, repo, body) Edit a repository's properties. Only fields that are set will be changed.

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo to edit	[required]
repo	String	name of the repo to edit	[required]
body	Option<EditRepoOption>	Properties of a repo that you can edit

Return type

models::Repository

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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_branch_protection

models::BranchProtection repo_edit_branch_protection(owner, repo, name, body) Edit a branch protections for a repository. Only fields that are set will be changed

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
name	String	name of protected branch	[required]
body	Option<EditBranchProtectionOption>

Return type

models::BranchProtection

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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_git_hook

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

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
id	String	id of the hook to get	[required]
body	Option<EditGitHookOption>

Return type

models::GitHook

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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(owner, repo, id, body) Edit a hook in a repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
id	i64	index of the hook	[required]
body	Option<EditHookOption>

Return type

models::Hook

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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(owner, repo, index, body) Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
index	i64	index of the pull request to edit	[required]
body	Option<EditPullRequestOption>

Return type

models::PullRequest

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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(owner, repo, id, body) Update a release

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
id	i64	id of the release to edit	[required]
body	Option<EditReleaseOption>

Return type

models::Release

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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(owner, repo, id, attachment_id, body) Edit a release attachment

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
id	i64	id of the release	[required]
attachment_id	i64	id of the attachment to edit	[required]
body	Option<EditAttachmentOptions>

Return type

models::Attachment

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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_tag_protection

models::TagProtection repo_edit_tag_protection(owner, repo, id, body) Edit a tag protections for a repository. Only fields that are set will be changed

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
id	i32	id of protected tag	[required]
body	Option<EditTagProtectionOption>

Return type

models::TagProtection

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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_wiki_page

models::WikiPage repo_edit_wiki_page(owner, repo, page_name, body) Edit a wiki page

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
page_name	String	name of the page	[required]
body	Option<CreateWikiPageOptions>

Return type

models::WikiPage

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: application/json
• Accept: application/json, text/html

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get

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

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]

Return type

models::Repository

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get_all_commits

Vecmodels::Commit repo_get_all_commits(owner, repo, sha, path, since, until, stat, verification, files, page, limit, not) Get a list of all commits from a repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
sha	Option<String>	SHA or branch to start listing commits from (usually 'master')
path	Option<String>	filepath of a file/dir
since	Option<String>	Only commits after this date will be returned (ISO 8601 format)
until	Option<String>	Only commits before this date will be returned (ISO 8601 format)
stat	Option<bool>	include diff stats for every commit (disable for speedup, default 'true')
verification	Option<bool>	include verification for every commit (disable for speedup, default 'true')
files	Option<bool>	include a list of affected files for every commit (disable for speedup, default 'true')
page	Option<i32>	page number of results to return (1-based)
limit	Option<i32>	page size of results (ignored if used with 'path')
not	Option<String>	commits that match the given specifier will not be listed.

Return type

Vecmodels::Commit

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get_archive

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

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
archive	String	the git reference for download with attached archive format (e.g. master.zip)	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get_assignees

Vecmodels::User repo_get_assignees(owner, repo) Return all users that have write access and can be assigned to issues

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]

Return type

Vecmodels::User

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• 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(owner, repo, branch) Retrieve a specific branch from a repository, including its effective branch protection

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
branch	String	branch to get	[required]

Return type

models::Branch

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get_branch_protection

models::BranchProtection repo_get_branch_protection(owner, repo, name) Get a specific branch protection for the repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
name	String	name of protected branch	[required]

Return type

models::BranchProtection

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• 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(id) Get a repository by id

Parameters

Name	Type	Description	Required	Notes
id	i64	id of the repo to get	[required]

Return type

models::Repository

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get_combined_status_by_ref

models::CombinedStatus repo_get_combined_status_by_ref(owner, repo, r#ref, page, limit) Get a commit's combined status, by branch/tag/commit reference

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
r#ref	String	name of branch/tag/commit	[required]
page	Option<i32>	page number of results to return (1-based)
limit	Option<i32>	page size of results

Return type

models::CombinedStatus

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get_commit_pull_request

models::PullRequest repo_get_commit_pull_request(owner, repo, sha) Get the merged pull request of the commit

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
sha	String	SHA of the commit to get	[required]

Return type

models::PullRequest

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• 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(owner, repo, filepath, r#ref) Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir.

This API follows GitHub's design, and it is not easy to use. Recommend users to use the "contents-ext" API instead.

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
filepath	String	path of the dir, file, symlink or submodule in the repo	[required]
r#ref	Option<String>	The name of the commit/branch/tag. Default to the repository’s default branch.

Return type

models::ContentsResponse

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get_contents_ext

models::ContentsExtResponse repo_get_contents_ext(owner, repo, filepath, r#ref, includes) The extended "contents" API, to get file metadata and/or content, or list a directory.

It guarantees that only one of the response fields is set if the request succeeds. Users can pass "includes=file_content" or "includes=lfs_metadata" to retrieve more fields. "includes=file_content" only works for single file, if you need to retrieve file contents in batch, use "file-contents" API after listing the directory.

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
filepath	String	path of the dir, file, symlink or submodule in the repo. Swagger requires path parameter to be "required", you can leave it empty or pass a single dot (".") to get the root directory.	[required]
r#ref	Option<String>	the name of the commit/branch/tag, default to the repository’s default branch.
includes	Option<String>	By default this API's response only contains file's metadata. Use comma-separated "includes" options to retrieve more fields. Option "file_content" will try to retrieve the file content, "lfs_metadata" will try to retrieve LFS metadata, "commit_metadata" will try to retrieve commit metadata, and "commit_message" will try to retrieve commit message.

Return type

models::ContentsExtResponse

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get_contents_list

Vecmodels::ContentsResponse repo_get_contents_list(owner, repo, r#ref) Gets the metadata of all the entries of the root dir.

This API follows GitHub's design, and it is not easy to use. Recommend users to use our "contents-ext" API instead.

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
r#ref	Option<String>	The name of the commit/branch/tag. Default to the repository’s default branch.

Return type

Vecmodels::ContentsResponse

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• 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(owner, repo, filepath, r#ref) Get the EditorConfig definitions of a file in a repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
filepath	String	filepath of file to get	[required]
r#ref	Option<String>	The name of the commit/branch/tag. Default to the repository’s default branch.

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get_file_contents

Vecmodels::ContentsResponse repo_get_file_contents(owner, repo, body, r#ref) Get the metadata and contents of requested files

See the POST method. This GET method supports using JSON encoded request body in query parameter.

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
body	String	The JSON encoded body (see the POST request): {"files": ["filename1", "filename2"]}	[required]
r#ref	Option<String>	The name of the commit/branch/tag. Default to the repository’s default branch.

Return type

Vecmodels::ContentsResponse

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get_file_contents_post

Vecmodels::ContentsResponse repo_get_file_contents_post(owner, repo, body, r#ref) Get the metadata and contents of requested files

Uses automatic pagination based on default page size and max response size and returns the maximum allowed number of files. Files which could not be retrieved are null. Files which are too large are being returned with encoding == null, content == null and size > 0, they can be requested separately by using the download_url.

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
body	GetFilesOptions		[required]
r#ref	Option<String>	The name of the commit/branch/tag. Default to the repository’s default branch.

Return type

Vecmodels::ContentsResponse

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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(owner, repo, id) Get a Git hook

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
id	String	id of the hook to get	[required]

Return type

models::GitHook

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• 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(owner, repo, id) Get a hook

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
id	i64	id of the hook to get	[required]

Return type

models::Hook

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get_issue_config

models::IssueConfig repo_get_issue_config(owner, repo) Returns the issue config for a repo

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]

Return type

models::IssueConfig

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get_issue_templates

Vecmodels::IssueTemplate repo_get_issue_templates(owner, repo) Get available issue templates for a repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]

Return type

Vecmodels::IssueTemplate

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• 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(owner, repo, id) Get a repository's key by id

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
id	i64	id of the key to get	[required]

Return type

models::DeployKey

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get_languages

std::collections::HashMap<String, i64> repo_get_languages(owner, repo) Get languages and number of bytes of code written

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]

Return type

std::collections::HashMap<String, i64>

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get_latest_release

models::Release repo_get_latest_release(owner, repo) Gets the most recent non-prerelease, non-draft release of a repository, sorted by created_at

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]

Return type

models::Release

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get_licenses

Vec repo_get_licenses(owner, repo) Get repo licenses

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]

Return type

Vec

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get_note

models::Note repo_get_note(owner, repo, sha, verification, files) Get a note corresponding to a single commit from a repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
sha	String	a git ref or commit sha	[required]
verification	Option<bool>	include verification for every commit (disable for speedup, default 'true')
files	Option<bool>	include a list of affected files for every commit (disable for speedup, default 'true')

Return type

models::Note

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• 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(owner, repo, index) Get a pull request

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
index	i64	index of the pull request to get	[required]

Return type

models::PullRequest

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get_pull_request_by_base_head

models::PullRequest repo_get_pull_request_by_base_head(owner, repo, base, head) Get a pull request by base and head

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
base	String	base of the pull request to get	[required]
head	String	head of the pull request to get	[required]

Return type

models::PullRequest

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get_pull_request_commits

Vecmodels::Commit repo_get_pull_request_commits(owner, repo, index, page, limit, verification, files) Get commits for a pull request

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
index	i64	index of the pull request to get	[required]
page	Option<i32>	page number of results to return (1-based)
limit	Option<i32>	page size of results
verification	Option<bool>	include verification for every commit (disable for speedup, default 'true')
files	Option<bool>	include a list of affected files for every commit (disable for speedup, default 'true')

Return type

Vecmodels::Commit

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get_pull_request_files

Vecmodels::ChangedFile repo_get_pull_request_files(owner, repo, index, skip_to, whitespace, page, limit) Get changed files for a pull request

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
index	i64	index of the pull request to get	[required]
skip_to	Option<String>	skip to given file
whitespace	Option<String>	whitespace behavior
page	Option<i32>	page number of results to return (1-based)
limit	Option<i32>	page size of results

Return type

Vecmodels::ChangedFile

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get_pull_review

models::PullReview repo_get_pull_review(owner, repo, index, id) Get a specific review for a pull request

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
index	i64	index of the pull request	[required]
id	i64	id of the review	[required]

Return type

models::PullReview

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get_pull_review_comments

Vecmodels::PullReviewComment repo_get_pull_review_comments(owner, repo, index, id) Get a specific review for a pull request

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
index	i64	index of the pull request	[required]
id	i64	id of the review	[required]

Return type

Vecmodels::PullReviewComment

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get_push_mirror_by_remote_name

models::PushMirror repo_get_push_mirror_by_remote_name(owner, repo, name) Get push mirror of the repository by remoteName

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
name	String	remote name of push mirror	[required]

Return type

models::PushMirror

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get_raw_file

std::path::PathBuf repo_get_raw_file(owner, repo, filepath, r#ref) Get a file from a repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
filepath	String	path of the file to get, it should be "{ref}/{filepath}". If there is no ref could be inferred, it will be treated as the default branch	[required]
r#ref	Option<String>	The name of the commit/branch/tag. Default to the repository’s default branch

Return type

std::path::PathBuf

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get_raw_file_or_lfs

std::path::PathBuf repo_get_raw_file_or_lfs(owner, repo, filepath, r#ref) Get a file or it's LFS object from a repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
filepath	String	path of the file to get, it should be "{ref}/{filepath}". If there is no ref could be inferred, it will be treated as the default branch	[required]
r#ref	Option<String>	The name of the commit/branch/tag. Default to the repository’s default branch

Return type

std::path::PathBuf

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get_release

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

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
id	i64	id of the release to get	[required]

Return type

models::Release

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• 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(owner, repo, id, attachment_id) Get a release attachment

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
id	i64	id of the release	[required]
attachment_id	i64	id of the attachment to get	[required]

Return type

models::Attachment

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get_release_by_tag

models::Release repo_get_release_by_tag(owner, repo, tag) Get a release by tag name

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
tag	String	tag name of the release to get	[required]

Return type

models::Release

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get_repo_permissions

models::RepoCollaboratorPermission repo_get_repo_permissions(owner, repo, collaborator) Get repository permissions for a user

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
collaborator	String	username of the collaborator whose permissions are to be obtained	[required]

Return type

models::RepoCollaboratorPermission

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get_reviewers

Vecmodels::User repo_get_reviewers(owner, repo) Return all users that can be requested to review in this repo

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]

Return type

Vecmodels::User

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get_runner_registration_token

repo_get_runner_registration_token(owner, repo) Get a repository's actions runner registration token

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get_single_commit

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

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
sha	String	a git ref or commit sha	[required]
stat	Option<bool>	include diff stats for every commit (disable for speedup, default 'true')
verification	Option<bool>	include verification for every commit (disable for speedup, default 'true')
files	Option<bool>	include a list of affected files for every commit (disable for speedup, default 'true')

Return type

models::Commit

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get_tag

models::Tag repo_get_tag(owner, repo, tag) Get the tag of a repository by tag name

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
tag	String	name of tag	[required]

Return type

models::Tag

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get_tag_protection

models::TagProtection repo_get_tag_protection(owner, repo, id) Get a specific tag protection for the repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
id	i32	id of the tag protect to get	[required]

Return type

models::TagProtection

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get_wiki_page

models::WikiPage repo_get_wiki_page(owner, repo, page_name) Get a wiki page

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
page_name	String	name of the page	[required]

Return type

models::WikiPage

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get_wiki_page_revisions

models::WikiCommitList repo_get_wiki_page_revisions(owner, repo, page_name, page) Get revisions of a wiki page

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
page_name	String	name of the page	[required]
page	Option<i32>	page number of results to return (1-based)

Return type

models::WikiCommitList

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_get_wiki_pages

Vecmodels::WikiPageMetaData repo_get_wiki_pages(owner, repo, page, limit) Get all wiki pages

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
page	Option<i32>	page number of results to return (1-based)
limit	Option<i32>	page size of results

Return type

Vecmodels::WikiPageMetaData

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_list_actions_secrets

Vecmodels::Secret repo_list_actions_secrets(owner, repo, page, limit) List an repo's actions secrets

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repository	[required]
page	Option<i32>	page number of results to return (1-based)
limit	Option<i32>	page size of results

Return type

Vecmodels::Secret

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_list_activity_feeds

Vecmodels::Activity repo_list_activity_feeds(owner, repo, date, page, limit) List a repository's activity feeds

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
date	Option<String>	the date of the activities to be found
page	Option<i32>	page number of results to return (1-based)
limit	Option<i32>	page size of results

Return type

Vecmodels::Activity

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_list_all_git_refs

Vecmodels::Reference repo_list_all_git_refs(owner, repo) Get specified ref or filtered repository's refs

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]

Return type

Vecmodels::Reference

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_list_branch_protection

Vecmodels::BranchProtection repo_list_branch_protection(owner, repo) List branch protections for a repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]

Return type

Vecmodels::BranchProtection

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_list_branches

Vecmodels::Branch repo_list_branches(owner, repo, page, limit) List a repository's branches

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
page	Option<i32>	page number of results to return (1-based)
limit	Option<i32>	page size of results

Return type

Vecmodels::Branch

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_list_collaborators

Vecmodels::User repo_list_collaborators(owner, repo, page, limit) List a repository's collaborators

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
page	Option<i32>	page number of results to return (1-based)
limit	Option<i32>	page size of results

Return type

Vecmodels::User

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_list_git_hooks

Vecmodels::GitHook repo_list_git_hooks(owner, repo) List the Git hooks in a repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]

Return type

Vecmodels::GitHook

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_list_git_refs

Vecmodels::Reference repo_list_git_refs(owner, repo, r#ref) Get specified ref or filtered repository's refs

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
r#ref	String	part or full name of the ref	[required]

Return type

Vecmodels::Reference

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_list_hooks

Vecmodels::Hook repo_list_hooks(owner, repo, page, limit) List the hooks in a repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
page	Option<i32>	page number of results to return (1-based)
limit	Option<i32>	page size of results

Return type

Vecmodels::Hook

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_list_keys

Vecmodels::DeployKey repo_list_keys(owner, repo, key_id, fingerprint, page, limit) List a repository's keys

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
key_id	Option<i32>	the key_id to search for
fingerprint	Option<String>	fingerprint of the key
page	Option<i32>	page number of results to return (1-based)
limit	Option<i32>	page size of results

Return type

Vecmodels::DeployKey

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_list_pinned_issues

Vecmodels::Issue repo_list_pinned_issues(owner, repo) List a repo's pinned issues

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]

Return type

Vecmodels::Issue

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_list_pinned_pull_requests

Vecmodels::PullRequest repo_list_pinned_pull_requests(owner, repo) List a repo's pinned pull requests

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]

Return type

Vecmodels::PullRequest

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_list_pull_requests

Vecmodels::PullRequest repo_list_pull_requests(owner, repo, base_branch, state, sort, milestone, labels, poster, page, limit) List a repo's pull requests

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	Name of the repo	[required]
base_branch	Option<String>	Filter by target base branch of the pull request
state	Option<String>	State of pull request		[default to open]
sort	Option<String>	Type of sort
milestone	Option<i64>	ID of the milestone
labels	Option<Vec>	Label IDs
poster	Option<String>	Filter by pull request author
page	Option<i32>	Page number of results to return (1-based)		[default to 1]
limit	Option<i32>	Page size of results

Return type

Vecmodels::PullRequest

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_list_pull_reviews

Vecmodels::PullReview repo_list_pull_reviews(owner, repo, index, page, limit) List all reviews for a pull request

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
index	i64	index of the pull request	[required]
page	Option<i32>	page number of results to return (1-based)
limit	Option<i32>	page size of results

Return type

Vecmodels::PullReview

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_list_push_mirrors

Vecmodels::PushMirror repo_list_push_mirrors(owner, repo, page, limit) Get all push mirrors of the repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
page	Option<i32>	page number of results to return (1-based)
limit	Option<i32>	page size of results

Return type

Vecmodels::PushMirror

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_list_release_attachments

Vecmodels::Attachment repo_list_release_attachments(owner, repo, id) List release's attachments

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
id	i64	id of the release	[required]

Return type

Vecmodels::Attachment

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_list_releases

Vecmodels::Release repo_list_releases(owner, repo, draft, pre_release, page, limit) List a repo's releases

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
draft	Option<bool>	filter (exclude / include) drafts, if you dont have repo write access none will show
pre_release	Option<bool>	filter (exclude / include) pre-releases
page	Option<i32>	page number of results to return (1-based)
limit	Option<i32>	page size of results

Return type

Vecmodels::Release

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_list_stargazers

Vecmodels::User repo_list_stargazers(owner, repo, page, limit) List a repo's stargazers

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
page	Option<i32>	page number of results to return (1-based)
limit	Option<i32>	page size of results

Return type

Vecmodels::User

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_list_statuses

Vecmodels::CommitStatus repo_list_statuses(owner, repo, sha, sort, state, page, limit) Get a commit's statuses

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
sha	String	sha of the commit	[required]
sort	Option<String>	type of sort
state	Option<String>	type of state
page	Option<i32>	page number of results to return (1-based)
limit	Option<i32>	page size of results

Return type

Vecmodels::CommitStatus

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_list_statuses_by_ref

Vecmodels::CommitStatus repo_list_statuses_by_ref(owner, repo, r#ref, sort, state, page, limit) Get a commit's statuses, by branch/tag/commit reference

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
r#ref	String	name of branch/tag/commit	[required]
sort	Option<String>	type of sort
state	Option<String>	type of state
page	Option<i32>	page number of results to return (1-based)
limit	Option<i32>	page size of results

Return type

Vecmodels::CommitStatus

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_list_subscribers

Vecmodels::User repo_list_subscribers(owner, repo, page, limit) List a repo's watchers

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
page	Option<i32>	page number of results to return (1-based)
limit	Option<i32>	page size of results

Return type

Vecmodels::User

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_list_tag_protection

Vecmodels::TagProtection repo_list_tag_protection(owner, repo) List tag protections for a repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]

Return type

Vecmodels::TagProtection

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_list_tags

Vecmodels::Tag repo_list_tags(owner, repo, page, limit) List a repository's tags

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
page	Option<i32>	page number of results to return (1-based)
limit	Option<i32>	page size of results, default maximum page size is 50

Return type

Vecmodels::Tag

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_list_teams

Vecmodels::Team repo_list_teams(owner, repo) List a repository's teams

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]

Return type

Vecmodels::Team

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• 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(owner, repo, page, limit) Get list of topics that a repository has

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
page	Option<i32>	page number of results to return (1-based)
limit	Option<i32>	page size of results

Return type

models::TopicName

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• 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(owner, repo, index, body) Merge a pull request

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
index	i64	index of the pull request to merge	[required]
body	Option<MergePullRequestOption>

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: application/json, text/plain
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_merge_upstream

models::MergeUpstreamResponse repo_merge_upstream(owner, repo, body) Merge a branch from upstream

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
body	Option<MergeUpstreamRequest>

Return type

models::MergeUpstreamResponse

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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(body) Migrate a remote git repository

Parameters

Name	Type	Description	Required	Notes
body	Option<MigrateRepoOptions>

Return type

models::Repository

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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(owner, repo) Sync a mirrored repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo to sync	[required]
repo	String	name of the repo to sync	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_new_pin_allowed

models::NewIssuePinsAllowed repo_new_pin_allowed(owner, repo) Returns if new Issue Pins are allowed

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]

Return type

models::NewIssuePinsAllowed

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• 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(owner, repo, index) Check if a pull request has been merged

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
index	i64	index of the pull request	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_push_mirror_sync

repo_push_mirror_sync(owner, repo) Sync all push mirrored repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo to sync	[required]
repo	String	name of the repo to sync	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_rename_branch

repo_rename_branch(owner, repo, branch, body) Rename a branch

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
branch	String	name of the branch	[required]
body	Option<RenameBranchRepoOption>

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_search

models::SearchResults repo_search(q, topic, include_desc, uid, priority_owner_id, team_id, starred_by, private, is_private, template, archived, mode, exclusive, sort, order, page, limit) Search for repositories

Parameters

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

Return type

models::SearchResults

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_signing_key

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

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]

Return type

String

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_signing_key_ssh

String repo_signing_key_ssh(owner, repo) Get signing-key.pub for given repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]

Return type

String

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_submit_pull_review

models::PullReview repo_submit_pull_review(owner, repo, index, id, body) Submit a pending review to an pull request

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
index	i64	index of the pull request	[required]
id	i64	id of the review	[required]
body	SubmitPullReviewOptions		[required]

Return type

models::PullReview

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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_test_hook

repo_test_hook(owner, repo, id, r#ref) Test a push webhook

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
id	i64	id of the hook to test	[required]
r#ref	Option<String>	The name of the commit/branch/tag, indicates which commit will be loaded to the webhook payload.

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_tracked_times

Vecmodels::TrackedTime repo_tracked_times(owner, repo, user, since, before, page, limit) List a repo's tracked times

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
user	Option<String>	optional filter by user (available for issue managers)
since	Option<String>	Only show times updated after the given time. This is a timestamp in RFC 3339 format
before	Option<String>	Only show times updated before the given time. This is a timestamp in RFC 3339 format
page	Option<i32>	page number of results to return (1-based)
limit	Option<i32>	page size of results

Return type

Vecmodels::TrackedTime

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_transfer

models::Repository repo_transfer(owner, repo, body) Transfer a repo ownership

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo to transfer	[required]
repo	String	name of the repo to transfer	[required]
body	TransferRepoOption	Transfer Options	[required]

Return type

models::Repository

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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_un_dismiss_pull_review

models::PullReview repo_un_dismiss_pull_review(owner, repo, index, id) Cancel to dismiss a review for a pull request

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
index	i64	index of the pull request	[required]
id	i64	id of the review	[required]

Return type

models::PullReview

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_update_avatar

repo_update_avatar(owner, repo, body) Update avatar

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
body	Option<UpdateRepoAvatarOption>

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: application/json, text/plain
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_update_branch_protection_priories

repo_update_branch_protection_priories(owner, repo, body) Update the priorities of branch protections for a repository.

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
body	Option<UpdateBranchProtectionPriories>

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_update_file

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

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
filepath	String	path of the file to update	[required]
body	UpdateFileOptions		[required]

Return type

models::FileResponse

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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_pull_request

repo_update_pull_request(owner, repo, index, style) Merge PR's baseBranch into headBranch

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
index	i64	index of the pull request to get	[required]
style	Option<String>	how to update pull request

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_update_topics

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

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
body	Option<RepoTopicOptions>

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: application/json, text/plain
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repo_validate_issue_config

models::IssueConfigValidation repo_validate_issue_config(owner, repo) Returns the validation information for a issue config

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]

Return type

models::IssueConfigValidation

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

topic_search

Vecmodels::TopicResponse topic_search(q, page, limit) search topics via keyword

Parameters

Name	Type	Description	Required	Notes
q	String	keywords to search	[required]
page	Option<i32>	page number of results to return (1-based)
limit	Option<i32>	page size of results

Return type

Vecmodels::TopicResponse

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_repo_secret

update_repo_secret(owner, repo, secretname, body) Create or Update a secret value in a repository

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repository	[required]
repo	String	name of the repository	[required]
secretname	String	name of the secret	[required]
body	Option<CreateOrUpdateSecretOption>

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_repo_variable

update_repo_variable(owner, repo, variablename, body) Update a repo-level variable

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repository	[required]
variablename	String	name of the variable	[required]
body	Option<UpdateVariableOption>

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: application/json, text/plain
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

user_current_check_subscription

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

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]

Return type

models::WatchInfo

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• 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(owner, repo) Unwatch a repo

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]

Return type

(empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

user_current_put_subscription

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

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]

Return type

models::WatchInfo

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, text/html

[Back to top] [Back to API list] [Back to Model list] [Back to README]

user_tracked_times

Vecmodels::TrackedTime user_tracked_times(owner, repo, user) List a user's tracked times in a repo

Parameters

Name	Type	Description	Required	Notes
owner	String	owner of the repo	[required]
repo	String	name of the repo	[required]
user	String	username of the user whose tracked times are to be listed	[required]

Return type

Vecmodels::TrackedTime

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]