|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420 |
- # Rust API client for swagger
-
- This documentation describes the Gitea API.
-
- ## Overview
- This API client was generated by the [swagger-codegen](https://github.com/swagger-api/swagger-codegen) project. By using the [swagger-spec](https://github.com/swagger-api/swagger-spec) from a remote server, you can easily generate an API client.
-
- - API version: 1.1.1
- - Package version: 1.0.0
- - Build package: io.swagger.codegen.languages.RustClientCodegen
-
- ## Installation
- Put the package under your project folder and add the following in import:
- ```
- "./swagger"
- ```
-
- ## Documentation for API Endpoints
-
- All URIs are relative to *http://localhost/api/v1*
-
- Class | Method | HTTP request | Description
- ------------ | ------------- | ------------- | -------------
- *AdminApi* | [**admin_create_org**](docs/AdminApi.md#admin_create_org) | **Post** /admin/users/{username}/orgs | Create an organization
- *AdminApi* | [**admin_create_public_key**](docs/AdminApi.md#admin_create_public_key) | **Post** /admin/users/{username}/keys | Add a public key on behalf of a user
- *AdminApi* | [**admin_create_repo**](docs/AdminApi.md#admin_create_repo) | **Post** /admin/users/{username}/repos | Create a repository on behalf a user
- *AdminApi* | [**admin_create_user**](docs/AdminApi.md#admin_create_user) | **Post** /admin/users | Create a user
- *AdminApi* | [**admin_delete_user**](docs/AdminApi.md#admin_delete_user) | **Delete** /admin/users/{username} | Delete a user
- *AdminApi* | [**admin_delete_user_public_key**](docs/AdminApi.md#admin_delete_user_public_key) | **Delete** /admin/users/{username}/keys/{id} | Delete a user's public key
- *AdminApi* | [**admin_edit_user**](docs/AdminApi.md#admin_edit_user) | **Patch** /admin/users/{username} | Edit an existing user
- *AdminApi* | [**admin_get_all_orgs**](docs/AdminApi.md#admin_get_all_orgs) | **Get** /admin/orgs | List all organizations
- *AdminApi* | [**admin_get_all_users**](docs/AdminApi.md#admin_get_all_users) | **Get** /admin/users | List all users
- *IssueApi* | [**issue_add_label**](docs/IssueApi.md#issue_add_label) | **Post** /repos/{owner}/{repo}/issues/{index}/labels | Add a label to an issue
- *IssueApi* | [**issue_add_subscription**](docs/IssueApi.md#issue_add_subscription) | **Put** /repos/{owner}/{repo}/issues/{index}/subscriptions/{user} | Subscribe user to issue
- *IssueApi* | [**issue_add_time**](docs/IssueApi.md#issue_add_time) | **Post** /repos/{owner}/{repo}/issues/{index}/times | Add tracked time to a issue
- *IssueApi* | [**issue_clear_labels**](docs/IssueApi.md#issue_clear_labels) | **Delete** /repos/{owner}/{repo}/issues/{index}/labels | Remove all labels from an issue
- *IssueApi* | [**issue_create_comment**](docs/IssueApi.md#issue_create_comment) | **Post** /repos/{owner}/{repo}/issues/{index}/comments | Add a comment to an issue
- *IssueApi* | [**issue_create_issue**](docs/IssueApi.md#issue_create_issue) | **Post** /repos/{owner}/{repo}/issues | Create an issue. If using deadline only the date will be taken into account, and time of day ignored.
- *IssueApi* | [**issue_create_label**](docs/IssueApi.md#issue_create_label) | **Post** /repos/{owner}/{repo}/labels | Create a label
- *IssueApi* | [**issue_create_milestone**](docs/IssueApi.md#issue_create_milestone) | **Post** /repos/{owner}/{repo}/milestones | Create a milestone
- *IssueApi* | [**issue_delete_comment**](docs/IssueApi.md#issue_delete_comment) | **Delete** /repos/{owner}/{repo}/issues/comments/{id} | Delete a comment
- *IssueApi* | [**issue_delete_comment_deprecated**](docs/IssueApi.md#issue_delete_comment_deprecated) | **Delete** /repos/{owner}/{repo}/issues/{index}/comments/{id} | Delete a comment
- *IssueApi* | [**issue_delete_comment_reaction**](docs/IssueApi.md#issue_delete_comment_reaction) | **Delete** /repos/{owner}/{repo}/issues/comments/{id}/reactions | Remove a reaction from a comment of an issue
- *IssueApi* | [**issue_delete_issue_reaction**](docs/IssueApi.md#issue_delete_issue_reaction) | **Delete** /repos/{owner}/{repo}/issues/{index}/reactions | Remove a reaction from an issue
- *IssueApi* | [**issue_delete_label**](docs/IssueApi.md#issue_delete_label) | **Delete** /repos/{owner}/{repo}/labels/{id} | Delete a label
- *IssueApi* | [**issue_delete_milestone**](docs/IssueApi.md#issue_delete_milestone) | **Delete** /repos/{owner}/{repo}/milestones/{id} | Delete a milestone
- *IssueApi* | [**issue_delete_stop_watch**](docs/IssueApi.md#issue_delete_stop_watch) | **Delete** /repos/{owner}/{repo}/issues/{index}/stopwatch/delete | Delete an issue's existing stopwatch.
- *IssueApi* | [**issue_delete_subscription**](docs/IssueApi.md#issue_delete_subscription) | **Delete** /repos/{owner}/{repo}/issues/{index}/subscriptions/{user} | Unsubscribe user from issue
- *IssueApi* | [**issue_delete_time**](docs/IssueApi.md#issue_delete_time) | **Delete** /repos/{owner}/{repo}/issues/{index}/times/{id} | Delete specific tracked time
- *IssueApi* | [**issue_edit_comment**](docs/IssueApi.md#issue_edit_comment) | **Patch** /repos/{owner}/{repo}/issues/comments/{id} | Edit a comment
- *IssueApi* | [**issue_edit_comment_deprecated**](docs/IssueApi.md#issue_edit_comment_deprecated) | **Patch** /repos/{owner}/{repo}/issues/{index}/comments/{id} | Edit a comment
- *IssueApi* | [**issue_edit_issue**](docs/IssueApi.md#issue_edit_issue) | **Patch** /repos/{owner}/{repo}/issues/{index} | Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.
- *IssueApi* | [**issue_edit_issue_deadline**](docs/IssueApi.md#issue_edit_issue_deadline) | **Post** /repos/{owner}/{repo}/issues/{index}/deadline | Set an issue deadline. If set to null, the deadline is deleted. If using deadline only the date will be taken into account, and time of day ignored.
- *IssueApi* | [**issue_edit_label**](docs/IssueApi.md#issue_edit_label) | **Patch** /repos/{owner}/{repo}/labels/{id} | Update a label
- *IssueApi* | [**issue_edit_milestone**](docs/IssueApi.md#issue_edit_milestone) | **Patch** /repos/{owner}/{repo}/milestones/{id} | Update a milestone
- *IssueApi* | [**issue_get_comment_reactions**](docs/IssueApi.md#issue_get_comment_reactions) | **Get** /repos/{owner}/{repo}/issues/comments/{id}/reactions | Get a list of reactions from a comment of an issue
- *IssueApi* | [**issue_get_comments**](docs/IssueApi.md#issue_get_comments) | **Get** /repos/{owner}/{repo}/issues/{index}/comments | List all comments on an issue
- *IssueApi* | [**issue_get_issue**](docs/IssueApi.md#issue_get_issue) | **Get** /repos/{owner}/{repo}/issues/{index} | Get an issue
- *IssueApi* | [**issue_get_issue_reactions**](docs/IssueApi.md#issue_get_issue_reactions) | **Get** /repos/{owner}/{repo}/issues/{index}/reactions | Get a list reactions of an issue
- *IssueApi* | [**issue_get_label**](docs/IssueApi.md#issue_get_label) | **Get** /repos/{owner}/{repo}/labels/{id} | Get a single label
- *IssueApi* | [**issue_get_labels**](docs/IssueApi.md#issue_get_labels) | **Get** /repos/{owner}/{repo}/issues/{index}/labels | Get an issue's labels
- *IssueApi* | [**issue_get_milestone**](docs/IssueApi.md#issue_get_milestone) | **Get** /repos/{owner}/{repo}/milestones/{id} | Get a milestone
- *IssueApi* | [**issue_get_milestones_list**](docs/IssueApi.md#issue_get_milestones_list) | **Get** /repos/{owner}/{repo}/milestones | Get all of a repository's opened milestones
- *IssueApi* | [**issue_get_repo_comments**](docs/IssueApi.md#issue_get_repo_comments) | **Get** /repos/{owner}/{repo}/issues/comments | List all comments in a repository
- *IssueApi* | [**issue_list_issues**](docs/IssueApi.md#issue_list_issues) | **Get** /repos/{owner}/{repo}/issues | List a repository's issues
- *IssueApi* | [**issue_list_labels**](docs/IssueApi.md#issue_list_labels) | **Get** /repos/{owner}/{repo}/labels | Get all of a repository's labels
- *IssueApi* | [**issue_post_comment_reaction**](docs/IssueApi.md#issue_post_comment_reaction) | **Post** /repos/{owner}/{repo}/issues/comments/{id}/reactions | Add a reaction to a comment of an issue
- *IssueApi* | [**issue_post_issue_reaction**](docs/IssueApi.md#issue_post_issue_reaction) | **Post** /repos/{owner}/{repo}/issues/{index}/reactions | Add a reaction to an issue
- *IssueApi* | [**issue_remove_label**](docs/IssueApi.md#issue_remove_label) | **Delete** /repos/{owner}/{repo}/issues/{index}/labels/{id} | Remove a label from an issue
- *IssueApi* | [**issue_replace_labels**](docs/IssueApi.md#issue_replace_labels) | **Put** /repos/{owner}/{repo}/issues/{index}/labels | Replace an issue's labels
- *IssueApi* | [**issue_reset_time**](docs/IssueApi.md#issue_reset_time) | **Delete** /repos/{owner}/{repo}/issues/{index}/times | Reset a tracked time of an issue
- *IssueApi* | [**issue_search_issues**](docs/IssueApi.md#issue_search_issues) | **Get** /repos/issues/search | Search for issues across the repositories that the user has access to
- *IssueApi* | [**issue_start_stop_watch**](docs/IssueApi.md#issue_start_stop_watch) | **Post** /repos/{owner}/{repo}/issues/{index}/stopwatch/start | Start stopwatch on an issue.
- *IssueApi* | [**issue_stop_stop_watch**](docs/IssueApi.md#issue_stop_stop_watch) | **Post** /repos/{owner}/{repo}/issues/{index}/stopwatch/stop | Stop an issue's existing stopwatch.
- *IssueApi* | [**issue_subscriptions**](docs/IssueApi.md#issue_subscriptions) | **Get** /repos/{owner}/{repo}/issues/{index}/subscriptions | Get users who subscribed on an issue.
- *IssueApi* | [**issue_tracked_times**](docs/IssueApi.md#issue_tracked_times) | **Get** /repos/{owner}/{repo}/issues/{index}/times | List an issue's tracked times
- *MiscellaneousApi* | [**get_signing_key**](docs/MiscellaneousApi.md#get_signing_key) | **Get** /signing-key.gpg | Get default signing-key.gpg
- *MiscellaneousApi* | [**get_version**](docs/MiscellaneousApi.md#get_version) | **Get** /version | Returns the version of the Gitea application
- *MiscellaneousApi* | [**render_markdown**](docs/MiscellaneousApi.md#render_markdown) | **Post** /markdown | Render a markdown document as HTML
- *MiscellaneousApi* | [**render_markdown_raw**](docs/MiscellaneousApi.md#render_markdown_raw) | **Post** /markdown/raw | Render raw markdown as HTML
- *OrganizationApi* | [**create_org_repo**](docs/OrganizationApi.md#create_org_repo) | **Post** /org/{org}/repos | Create a repository in an organization
- *OrganizationApi* | [**org_add_team_member**](docs/OrganizationApi.md#org_add_team_member) | **Put** /teams/{id}/members/{username} | Add a team member
- *OrganizationApi* | [**org_add_team_repository**](docs/OrganizationApi.md#org_add_team_repository) | **Put** /teams/{id}/repos/{org}/{repo} | Add a repository to a team
- *OrganizationApi* | [**org_conceal_member**](docs/OrganizationApi.md#org_conceal_member) | **Delete** /orgs/{org}/public_members/{username} | Conceal a user's membership
- *OrganizationApi* | [**org_create**](docs/OrganizationApi.md#org_create) | **Post** /orgs | Create an organization
- *OrganizationApi* | [**org_create_hook**](docs/OrganizationApi.md#org_create_hook) | **Post** /orgs/{org}/hooks/ | Create a hook
- *OrganizationApi* | [**org_create_team**](docs/OrganizationApi.md#org_create_team) | **Post** /orgs/{org}/teams | Create a team
- *OrganizationApi* | [**org_delete**](docs/OrganizationApi.md#org_delete) | **Delete** /orgs/{org} | Delete an organization
- *OrganizationApi* | [**org_delete_hook**](docs/OrganizationApi.md#org_delete_hook) | **Delete** /orgs/{org}/hooks/{id} | Delete a hook
- *OrganizationApi* | [**org_delete_member**](docs/OrganizationApi.md#org_delete_member) | **Delete** /orgs/{org}/members/{username} | Remove a member from an organization
- *OrganizationApi* | [**org_delete_team**](docs/OrganizationApi.md#org_delete_team) | **Delete** /teams/{id} | Delete a team
- *OrganizationApi* | [**org_edit**](docs/OrganizationApi.md#org_edit) | **Patch** /orgs/{org} | Edit an organization
- *OrganizationApi* | [**org_edit_hook**](docs/OrganizationApi.md#org_edit_hook) | **Patch** /orgs/{org}/hooks/{id} | Update a hook
- *OrganizationApi* | [**org_edit_team**](docs/OrganizationApi.md#org_edit_team) | **Patch** /teams/{id} | Edit a team
- *OrganizationApi* | [**org_get**](docs/OrganizationApi.md#org_get) | **Get** /orgs/{org} | Get an organization
- *OrganizationApi* | [**org_get_hook**](docs/OrganizationApi.md#org_get_hook) | **Get** /orgs/{org}/hooks/{id} | Get a hook
- *OrganizationApi* | [**org_get_team**](docs/OrganizationApi.md#org_get_team) | **Get** /teams/{id} | Get a team
- *OrganizationApi* | [**org_is_member**](docs/OrganizationApi.md#org_is_member) | **Get** /orgs/{org}/members/{username} | Check if a user is a member of an organization
- *OrganizationApi* | [**org_is_public_member**](docs/OrganizationApi.md#org_is_public_member) | **Get** /orgs/{org}/public_members/{username} | Check if a user is a public member of an organization
- *OrganizationApi* | [**org_list_current_user_orgs**](docs/OrganizationApi.md#org_list_current_user_orgs) | **Get** /user/orgs | List the current user's organizations
- *OrganizationApi* | [**org_list_hooks**](docs/OrganizationApi.md#org_list_hooks) | **Get** /orgs/{org}/hooks | List an organization's webhooks
- *OrganizationApi* | [**org_list_members**](docs/OrganizationApi.md#org_list_members) | **Get** /orgs/{org}/members | List an organization's members
- *OrganizationApi* | [**org_list_public_members**](docs/OrganizationApi.md#org_list_public_members) | **Get** /orgs/{org}/public_members | List an organization's public members
- *OrganizationApi* | [**org_list_repos**](docs/OrganizationApi.md#org_list_repos) | **Get** /orgs/{org}/repos | List an organization's repos
- *OrganizationApi* | [**org_list_team_member**](docs/OrganizationApi.md#org_list_team_member) | **Get** /teams/{id}/members/{username} | List a particular member of team
- *OrganizationApi* | [**org_list_team_members**](docs/OrganizationApi.md#org_list_team_members) | **Get** /teams/{id}/members | List a team's members
- *OrganizationApi* | [**org_list_team_repos**](docs/OrganizationApi.md#org_list_team_repos) | **Get** /teams/{id}/repos | List a team's repos
- *OrganizationApi* | [**org_list_teams**](docs/OrganizationApi.md#org_list_teams) | **Get** /orgs/{org}/teams | List an organization's teams
- *OrganizationApi* | [**org_list_user_orgs**](docs/OrganizationApi.md#org_list_user_orgs) | **Get** /users/{username}/orgs | List a user's organizations
- *OrganizationApi* | [**org_publicize_member**](docs/OrganizationApi.md#org_publicize_member) | **Put** /orgs/{org}/public_members/{username} | Publicize a user's membership
- *OrganizationApi* | [**org_remove_team_member**](docs/OrganizationApi.md#org_remove_team_member) | **Delete** /teams/{id}/members/{username} | Remove a team member
- *OrganizationApi* | [**org_remove_team_repository**](docs/OrganizationApi.md#org_remove_team_repository) | **Delete** /teams/{id}/repos/{org}/{repo} | Remove a repository from a team
- *OrganizationApi* | [**team_search**](docs/OrganizationApi.md#team_search) | **Get** /orgs/{org}/teams/search | Search for teams within an organization
- *RepositoryApi* | [**create_current_user_repo**](docs/RepositoryApi.md#create_current_user_repo) | **Post** /user/repos | Create a repository
- *RepositoryApi* | [**create_fork**](docs/RepositoryApi.md#create_fork) | **Post** /repos/{owner}/{repo}/forks | Fork a repository
- *RepositoryApi* | [**get_blob**](docs/RepositoryApi.md#get_blob) | **Get** /repos/{owner}/{repo}/git/blobs/{sha} | Gets the blob of a repository.
- *RepositoryApi* | [**get_tag**](docs/RepositoryApi.md#get_tag) | **Get** /repos/{owner}/{repo}/git/tags/{sha} | Gets the tag object of an annotated tag (not lightweight tags)
- *RepositoryApi* | [**get_tree**](docs/RepositoryApi.md#get_tree) | **Get** /repos/{owner}/{repo}/git/trees/{sha} | Gets the tree of a repository.
- *RepositoryApi* | [**list_forks**](docs/RepositoryApi.md#list_forks) | **Get** /repos/{owner}/{repo}/forks | List a repository's forks
- *RepositoryApi* | [**repo_add_collaborator**](docs/RepositoryApi.md#repo_add_collaborator) | **Put** /repos/{owner}/{repo}/collaborators/{collaborator} | Add a collaborator to a repository
- *RepositoryApi* | [**repo_add_topc**](docs/RepositoryApi.md#repo_add_topc) | **Put** /repos/{owner}/{repo}/topics/{topic} | Add a topic to a repository
- *RepositoryApi* | [**repo_check_collaborator**](docs/RepositoryApi.md#repo_check_collaborator) | **Get** /repos/{owner}/{repo}/collaborators/{collaborator} | Check if a user is a collaborator of a repository
- *RepositoryApi* | [**repo_create_file**](docs/RepositoryApi.md#repo_create_file) | **Post** /repos/{owner}/{repo}/contents/{filepath} | Create a file in a repository
- *RepositoryApi* | [**repo_create_hook**](docs/RepositoryApi.md#repo_create_hook) | **Post** /repos/{owner}/{repo}/hooks | Create a hook
- *RepositoryApi* | [**repo_create_key**](docs/RepositoryApi.md#repo_create_key) | **Post** /repos/{owner}/{repo}/keys | Add a key to a repository
- *RepositoryApi* | [**repo_create_pull_request**](docs/RepositoryApi.md#repo_create_pull_request) | **Post** /repos/{owner}/{repo}/pulls | Create a pull request
- *RepositoryApi* | [**repo_create_release**](docs/RepositoryApi.md#repo_create_release) | **Post** /repos/{owner}/{repo}/releases | Create a release
- *RepositoryApi* | [**repo_create_release_attachment**](docs/RepositoryApi.md#repo_create_release_attachment) | **Post** /repos/{owner}/{repo}/releases/{id}/assets | Create a release attachment
- *RepositoryApi* | [**repo_create_status**](docs/RepositoryApi.md#repo_create_status) | **Post** /repos/{owner}/{repo}/statuses/{sha} | Create a commit status
- *RepositoryApi* | [**repo_delete**](docs/RepositoryApi.md#repo_delete) | **Delete** /repos/{owner}/{repo} | Delete a repository
- *RepositoryApi* | [**repo_delete_collaborator**](docs/RepositoryApi.md#repo_delete_collaborator) | **Delete** /repos/{owner}/{repo}/collaborators/{collaborator} | Delete a collaborator from a repository
- *RepositoryApi* | [**repo_delete_file**](docs/RepositoryApi.md#repo_delete_file) | **Delete** /repos/{owner}/{repo}/contents/{filepath} | Delete a file in a repository
- *RepositoryApi* | [**repo_delete_git_hook**](docs/RepositoryApi.md#repo_delete_git_hook) | **Delete** /repos/{owner}/{repo}/hooks/git/{id} | Delete a Git hook in a repository
- *RepositoryApi* | [**repo_delete_hook**](docs/RepositoryApi.md#repo_delete_hook) | **Delete** /repos/{owner}/{repo}/hooks/{id} | Delete a hook in a repository
- *RepositoryApi* | [**repo_delete_key**](docs/RepositoryApi.md#repo_delete_key) | **Delete** /repos/{owner}/{repo}/keys/{id} | Delete a key from a repository
- *RepositoryApi* | [**repo_delete_release**](docs/RepositoryApi.md#repo_delete_release) | **Delete** /repos/{owner}/{repo}/releases/{id} | Delete a release
- *RepositoryApi* | [**repo_delete_release_attachment**](docs/RepositoryApi.md#repo_delete_release_attachment) | **Delete** /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id} | Delete a release attachment
- *RepositoryApi* | [**repo_delete_topic**](docs/RepositoryApi.md#repo_delete_topic) | **Delete** /repos/{owner}/{repo}/topics/{topic} | Delete a topic from a repository
- *RepositoryApi* | [**repo_edit**](docs/RepositoryApi.md#repo_edit) | **Patch** /repos/{owner}/{repo} | Edit a repository's properties. Only fields that are set will be changed.
- *RepositoryApi* | [**repo_edit_git_hook**](docs/RepositoryApi.md#repo_edit_git_hook) | **Patch** /repos/{owner}/{repo}/hooks/git/{id} | Edit a Git hook in a repository
- *RepositoryApi* | [**repo_edit_hook**](docs/RepositoryApi.md#repo_edit_hook) | **Patch** /repos/{owner}/{repo}/hooks/{id} | Edit a hook in a repository
- *RepositoryApi* | [**repo_edit_pull_request**](docs/RepositoryApi.md#repo_edit_pull_request) | **Patch** /repos/{owner}/{repo}/pulls/{index} | Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.
- *RepositoryApi* | [**repo_edit_release**](docs/RepositoryApi.md#repo_edit_release) | **Patch** /repos/{owner}/{repo}/releases/{id} | Update a release
- *RepositoryApi* | [**repo_edit_release_attachment**](docs/RepositoryApi.md#repo_edit_release_attachment) | **Patch** /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id} | Edit a release attachment
- *RepositoryApi* | [**repo_get**](docs/RepositoryApi.md#repo_get) | **Get** /repos/{owner}/{repo} | Get a repository
- *RepositoryApi* | [**repo_get_all_commits**](docs/RepositoryApi.md#repo_get_all_commits) | **Get** /repos/{owner}/{repo}/commits | Get a list of all commits from a repository
- *RepositoryApi* | [**repo_get_archive**](docs/RepositoryApi.md#repo_get_archive) | **Get** /repos/{owner}/{repo}/archive/{archive} | Get an archive of a repository
- *RepositoryApi* | [**repo_get_branch**](docs/RepositoryApi.md#repo_get_branch) | **Get** /repos/{owner}/{repo}/branches/{branch} | Retrieve a specific branch from a repository, including its effective branch protection
- *RepositoryApi* | [**repo_get_by_id**](docs/RepositoryApi.md#repo_get_by_id) | **Get** /repositories/{id} | Get a repository by id
- *RepositoryApi* | [**repo_get_combined_status_by_ref**](docs/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
- *RepositoryApi* | [**repo_get_contents**](docs/RepositoryApi.md#repo_get_contents) | **Get** /repos/{owner}/{repo}/contents/{filepath} | Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir
- *RepositoryApi* | [**repo_get_contents_list**](docs/RepositoryApi.md#repo_get_contents_list) | **Get** /repos/{owner}/{repo}/contents | Gets the metadata of all the entries of the root dir
- *RepositoryApi* | [**repo_get_editor_config**](docs/RepositoryApi.md#repo_get_editor_config) | **Get** /repos/{owner}/{repo}/editorconfig/{filepath} | Get the EditorConfig definitions of a file in a repository
- *RepositoryApi* | [**repo_get_git_hook**](docs/RepositoryApi.md#repo_get_git_hook) | **Get** /repos/{owner}/{repo}/hooks/git/{id} | Get a Git hook
- *RepositoryApi* | [**repo_get_hook**](docs/RepositoryApi.md#repo_get_hook) | **Get** /repos/{owner}/{repo}/hooks/{id} | Get a hook
- *RepositoryApi* | [**repo_get_key**](docs/RepositoryApi.md#repo_get_key) | **Get** /repos/{owner}/{repo}/keys/{id} | Get a repository's key by id
- *RepositoryApi* | [**repo_get_pull_request**](docs/RepositoryApi.md#repo_get_pull_request) | **Get** /repos/{owner}/{repo}/pulls/{index} | Get a pull request
- *RepositoryApi* | [**repo_get_raw_file**](docs/RepositoryApi.md#repo_get_raw_file) | **Get** /repos/{owner}/{repo}/raw/{filepath} | Get a file from a repository
- *RepositoryApi* | [**repo_get_release**](docs/RepositoryApi.md#repo_get_release) | **Get** /repos/{owner}/{repo}/releases/{id} | Get a release
- *RepositoryApi* | [**repo_get_release_attachment**](docs/RepositoryApi.md#repo_get_release_attachment) | **Get** /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id} | Get a release attachment
- *RepositoryApi* | [**repo_get_single_commit**](docs/RepositoryApi.md#repo_get_single_commit) | **Get** /repos/{owner}/{repo}/git/commits/{sha} | Get a single commit from a repository
- *RepositoryApi* | [**repo_list_all_git_refs**](docs/RepositoryApi.md#repo_list_all_git_refs) | **Get** /repos/{owner}/{repo}/git/refs | Get specified ref or filtered repository's refs
- *RepositoryApi* | [**repo_list_branches**](docs/RepositoryApi.md#repo_list_branches) | **Get** /repos/{owner}/{repo}/branches | List a repository's branches
- *RepositoryApi* | [**repo_list_collaborators**](docs/RepositoryApi.md#repo_list_collaborators) | **Get** /repos/{owner}/{repo}/collaborators | List a repository's collaborators
- *RepositoryApi* | [**repo_list_git_hooks**](docs/RepositoryApi.md#repo_list_git_hooks) | **Get** /repos/{owner}/{repo}/hooks/git | List the Git hooks in a repository
- *RepositoryApi* | [**repo_list_git_refs**](docs/RepositoryApi.md#repo_list_git_refs) | **Get** /repos/{owner}/{repo}/git/refs/{ref} | Get specified ref or filtered repository's refs
- *RepositoryApi* | [**repo_list_hooks**](docs/RepositoryApi.md#repo_list_hooks) | **Get** /repos/{owner}/{repo}/hooks | List the hooks in a repository
- *RepositoryApi* | [**repo_list_keys**](docs/RepositoryApi.md#repo_list_keys) | **Get** /repos/{owner}/{repo}/keys | List a repository's keys
- *RepositoryApi* | [**repo_list_pull_requests**](docs/RepositoryApi.md#repo_list_pull_requests) | **Get** /repos/{owner}/{repo}/pulls | List a repo's pull requests
- *RepositoryApi* | [**repo_list_release_attachments**](docs/RepositoryApi.md#repo_list_release_attachments) | **Get** /repos/{owner}/{repo}/releases/{id}/assets | List release's attachments
- *RepositoryApi* | [**repo_list_releases**](docs/RepositoryApi.md#repo_list_releases) | **Get** /repos/{owner}/{repo}/releases | List a repo's releases
- *RepositoryApi* | [**repo_list_stargazers**](docs/RepositoryApi.md#repo_list_stargazers) | **Get** /repos/{owner}/{repo}/stargazers | List a repo's stargazers
- *RepositoryApi* | [**repo_list_statuses**](docs/RepositoryApi.md#repo_list_statuses) | **Get** /repos/{owner}/{repo}/statuses/{sha} | Get a commit's statuses
- *RepositoryApi* | [**repo_list_subscribers**](docs/RepositoryApi.md#repo_list_subscribers) | **Get** /repos/{owner}/{repo}/subscribers | List a repo's watchers
- *RepositoryApi* | [**repo_list_tags**](docs/RepositoryApi.md#repo_list_tags) | **Get** /repos/{owner}/{repo}/tags | List a repository's tags
- *RepositoryApi* | [**repo_list_topics**](docs/RepositoryApi.md#repo_list_topics) | **Get** /repos/{owner}/{repo}/topics | Get list of topics that a repository has
- *RepositoryApi* | [**repo_merge_pull_request**](docs/RepositoryApi.md#repo_merge_pull_request) | **Post** /repos/{owner}/{repo}/pulls/{index}/merge | Merge a pull request
- *RepositoryApi* | [**repo_migrate**](docs/RepositoryApi.md#repo_migrate) | **Post** /repos/migrate | Migrate a remote git repository
- *RepositoryApi* | [**repo_mirror_sync**](docs/RepositoryApi.md#repo_mirror_sync) | **Post** /repos/{owner}/{repo}/mirror-sync | Sync a mirrored repository
- *RepositoryApi* | [**repo_pull_request_is_merged**](docs/RepositoryApi.md#repo_pull_request_is_merged) | **Get** /repos/{owner}/{repo}/pulls/{index}/merge | Check if a pull request has been merged
- *RepositoryApi* | [**repo_search**](docs/RepositoryApi.md#repo_search) | **Get** /repos/search | Search for repositories
- *RepositoryApi* | [**repo_signing_key**](docs/RepositoryApi.md#repo_signing_key) | **Get** /repos/{owner}/{repo}/signing-key.gpg | Get signing-key.gpg for given repository
- *RepositoryApi* | [**repo_test_hook**](docs/RepositoryApi.md#repo_test_hook) | **Post** /repos/{owner}/{repo}/hooks/{id}/tests | Test a push webhook
- *RepositoryApi* | [**repo_tracked_times**](docs/RepositoryApi.md#repo_tracked_times) | **Get** /repos/{owner}/{repo}/times | List a repo's tracked times
- *RepositoryApi* | [**repo_update_file**](docs/RepositoryApi.md#repo_update_file) | **Put** /repos/{owner}/{repo}/contents/{filepath} | Update a file in a repository
- *RepositoryApi* | [**repo_update_topics**](docs/RepositoryApi.md#repo_update_topics) | **Put** /repos/{owner}/{repo}/topics | Replace list of topics for a repository
- *RepositoryApi* | [**topic_search**](docs/RepositoryApi.md#topic_search) | **Get** /topics/search | search topics via keyword
- *RepositoryApi* | [**user_current_check_subscription**](docs/RepositoryApi.md#user_current_check_subscription) | **Get** /repos/{owner}/{repo}/subscription | Check if the current user is watching a repo
- *RepositoryApi* | [**user_current_delete_subscription**](docs/RepositoryApi.md#user_current_delete_subscription) | **Delete** /repos/{owner}/{repo}/subscription | Unwatch a repo
- *RepositoryApi* | [**user_current_put_subscription**](docs/RepositoryApi.md#user_current_put_subscription) | **Put** /repos/{owner}/{repo}/subscription | Watch a repo
- *UserApi* | [**create_current_user_repo**](docs/UserApi.md#create_current_user_repo) | **Post** /user/repos | Create a repository
- *UserApi* | [**user_add_email**](docs/UserApi.md#user_add_email) | **Post** /user/emails | Add email addresses
- *UserApi* | [**user_check_following**](docs/UserApi.md#user_check_following) | **Get** /users/{follower}/following/{followee} | Check if one user is following another user
- *UserApi* | [**user_create_token**](docs/UserApi.md#user_create_token) | **Post** /users/{username}/tokens | Create an access token
- *UserApi* | [**user_current_check_following**](docs/UserApi.md#user_current_check_following) | **Get** /user/following/{username} | Check whether a user is followed by the authenticated user
- *UserApi* | [**user_current_check_starring**](docs/UserApi.md#user_current_check_starring) | **Get** /user/starred/{owner}/{repo} | Whether the authenticated is starring the repo
- *UserApi* | [**user_current_delete_follow**](docs/UserApi.md#user_current_delete_follow) | **Delete** /user/following/{username} | Unfollow a user
- *UserApi* | [**user_current_delete_gpg_key**](docs/UserApi.md#user_current_delete_gpg_key) | **Delete** /user/gpg_keys/{id} | Remove a GPG key
- *UserApi* | [**user_current_delete_key**](docs/UserApi.md#user_current_delete_key) | **Delete** /user/keys/{id} | Delete a public key
- *UserApi* | [**user_current_delete_star**](docs/UserApi.md#user_current_delete_star) | **Delete** /user/starred/{owner}/{repo} | Unstar the given repo
- *UserApi* | [**user_current_get_gpg_key**](docs/UserApi.md#user_current_get_gpg_key) | **Get** /user/gpg_keys/{id} | Get a GPG key
- *UserApi* | [**user_current_get_key**](docs/UserApi.md#user_current_get_key) | **Get** /user/keys/{id} | Get a public key
- *UserApi* | [**user_current_list_followers**](docs/UserApi.md#user_current_list_followers) | **Get** /user/followers | List the authenticated user's followers
- *UserApi* | [**user_current_list_following**](docs/UserApi.md#user_current_list_following) | **Get** /user/following | List the users that the authenticated user is following
- *UserApi* | [**user_current_list_gpg_keys**](docs/UserApi.md#user_current_list_gpg_keys) | **Get** /user/gpg_keys | List the authenticated user's GPG keys
- *UserApi* | [**user_current_list_keys**](docs/UserApi.md#user_current_list_keys) | **Get** /user/keys | List the authenticated user's public keys
- *UserApi* | [**user_current_list_repos**](docs/UserApi.md#user_current_list_repos) | **Get** /user/repos | List the repos that the authenticated user owns or has access to
- *UserApi* | [**user_current_list_starred**](docs/UserApi.md#user_current_list_starred) | **Get** /user/starred | The repos that the authenticated user has starred
- *UserApi* | [**user_current_list_subscriptions**](docs/UserApi.md#user_current_list_subscriptions) | **Get** /user/subscriptions | List repositories watched by the authenticated user
- *UserApi* | [**user_current_post_gpg_key**](docs/UserApi.md#user_current_post_gpg_key) | **Post** /user/gpg_keys | Create a GPG key
- *UserApi* | [**user_current_post_key**](docs/UserApi.md#user_current_post_key) | **Post** /user/keys | Create a public key
- *UserApi* | [**user_current_put_follow**](docs/UserApi.md#user_current_put_follow) | **Put** /user/following/{username} | Follow a user
- *UserApi* | [**user_current_put_star**](docs/UserApi.md#user_current_put_star) | **Put** /user/starred/{owner}/{repo} | Star the given repo
- *UserApi* | [**user_current_tracked_times**](docs/UserApi.md#user_current_tracked_times) | **Get** /user/times | List the current user's tracked times
- *UserApi* | [**user_delete_access_token**](docs/UserApi.md#user_delete_access_token) | **Delete** /users/{username}/tokens/{token} | delete an access token
- *UserApi* | [**user_delete_email**](docs/UserApi.md#user_delete_email) | **Delete** /user/emails | Delete email addresses
- *UserApi* | [**user_get**](docs/UserApi.md#user_get) | **Get** /users/{username} | Get a user
- *UserApi* | [**user_get_current**](docs/UserApi.md#user_get_current) | **Get** /user | Get the authenticated user
- *UserApi* | [**user_get_heatmap_data**](docs/UserApi.md#user_get_heatmap_data) | **Get** /users/{username}/heatmap | Get a user's heatmap
- *UserApi* | [**user_get_stop_watches**](docs/UserApi.md#user_get_stop_watches) | **Get** /user/stopwatches | Get list of all existing stopwatches
- *UserApi* | [**user_get_tokens**](docs/UserApi.md#user_get_tokens) | **Get** /users/{username}/tokens | List the authenticated user's access tokens
- *UserApi* | [**user_list_emails**](docs/UserApi.md#user_list_emails) | **Get** /user/emails | List the authenticated user's email addresses
- *UserApi* | [**user_list_followers**](docs/UserApi.md#user_list_followers) | **Get** /users/{username}/followers | List the given user's followers
- *UserApi* | [**user_list_following**](docs/UserApi.md#user_list_following) | **Get** /users/{username}/following | List the users that the given user is following
- *UserApi* | [**user_list_gpg_keys**](docs/UserApi.md#user_list_gpg_keys) | **Get** /users/{username}/gpg_keys | List the given user's GPG keys
- *UserApi* | [**user_list_keys**](docs/UserApi.md#user_list_keys) | **Get** /users/{username}/keys | List the given user's public keys
- *UserApi* | [**user_list_repos**](docs/UserApi.md#user_list_repos) | **Get** /users/{username}/repos | List the repos owned by the given user
- *UserApi* | [**user_list_starred**](docs/UserApi.md#user_list_starred) | **Get** /users/{username}/starred | The repos that the given user has starred
- *UserApi* | [**user_list_subscriptions**](docs/UserApi.md#user_list_subscriptions) | **Get** /users/{username}/subscriptions | List the repositories watched by a user
- *UserApi* | [**user_list_teams**](docs/UserApi.md#user_list_teams) | **Get** /user/teams | List all the teams a user belongs to
- *UserApi* | [**user_search**](docs/UserApi.md#user_search) | **Get** /users/search | Search for users
- *UserApi* | [**user_tracked_times**](docs/UserApi.md#user_tracked_times) | **Get** /repos/{owner}/{repo}/times/{user} | List a user's tracked times in a repo
-
-
- ## Documentation For Models
-
- - [AccessToken](docs/AccessToken.md)
- - [AddCollaboratorOption](docs/AddCollaboratorOption.md)
- - [AddTimeOption](docs/AddTimeOption.md)
- - [AnnotatedTag](docs/AnnotatedTag.md)
- - [AnnotatedTagObject](docs/AnnotatedTagObject.md)
- - [ApiError](docs/ApiError.md)
- - [Attachment](docs/Attachment.md)
- - [Branch](docs/Branch.md)
- - [Comment](docs/Comment.md)
- - [Commit](docs/Commit.md)
- - [CommitDateOptions](docs/CommitDateOptions.md)
- - [CommitMeta](docs/CommitMeta.md)
- - [CommitUser](docs/CommitUser.md)
- - [ContentsResponse](docs/ContentsResponse.md)
- - [CreateEmailOption](docs/CreateEmailOption.md)
- - [CreateFileOptions](docs/CreateFileOptions.md)
- - [CreateForkOption](docs/CreateForkOption.md)
- - [CreateGpgKeyOption](docs/CreateGpgKeyOption.md)
- - [CreateHookOption](docs/CreateHookOption.md)
- - [CreateHookOptionConfig](docs/CreateHookOptionConfig.md)
- - [CreateIssueCommentOption](docs/CreateIssueCommentOption.md)
- - [CreateIssueOption](docs/CreateIssueOption.md)
- - [CreateKeyOption](docs/CreateKeyOption.md)
- - [CreateLabelOption](docs/CreateLabelOption.md)
- - [CreateMilestoneOption](docs/CreateMilestoneOption.md)
- - [CreateOrgOption](docs/CreateOrgOption.md)
- - [CreatePullRequestOption](docs/CreatePullRequestOption.md)
- - [CreateReleaseOption](docs/CreateReleaseOption.md)
- - [CreateRepoOption](docs/CreateRepoOption.md)
- - [CreateStatusOption](docs/CreateStatusOption.md)
- - [CreateTeamOption](docs/CreateTeamOption.md)
- - [CreateUserOption](docs/CreateUserOption.md)
- - [DeleteEmailOption](docs/DeleteEmailOption.md)
- - [DeleteFileOptions](docs/DeleteFileOptions.md)
- - [DeployKey](docs/DeployKey.md)
- - [EditAttachmentOptions](docs/EditAttachmentOptions.md)
- - [EditDeadlineOption](docs/EditDeadlineOption.md)
- - [EditGitHookOption](docs/EditGitHookOption.md)
- - [EditHookOption](docs/EditHookOption.md)
- - [EditIssueCommentOption](docs/EditIssueCommentOption.md)
- - [EditIssueOption](docs/EditIssueOption.md)
- - [EditLabelOption](docs/EditLabelOption.md)
- - [EditMilestoneOption](docs/EditMilestoneOption.md)
- - [EditOrgOption](docs/EditOrgOption.md)
- - [EditPullRequestOption](docs/EditPullRequestOption.md)
- - [EditReactionOption](docs/EditReactionOption.md)
- - [EditReleaseOption](docs/EditReleaseOption.md)
- - [EditRepoOption](docs/EditRepoOption.md)
- - [EditTeamOption](docs/EditTeamOption.md)
- - [EditUserOption](docs/EditUserOption.md)
- - [Email](docs/Email.md)
- - [ExternalTracker](docs/ExternalTracker.md)
- - [ExternalWiki](docs/ExternalWiki.md)
- - [FileCommitResponse](docs/FileCommitResponse.md)
- - [FileDeleteResponse](docs/FileDeleteResponse.md)
- - [FileLinksResponse](docs/FileLinksResponse.md)
- - [FileResponse](docs/FileResponse.md)
- - [GitBlobResponse](docs/GitBlobResponse.md)
- - [GitEntry](docs/GitEntry.md)
- - [GitHook](docs/GitHook.md)
- - [GitObject](docs/GitObject.md)
- - [GitTreeResponse](docs/GitTreeResponse.md)
- - [GpgKey](docs/GpgKey.md)
- - [GpgKeyEmail](docs/GpgKeyEmail.md)
- - [Hook](docs/Hook.md)
- - [Identity](docs/Identity.md)
- - [InlineResponse200](docs/InlineResponse200.md)
- - [InlineResponse2001](docs/InlineResponse2001.md)
- - [InternalTracker](docs/InternalTracker.md)
- - [Issue](docs/Issue.md)
- - [IssueDeadline](docs/IssueDeadline.md)
- - [IssueLabelsOption](docs/IssueLabelsOption.md)
- - [Label](docs/Label.md)
- - [MarkdownOption](docs/MarkdownOption.md)
- - [MergePullRequestOption](docs/MergePullRequestOption.md)
- - [MigrateRepoForm](docs/MigrateRepoForm.md)
- - [Milestone](docs/Milestone.md)
- - [Organization](docs/Organization.md)
- - [PayloadCommit](docs/PayloadCommit.md)
- - [PayloadCommitVerification](docs/PayloadCommitVerification.md)
- - [PayloadUser](docs/PayloadUser.md)
- - [Permission](docs/Permission.md)
- - [PrBranchInfo](docs/PrBranchInfo.md)
- - [PublicKey](docs/PublicKey.md)
- - [PullRequest](docs/PullRequest.md)
- - [PullRequestMeta](docs/PullRequestMeta.md)
- - [Reaction](docs/Reaction.md)
- - [Reference](docs/Reference.md)
- - [Release](docs/Release.md)
- - [RepoCommit](docs/RepoCommit.md)
- - [RepoTopicOptions](docs/RepoTopicOptions.md)
- - [Repository](docs/Repository.md)
- - [RepositoryMeta](docs/RepositoryMeta.md)
- - [SearchResults](docs/SearchResults.md)
- - [ServerVersion](docs/ServerVersion.md)
- - [StateType](docs/StateType.md)
- - [Status](docs/Status.md)
- - [StatusState](docs/StatusState.md)
- - [StopWatch](docs/StopWatch.md)
- - [Tag](docs/Tag.md)
- - [Team](docs/Team.md)
- - [TimeStamp](docs/TimeStamp.md)
- - [TopicName](docs/TopicName.md)
- - [TopicResponse](docs/TopicResponse.md)
- - [TrackedTime](docs/TrackedTime.md)
- - [UpdateFileOptions](docs/UpdateFileOptions.md)
- - [User](docs/User.md)
- - [UserHeatmapData](docs/UserHeatmapData.md)
- - [WatchInfo](docs/WatchInfo.md)
-
-
- ## Documentation For Authorization
-
- ## AccessToken
- - **Type**: API key
-
- Example
- ```
- auth := context.WithValue(context.TODO(), sw.ContextAPIKey, sw.APIKey{
- Key: "APIKEY",
- Prefix: "Bearer", // Omit if not necessary.
- })
- r, err := client.Service.Operation(auth, args)
- ```
- ## AuthorizationHeaderToken
- - **Type**: API key
-
- Example
- ```
- auth := context.WithValue(context.TODO(), sw.ContextAPIKey, sw.APIKey{
- Key: "APIKEY",
- Prefix: "Bearer", // Omit if not necessary.
- })
- r, err := client.Service.Operation(auth, args)
- ```
- ## BasicAuth
- - **Type**: HTTP basic authentication
-
- Example
- ```
- auth := context.WithValue(context.TODO(), sw.ContextBasicAuth, sw.BasicAuth{
- UserName: "username",
- Password: "password",
- })
- r, err := client.Service.Operation(auth, args)
- ```
- ## SudoHeader
- - **Type**: API key
-
- Example
- ```
- auth := context.WithValue(context.TODO(), sw.ContextAPIKey, sw.APIKey{
- Key: "APIKEY",
- Prefix: "Bearer", // Omit if not necessary.
- })
- r, err := client.Service.Operation(auth, args)
- ```
- ## SudoParam
- - **Type**: API key
-
- Example
- ```
- auth := context.WithValue(context.TODO(), sw.ContextAPIKey, sw.APIKey{
- Key: "APIKEY",
- Prefix: "Bearer", // Omit if not necessary.
- })
- r, err := client.Service.Operation(auth, args)
- ```
- ## Token
- - **Type**: API key
-
- Example
- ```
- auth := context.WithValue(context.TODO(), sw.ContextAPIKey, sw.APIKey{
- Key: "APIKEY",
- Prefix: "Bearer", // Omit if not necessary.
- })
- r, err := client.Service.Operation(auth, args)
- ```
-
- ## Author
-
-
-
|