# swagger_client.RepositoryApi All URIs are relative to *http://localhost/api/v1* Method | HTTP request | Description ------------- | ------------- | ------------- [**create_current_user_repo**](RepositoryApi.md#create_current_user_repo) | **POST** /user/repos | Create a repository [**create_fork**](RepositoryApi.md#create_fork) | **POST** /repos/{owner}/{repo}/forks | Fork a repository [**get_tree**](RepositoryApi.md#get_tree) | **GET** /repos/{owner}/{repo}/git/trees/{sha} | Gets the tree of a repository. [**list_forks**](RepositoryApi.md#list_forks) | **GET** /repos/{owner}/{repo}/forks | List a repository's forks [**repo_add_collaborator**](RepositoryApi.md#repo_add_collaborator) | **PUT** /repos/{owner}/{repo}/collaborators/{collaborator} | Add a collaborator to a repository [**repo_check_collaborator**](RepositoryApi.md#repo_check_collaborator) | **GET** /repos/{owner}/{repo}/collaborators/{collaborator} | Check if a user is a collaborator of a repository [**repo_create_hook**](RepositoryApi.md#repo_create_hook) | **POST** /repos/{owner}/{repo}/hooks | Create a hook [**repo_create_key**](RepositoryApi.md#repo_create_key) | **POST** /repos/{owner}/{repo}/keys | Add a key to a repository [**repo_create_pull_request**](RepositoryApi.md#repo_create_pull_request) | **POST** /repos/{owner}/{repo}/pulls | Create a pull request [**repo_create_release**](RepositoryApi.md#repo_create_release) | **POST** /repos/{owner}/{repo}/releases | Create a release [**repo_create_release_attachment**](RepositoryApi.md#repo_create_release_attachment) | **POST** /repos/{owner}/{repo}/releases/{id}/assets | Create a release attachment [**repo_create_status**](RepositoryApi.md#repo_create_status) | **POST** /repos/{owner}/{repo}/statuses/{sha} | Create a commit status [**repo_delete**](RepositoryApi.md#repo_delete) | **DELETE** /repos/{owner}/{repo} | Delete a repository [**repo_delete_collaborator**](RepositoryApi.md#repo_delete_collaborator) | **DELETE** /repos/{owner}/{repo}/collaborators/{collaborator} | Delete a collaborator from a repository [**repo_delete_hook**](RepositoryApi.md#repo_delete_hook) | **DELETE** /repos/{owner}/{repo}/hooks/{id} | Delete a hook in a repository [**repo_delete_key**](RepositoryApi.md#repo_delete_key) | **DELETE** /repos/{owner}/{repo}/keys/{id} | Delete a key from a repository [**repo_delete_release**](RepositoryApi.md#repo_delete_release) | **DELETE** /repos/{owner}/{repo}/releases/{id} | Delete a release [**repo_delete_release_attachment**](RepositoryApi.md#repo_delete_release_attachment) | **DELETE** /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id} | Delete a release attachment [**repo_edit_hook**](RepositoryApi.md#repo_edit_hook) | **PATCH** /repos/{owner}/{repo}/hooks/{id} | Edit a hook in a repository [**repo_edit_pull_request**](RepositoryApi.md#repo_edit_pull_request) | **PATCH** /repos/{owner}/{repo}/pulls/{index} | Update a pull request [**repo_edit_release**](RepositoryApi.md#repo_edit_release) | **PATCH** /repos/{owner}/{repo}/releases/{id} | Update a release [**repo_edit_release_attachment**](RepositoryApi.md#repo_edit_release_attachment) | **PATCH** /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id} | Edit a release attachment [**repo_get**](RepositoryApi.md#repo_get) | **GET** /repos/{owner}/{repo} | Get a repository [**repo_get_archive**](RepositoryApi.md#repo_get_archive) | **GET** /repos/{owner}/{repo}/archive/{archive} | Get an archive of a repository [**repo_get_branch**](RepositoryApi.md#repo_get_branch) | **GET** /repos/{owner}/{repo}/branches/{branch} | Retrieve a specific branch from a repository [**repo_get_by_id**](RepositoryApi.md#repo_get_by_id) | **GET** /repositories/{id} | Get a repository by id [**repo_get_combined_status_by_ref**](RepositoryApi.md#repo_get_combined_status_by_ref) | **GET** /repos/{owner}/{repo}/commits/{ref}/statuses | Get a commit's combined status, by branch/tag/commit reference [**repo_get_editor_config**](RepositoryApi.md#repo_get_editor_config) | **GET** /repos/{owner}/{repo}/editorconfig/{filepath} | Get the EditorConfig definitions of a file in a repository [**repo_get_hook**](RepositoryApi.md#repo_get_hook) | **GET** /repos/{owner}/{repo}/hooks/{id} | Get a hook [**repo_get_key**](RepositoryApi.md#repo_get_key) | **GET** /repos/{owner}/{repo}/keys/{id} | Get a repository's key by id [**repo_get_pull_request**](RepositoryApi.md#repo_get_pull_request) | **GET** /repos/{owner}/{repo}/pulls/{index} | Get a pull request [**repo_get_raw_file**](RepositoryApi.md#repo_get_raw_file) | **GET** /repos/{owner}/{repo}/raw/{filepath} | Get a file from a repository [**repo_get_release**](RepositoryApi.md#repo_get_release) | **GET** /repos/{owner}/{repo}/releases/{id} | Get a release [**repo_get_release_attachment**](RepositoryApi.md#repo_get_release_attachment) | **GET** /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id} | Get a release attachment [**repo_get_single_commit**](RepositoryApi.md#repo_get_single_commit) | **GET** /repos/{owner}/{repo}/git/commits/{sha} | Get a single commit from a repository [**repo_list_all_git_refs**](RepositoryApi.md#repo_list_all_git_refs) | **GET** /repos/{owner}/{repo}/git/refs | Get specified ref or filtered repository's refs [**repo_list_branches**](RepositoryApi.md#repo_list_branches) | **GET** /repos/{owner}/{repo}/branches | List a repository's branches [**repo_list_collaborators**](RepositoryApi.md#repo_list_collaborators) | **GET** /repos/{owner}/{repo}/collaborators | List a repository's collaborators [**repo_list_git_refs**](RepositoryApi.md#repo_list_git_refs) | **GET** /repos/{owner}/{repo}/git/refs/{ref} | Get specified ref or filtered repository's refs [**repo_list_hooks**](RepositoryApi.md#repo_list_hooks) | **GET** /repos/{owner}/{repo}/hooks | List the hooks in a repository [**repo_list_keys**](RepositoryApi.md#repo_list_keys) | **GET** /repos/{owner}/{repo}/keys | List a repository's keys [**repo_list_pull_requests**](RepositoryApi.md#repo_list_pull_requests) | **GET** /repos/{owner}/{repo}/pulls | List a repo's pull requests [**repo_list_release_attachments**](RepositoryApi.md#repo_list_release_attachments) | **GET** /repos/{owner}/{repo}/releases/{id}/assets | List release's attachments [**repo_list_releases**](RepositoryApi.md#repo_list_releases) | **GET** /repos/{owner}/{repo}/releases | List a repo's releases [**repo_list_stargazers**](RepositoryApi.md#repo_list_stargazers) | **GET** /repos/{owner}/{repo}/stargazers | List a repo's stargazers [**repo_list_statuses**](RepositoryApi.md#repo_list_statuses) | **GET** /repos/{owner}/{repo}/statuses/{sha} | Get a commit's statuses [**repo_list_subscribers**](RepositoryApi.md#repo_list_subscribers) | **GET** /repos/{owner}/{repo}/subscribers | List a repo's watchers [**repo_list_tags**](RepositoryApi.md#repo_list_tags) | **GET** /repos/{owner}/{repo}/tags | List a repository's tags [**repo_merge_pull_request**](RepositoryApi.md#repo_merge_pull_request) | **POST** /repos/{owner}/{repo}/pulls/{index}/merge | Merge a pull request [**repo_migrate**](RepositoryApi.md#repo_migrate) | **POST** /repos/migrate | Migrate a remote git repository [**repo_mirror_sync**](RepositoryApi.md#repo_mirror_sync) | **POST** /repos/{owner}/{repo}/mirror-sync | Sync a mirrored repository [**repo_pull_request_is_merged**](RepositoryApi.md#repo_pull_request_is_merged) | **GET** /repos/{owner}/{repo}/pulls/{index}/merge | Check if a pull request has been merged [**repo_search**](RepositoryApi.md#repo_search) | **GET** /repos/search | Search for repositories [**repo_test_hook**](RepositoryApi.md#repo_test_hook) | **POST** /repos/{owner}/{repo}/hooks/{id}/tests | Test a push webhook [**repo_tracked_times**](RepositoryApi.md#repo_tracked_times) | **GET** /repos/{owner}/{repo}/times | List a repo's tracked times [**topic_search**](RepositoryApi.md#topic_search) | **GET** /topics/search | search topics via keyword [**user_current_check_subscription**](RepositoryApi.md#user_current_check_subscription) | **GET** /repos/{owner}/{repo}/subscription | Check if the current user is watching a repo [**user_current_delete_subscription**](RepositoryApi.md#user_current_delete_subscription) | **DELETE** /repos/{owner}/{repo}/subscription | Unwatch a repo [**user_current_put_subscription**](RepositoryApi.md#user_current_put_subscription) | **PUT** /repos/{owner}/{repo}/subscription | Watch a repo # **create_current_user_repo** > Repository create_current_user_repo(body=body) Create a repository ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) body = swagger_client.CreateRepoOption() # CreateRepoOption | (optional) try: # Create a repository api_response = api_instance.create_current_user_repo(body=body) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->create_current_user_repo: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**CreateRepoOption**](CreateRepoOption.md)| | [optional] ### Return type [**Repository**](Repository.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_fork** > Repository create_fork(owner, repo, body=body) Fork a repository ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo to fork repo = 'repo_example' # str | name of the repo to fork body = swagger_client.CreateForkOption() # CreateForkOption | (optional) try: # Fork a repository api_response = api_instance.create_fork(owner, repo, body=body) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->create_fork: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo to fork | **repo** | **str**| name of the repo to fork | **body** | [**CreateForkOption**](CreateForkOption.md)| | [optional] ### Return type [**Repository**](Repository.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_tree** > GitTreeResponse get_tree(owner, repo, sha, recursive=recursive, page=page, per_page=per_page) Gets the tree of a repository. ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo sha = 'sha_example' # str | sha of the commit recursive = true # bool | show all directories and files (optional) page = 56 # int | 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 (optional) per_page = 56 # int | number of items per page; default is 1000 or what is set in app.ini as DEFAULT_GIT_TREES_PER_PAGE (optional) try: # Gets the tree of a repository. api_response = api_instance.get_tree(owner, repo, sha, recursive=recursive, page=page, per_page=per_page) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->get_tree: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **sha** | **str**| sha of the commit | **recursive** | **bool**| show all directories and files | [optional] **page** | **int**| 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 | [optional] **per_page** | **int**| number of items per page; default is 1000 or what is set in app.ini as DEFAULT_GIT_TREES_PER_PAGE | [optional] ### Return type [**GitTreeResponse**](GitTreeResponse.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **list_forks** > list[Repository] list_forks(owner, repo) List a repository's forks ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo try: # List a repository's forks api_response = api_instance.list_forks(owner, repo) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->list_forks: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | ### Return type [**list[Repository]**](Repository.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_add_collaborator** > repo_add_collaborator(owner, repo, collaborator, body=body) Add a collaborator to a repository ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo collaborator = 'collaborator_example' # str | username of the collaborator to add body = swagger_client.AddCollaboratorOption() # AddCollaboratorOption | (optional) try: # Add a collaborator to a repository api_instance.repo_add_collaborator(owner, repo, collaborator, body=body) except ApiException as e: print("Exception when calling RepositoryApi->repo_add_collaborator: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **collaborator** | **str**| username of the collaborator to add | **body** | [**AddCollaboratorOption**](AddCollaboratorOption.md)| | [optional] ### Return type void (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_check_collaborator** > repo_check_collaborator(owner, repo, collaborator) Check if a user is a collaborator of a repository ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo collaborator = 'collaborator_example' # str | username of the collaborator try: # Check if a user is a collaborator of a repository api_instance.repo_check_collaborator(owner, repo, collaborator) except ApiException as e: print("Exception when calling RepositoryApi->repo_check_collaborator: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **collaborator** | **str**| username of the collaborator | ### Return type void (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_create_hook** > list[Branch] repo_create_hook(owner, repo, body=body) Create a hook ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo body = swagger_client.CreateHookOption() # CreateHookOption | (optional) try: # Create a hook api_response = api_instance.repo_create_hook(owner, repo, body=body) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_create_hook: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **body** | [**CreateHookOption**](CreateHookOption.md)| | [optional] ### Return type [**list[Branch]**](Branch.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_create_key** > DeployKey repo_create_key(owner, repo, body=body) Add a key to a repository ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo body = swagger_client.CreateKeyOption() # CreateKeyOption | (optional) try: # Add a key to a repository api_response = api_instance.repo_create_key(owner, repo, body=body) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_create_key: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **body** | [**CreateKeyOption**](CreateKeyOption.md)| | [optional] ### Return type [**DeployKey**](DeployKey.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_create_pull_request** > PullRequest repo_create_pull_request(owner, repo, body=body) Create a pull request ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo body = swagger_client.CreatePullRequestOption() # CreatePullRequestOption | (optional) try: # Create a pull request api_response = api_instance.repo_create_pull_request(owner, repo, body=body) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_create_pull_request: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **body** | [**CreatePullRequestOption**](CreatePullRequestOption.md)| | [optional] ### Return type [**PullRequest**](PullRequest.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_create_release** > Release repo_create_release(owner, repo, body=body) Create a release ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo body = swagger_client.CreateReleaseOption() # CreateReleaseOption | (optional) try: # Create a release api_response = api_instance.repo_create_release(owner, repo, body=body) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_create_release: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **body** | [**CreateReleaseOption**](CreateReleaseOption.md)| | [optional] ### Return type [**Release**](Release.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_create_release_attachment** > Attachment repo_create_release_attachment(owner, repo, id, attachment, name=name) Create a release attachment ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo id = 789 # int | id of the release attachment = '/path/to/file.txt' # file | attachment to upload name = 'name_example' # str | name of the attachment (optional) try: # Create a release attachment api_response = api_instance.repo_create_release_attachment(owner, repo, id, attachment, name=name) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_create_release_attachment: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **id** | **int**| id of the release | **attachment** | **file**| attachment to upload | **name** | **str**| name of the attachment | [optional] ### Return type [**Attachment**](Attachment.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: multipart/form-data - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_create_status** > list[Status] repo_create_status(owner, repo, sha, body=body) Create a commit status ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo sha = 'sha_example' # str | sha of the commit body = swagger_client.CreateStatusOption() # CreateStatusOption | (optional) try: # Create a commit status api_response = api_instance.repo_create_status(owner, repo, sha, body=body) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_create_status: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **sha** | **str**| sha of the commit | **body** | [**CreateStatusOption**](CreateStatusOption.md)| | [optional] ### Return type [**list[Status]**](Status.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_delete** > repo_delete(owner, repo) Delete a repository ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo to delete repo = 'repo_example' # str | name of the repo to delete try: # Delete a repository api_instance.repo_delete(owner, repo) except ApiException as e: print("Exception when calling RepositoryApi->repo_delete: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo to delete | **repo** | **str**| name of the repo to delete | ### Return type void (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_delete_collaborator** > repo_delete_collaborator(owner, repo, collaborator) Delete a collaborator from a repository ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo collaborator = 'collaborator_example' # str | username of the collaborator to delete try: # Delete a collaborator from a repository api_instance.repo_delete_collaborator(owner, repo, collaborator) except ApiException as e: print("Exception when calling RepositoryApi->repo_delete_collaborator: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **collaborator** | **str**| username of the collaborator to delete | ### Return type void (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_delete_hook** > repo_delete_hook(owner, repo, id) Delete a hook in a repository ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo id = 789 # int | id of the hook to delete try: # Delete a hook in a repository api_instance.repo_delete_hook(owner, repo, id) except ApiException as e: print("Exception when calling RepositoryApi->repo_delete_hook: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **id** | **int**| id of the hook to delete | ### Return type void (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_delete_key** > repo_delete_key(owner, repo, id) Delete a key from a repository ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo id = 789 # int | id of the key to delete try: # Delete a key from a repository api_instance.repo_delete_key(owner, repo, id) except ApiException as e: print("Exception when calling RepositoryApi->repo_delete_key: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **id** | **int**| id of the key to delete | ### Return type void (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json, text/html [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_delete_release** > repo_delete_release(owner, repo, id) Delete a release ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo id = 789 # int | id of the release to delete try: # Delete a release api_instance.repo_delete_release(owner, repo, id) except ApiException as e: print("Exception when calling RepositoryApi->repo_delete_release: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **id** | **int**| id of the release to delete | ### Return type void (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json, text/html [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_delete_release_attachment** > repo_delete_release_attachment(owner, repo, id, attachment_id) Delete a release attachment ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo id = 789 # int | id of the release attachment_id = 789 # int | id of the attachment to delete try: # Delete a release attachment api_instance.repo_delete_release_attachment(owner, repo, id, attachment_id) except ApiException as e: print("Exception when calling RepositoryApi->repo_delete_release_attachment: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **id** | **int**| id of the release | **attachment_id** | **int**| id of the attachment to delete | ### Return type void (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_edit_hook** > list[Branch] repo_edit_hook(owner, repo, id, body=body) Edit a hook in a repository ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo id = 789 # int | index of the hook body = swagger_client.EditHookOption() # EditHookOption | (optional) try: # Edit a hook in a repository api_response = api_instance.repo_edit_hook(owner, repo, id, body=body) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_edit_hook: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **id** | **int**| index of the hook | **body** | [**EditHookOption**](EditHookOption.md)| | [optional] ### Return type [**list[Branch]**](Branch.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_edit_pull_request** > PullRequest repo_edit_pull_request(owner, repo, index, body=body) Update a pull request ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo index = 789 # int | index of the pull request to edit body = swagger_client.EditPullRequestOption() # EditPullRequestOption | (optional) try: # Update a pull request api_response = api_instance.repo_edit_pull_request(owner, repo, index, body=body) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_edit_pull_request: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **index** | **int**| index of the pull request to edit | **body** | [**EditPullRequestOption**](EditPullRequestOption.md)| | [optional] ### Return type [**PullRequest**](PullRequest.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_edit_release** > Release repo_edit_release(owner, repo, id, body=body) Update a release ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo id = 789 # int | id of the release to edit body = swagger_client.EditReleaseOption() # EditReleaseOption | (optional) try: # Update a release api_response = api_instance.repo_edit_release(owner, repo, id, body=body) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_edit_release: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **id** | **int**| id of the release to edit | **body** | [**EditReleaseOption**](EditReleaseOption.md)| | [optional] ### Return type [**Release**](Release.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_edit_release_attachment** > Attachment repo_edit_release_attachment(owner, repo, id, attachment_id, body=body) Edit a release attachment ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo id = 789 # int | id of the release attachment_id = 789 # int | id of the attachment to edit body = swagger_client.EditAttachmentOptions() # EditAttachmentOptions | (optional) try: # Edit a release attachment api_response = api_instance.repo_edit_release_attachment(owner, repo, id, attachment_id, body=body) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_edit_release_attachment: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **id** | **int**| id of the release | **attachment_id** | **int**| id of the attachment to edit | **body** | [**EditAttachmentOptions**](EditAttachmentOptions.md)| | [optional] ### Return type [**Attachment**](Attachment.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_get** > Repository repo_get(owner, repo) Get a repository ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo try: # Get a repository api_response = api_instance.repo_get(owner, repo) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_get: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | ### Return type [**Repository**](Repository.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_get_archive** > repo_get_archive(owner, repo, archive) Get an archive of a repository ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo archive = 'archive_example' # str | archive to download, consisting of a git reference and archive try: # Get an archive of a repository api_instance.repo_get_archive(owner, repo, archive) except ApiException as e: print("Exception when calling RepositoryApi->repo_get_archive: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **archive** | **str**| archive to download, consisting of a git reference and archive | ### Return type void (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_get_branch** > Branch repo_get_branch(owner, repo, branch) Retrieve a specific branch from a repository ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo branch = 'branch_example' # str | branch to get try: # Retrieve a specific branch from a repository api_response = api_instance.repo_get_branch(owner, repo, branch) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_get_branch: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **branch** | **str**| branch to get | ### Return type [**Branch**](Branch.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_get_by_id** > Repository repo_get_by_id(id) Get a repository by id ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) id = 789 # int | id of the repo to get try: # Get a repository by id api_response = api_instance.repo_get_by_id(id) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_get_by_id: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **int**| id of the repo to get | ### Return type [**Repository**](Repository.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_get_combined_status_by_ref** > Status repo_get_combined_status_by_ref(owner, repo, ref) Get a commit's combined status, by branch/tag/commit reference ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo ref = 'ref_example' # str | name of branch/tag/commit try: # Get a commit's combined status, by branch/tag/commit reference api_response = api_instance.repo_get_combined_status_by_ref(owner, repo, ref) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_get_combined_status_by_ref: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **ref** | **str**| name of branch/tag/commit | ### Return type [**Status**](Status.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_get_editor_config** > repo_get_editor_config(owner, repo, filepath) Get the EditorConfig definitions of a file in a repository ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo filepath = 'filepath_example' # str | filepath of file to get try: # Get the EditorConfig definitions of a file in a repository api_instance.repo_get_editor_config(owner, repo, filepath) except ApiException as e: print("Exception when calling RepositoryApi->repo_get_editor_config: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **filepath** | **str**| filepath of file to get | ### Return type void (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_get_hook** > list[Branch] repo_get_hook(owner, repo, id) Get a hook ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo id = 789 # int | id of the hook to get try: # Get a hook api_response = api_instance.repo_get_hook(owner, repo, id) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_get_hook: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **id** | **int**| id of the hook to get | ### Return type [**list[Branch]**](Branch.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_get_key** > DeployKey repo_get_key(owner, repo, id) Get a repository's key by id ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo id = 789 # int | id of the key to get try: # Get a repository's key by id api_response = api_instance.repo_get_key(owner, repo, id) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_get_key: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **id** | **int**| id of the key to get | ### Return type [**DeployKey**](DeployKey.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_get_pull_request** > PullRequest repo_get_pull_request(owner, repo, index) Get a pull request ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo index = 789 # int | index of the pull request to get try: # Get a pull request api_response = api_instance.repo_get_pull_request(owner, repo, index) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_get_pull_request: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **index** | **int**| index of the pull request to get | ### Return type [**PullRequest**](PullRequest.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_get_raw_file** > repo_get_raw_file(owner, repo, filepath) Get a file from a repository ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo filepath = 'filepath_example' # str | filepath of the file to get try: # Get a file from a repository api_instance.repo_get_raw_file(owner, repo, filepath) except ApiException as e: print("Exception when calling RepositoryApi->repo_get_raw_file: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **filepath** | **str**| filepath of the file to get | ### Return type void (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_get_release** > Release repo_get_release(owner, repo, id) Get a release ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo id = 789 # int | id of the release to get try: # Get a release api_response = api_instance.repo_get_release(owner, repo, id) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_get_release: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **id** | **int**| id of the release to get | ### Return type [**Release**](Release.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_get_release_attachment** > Attachment repo_get_release_attachment(owner, repo, id, attachment_id) Get a release attachment ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo id = 789 # int | id of the release attachment_id = 789 # int | id of the attachment to get try: # Get a release attachment api_response = api_instance.repo_get_release_attachment(owner, repo, id, attachment_id) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_get_release_attachment: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **id** | **int**| id of the release | **attachment_id** | **int**| id of the attachment to get | ### Return type [**Attachment**](Attachment.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_get_single_commit** > Commit repo_get_single_commit(owner, repo, sha) Get a single commit from a repository ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo sha = 'sha_example' # str | the commit hash try: # Get a single commit from a repository api_response = api_instance.repo_get_single_commit(owner, repo, sha) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_get_single_commit: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **sha** | **str**| the commit hash | ### Return type [**Commit**](Commit.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_list_all_git_refs** > list[Reference] repo_list_all_git_refs(owner, repo) Get specified ref or filtered repository's refs ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo try: # Get specified ref or filtered repository's refs api_response = api_instance.repo_list_all_git_refs(owner, repo) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_list_all_git_refs: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | ### Return type [**list[Reference]**](Reference.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_list_branches** > list[Branch] repo_list_branches(owner, repo) List a repository's branches ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo try: # List a repository's branches api_response = api_instance.repo_list_branches(owner, repo) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_list_branches: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | ### Return type [**list[Branch]**](Branch.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_list_collaborators** > list[User] repo_list_collaborators(owner, repo) List a repository's collaborators ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo try: # List a repository's collaborators api_response = api_instance.repo_list_collaborators(owner, repo) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_list_collaborators: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | ### Return type [**list[User]**](User.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_list_git_refs** > list[Reference] repo_list_git_refs(owner, repo, ref) Get specified ref or filtered repository's refs ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo ref = 'ref_example' # str | part or full name of the ref try: # Get specified ref or filtered repository's refs api_response = api_instance.repo_list_git_refs(owner, repo, ref) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_list_git_refs: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **ref** | **str**| part or full name of the ref | ### Return type [**list[Reference]**](Reference.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_list_hooks** > list[Branch] repo_list_hooks(owner, repo) List the hooks in a repository ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo try: # List the hooks in a repository api_response = api_instance.repo_list_hooks(owner, repo) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_list_hooks: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | ### Return type [**list[Branch]**](Branch.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_list_keys** > list[DeployKey] repo_list_keys(owner, repo, key_id=key_id, fingerprint=fingerprint) List a repository's keys ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo key_id = 56 # int | the key_id to search for (optional) fingerprint = 'fingerprint_example' # str | fingerprint of the key (optional) try: # List a repository's keys api_response = api_instance.repo_list_keys(owner, repo, key_id=key_id, fingerprint=fingerprint) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_list_keys: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **key_id** | **int**| the key_id to search for | [optional] **fingerprint** | **str**| fingerprint of the key | [optional] ### Return type [**list[DeployKey]**](DeployKey.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_list_pull_requests** > list[PullRequest] repo_list_pull_requests(owner, repo, page=page, state=state, sort=sort, milestone=milestone, labels=labels) List a repo's pull requests ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo page = 56 # int | Page number (optional) state = 'state_example' # str | State of pull request: open or closed (optional) (optional) sort = 'sort_example' # str | Type of sort (optional) milestone = 789 # int | ID of the milestone (optional) labels = [56] # list[int] | Label IDs (optional) try: # List a repo's pull requests api_response = api_instance.repo_list_pull_requests(owner, repo, page=page, state=state, sort=sort, milestone=milestone, labels=labels) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_list_pull_requests: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **page** | **int**| Page number | [optional] **state** | **str**| State of pull request: open or closed (optional) | [optional] **sort** | **str**| Type of sort | [optional] **milestone** | **int**| ID of the milestone | [optional] **labels** | [**list[int]**](int.md)| Label IDs | [optional] ### Return type [**list[PullRequest]**](PullRequest.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_list_release_attachments** > list[Attachment] repo_list_release_attachments(owner, repo, id) List release's attachments ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo id = 789 # int | id of the release try: # List release's attachments api_response = api_instance.repo_list_release_attachments(owner, repo, id) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_list_release_attachments: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **id** | **int**| id of the release | ### Return type [**list[Attachment]**](Attachment.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_list_releases** > list[Release] repo_list_releases(owner, repo, page=page, per_page=per_page) List a repo's releases ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo page = 56 # int | page wants to load (optional) per_page = 56 # int | items count every page wants to load (optional) try: # List a repo's releases api_response = api_instance.repo_list_releases(owner, repo, page=page, per_page=per_page) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_list_releases: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **page** | **int**| page wants to load | [optional] **per_page** | **int**| items count every page wants to load | [optional] ### Return type [**list[Release]**](Release.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_list_stargazers** > list[User] repo_list_stargazers(owner, repo) List a repo's stargazers ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo try: # List a repo's stargazers api_response = api_instance.repo_list_stargazers(owner, repo) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_list_stargazers: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | ### Return type [**list[User]**](User.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_list_statuses** > list[Status] repo_list_statuses(owner, repo, sha) Get a commit's statuses ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo sha = 'sha_example' # str | sha of the commit try: # Get a commit's statuses api_response = api_instance.repo_list_statuses(owner, repo, sha) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_list_statuses: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **sha** | **str**| sha of the commit | ### Return type [**list[Status]**](Status.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_list_subscribers** > list[User] repo_list_subscribers(owner, repo) List a repo's watchers ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo try: # List a repo's watchers api_response = api_instance.repo_list_subscribers(owner, repo) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_list_subscribers: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | ### Return type [**list[User]**](User.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_list_tags** > list[Tag] repo_list_tags(owner, repo) List a repository's tags ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo try: # List a repository's tags api_response = api_instance.repo_list_tags(owner, repo) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_list_tags: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | ### Return type [**list[Tag]**](Tag.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_merge_pull_request** > repo_merge_pull_request(owner, repo, index, body=body) Merge a pull request ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo index = 789 # int | index of the pull request to merge body = swagger_client.MergePullRequestOption() # MergePullRequestOption | (optional) try: # Merge a pull request api_instance.repo_merge_pull_request(owner, repo, index, body=body) except ApiException as e: print("Exception when calling RepositoryApi->repo_merge_pull_request: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **index** | **int**| index of the pull request to merge | **body** | [**MergePullRequestOption**](MergePullRequestOption.md)| | [optional] ### Return type void (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_migrate** > Repository repo_migrate(body=body) Migrate a remote git repository ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) body = swagger_client.MigrateRepoForm() # MigrateRepoForm | (optional) try: # Migrate a remote git repository api_response = api_instance.repo_migrate(body=body) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_migrate: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**MigrateRepoForm**](MigrateRepoForm.md)| | [optional] ### Return type [**Repository**](Repository.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_mirror_sync** > repo_mirror_sync(owner, repo) Sync a mirrored repository ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo to sync repo = 'repo_example' # str | name of the repo to sync try: # Sync a mirrored repository api_instance.repo_mirror_sync(owner, repo) except ApiException as e: print("Exception when calling RepositoryApi->repo_mirror_sync: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo to sync | **repo** | **str**| name of the repo to sync | ### Return type void (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_pull_request_is_merged** > repo_pull_request_is_merged(owner, repo, index) Check if a pull request has been merged ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo index = 789 # int | index of the pull request try: # Check if a pull request has been merged api_instance.repo_pull_request_is_merged(owner, repo, index) except ApiException as e: print("Exception when calling RepositoryApi->repo_pull_request_is_merged: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **index** | **int**| index of the pull request | ### Return type void (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_search** > SearchResults repo_search(q=q, uid=uid, page=page, limit=limit, mode=mode, exclusive=exclusive, sort=sort, order=order) Search for repositories ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) q = 'q_example' # str | keyword (optional) uid = 789 # int | search only for repos that the user with the given id owns or contributes to (optional) page = 56 # int | page number of results to return (1-based) (optional) limit = 56 # int | page size of results, maximum page size is 50 (optional) mode = 'mode_example' # str | type of repository to search for. Supported values are \"fork\", \"source\", \"mirror\" and \"collaborative\" (optional) exclusive = true # bool | if `uid` is given, search only for repos that the user owns (optional) sort = 'sort_example' # str | sort repos by attribute. Supported values are \"alpha\", \"created\", \"updated\", \"size\", and \"id\". Default is \"alpha\" (optional) order = 'order_example' # str | sort order, either \"asc\" (ascending) or \"desc\" (descending). Default is \"asc\", ignored if \"sort\" is not specified. (optional) try: # Search for repositories api_response = api_instance.repo_search(q=q, uid=uid, page=page, limit=limit, mode=mode, exclusive=exclusive, sort=sort, order=order) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_search: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **q** | **str**| keyword | [optional] **uid** | **int**| search only for repos that the user with the given id owns or contributes to | [optional] **page** | **int**| page number of results to return (1-based) | [optional] **limit** | **int**| page size of results, maximum page size is 50 | [optional] **mode** | **str**| type of repository to search for. Supported values are \"fork\", \"source\", \"mirror\" and \"collaborative\" | [optional] **exclusive** | **bool**| if `uid` is given, search only for repos that the user owns | [optional] **sort** | **str**| sort repos by attribute. Supported values are \"alpha\", \"created\", \"updated\", \"size\", and \"id\". Default is \"alpha\" | [optional] **order** | **str**| sort order, either \"asc\" (ascending) or \"desc\" (descending). Default is \"asc\", ignored if \"sort\" is not specified. | [optional] ### Return type [**SearchResults**](SearchResults.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_test_hook** > repo_test_hook(owner, repo, id) Test a push webhook ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo id = 789 # int | id of the hook to test try: # Test a push webhook api_instance.repo_test_hook(owner, repo, id) except ApiException as e: print("Exception when calling RepositoryApi->repo_test_hook: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | **id** | **int**| id of the hook to test | ### Return type void (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **repo_tracked_times** > list[TrackedTime] repo_tracked_times(owner, repo) List a repo's tracked times ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo try: # List a repo's tracked times api_response = api_instance.repo_tracked_times(owner, repo) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->repo_tracked_times: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | ### Return type [**list[TrackedTime]**](TrackedTime.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **topic_search** > Repository topic_search(q) search topics via keyword ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) q = 'q_example' # str | keywords to search try: # search topics via keyword api_response = api_instance.topic_search(q) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->topic_search: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **q** | **str**| keywords to search | ### Return type [**Repository**](Repository.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **user_current_check_subscription** > WatchInfo user_current_check_subscription(owner, repo) Check if the current user is watching a repo ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo try: # Check if the current user is watching a repo api_response = api_instance.user_current_check_subscription(owner, repo) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->user_current_check_subscription: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | ### Return type [**WatchInfo**](WatchInfo.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json, text/html [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **user_current_delete_subscription** > user_current_delete_subscription(owner, repo) Unwatch a repo ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo try: # Unwatch a repo api_instance.user_current_delete_subscription(owner, repo) except ApiException as e: print("Exception when calling RepositoryApi->user_current_delete_subscription: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | ### Return type void (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json, text/html [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **user_current_put_subscription** > WatchInfo user_current_put_subscription(owner, repo) Watch a repo ### Example ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = swagger_client.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = swagger_client.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = swagger_client.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = swagger_client.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = swagger_client.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: Token configuration = swagger_client.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = swagger_client.RepositoryApi(swagger_client.ApiClient(configuration)) owner = 'owner_example' # str | owner of the repo repo = 'repo_example' # str | name of the repo try: # Watch a repo api_response = api_instance.user_current_put_subscription(owner, repo) pprint(api_response) except ApiException as e: print("Exception when calling RepositoryApi->user_current_put_subscription: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **str**| owner of the repo | **repo** | **str**| name of the repo | ### Return type [**WatchInfo**](WatchInfo.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json, text/html [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)