436 lines
40 KiB
Markdown
436 lines
40 KiB
Markdown
# Go API client for gitea
|
|
|
|
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.GoClientCodegen
|
|
|
|
## Installation
|
|
Put the package under your project folder and add the following in import:
|
|
```golang
|
|
import "./gitea"
|
|
```
|
|
|
|
## Documentation for API Endpoints
|
|
|
|
All URIs are relative to *http://localhost/api/v1*
|
|
|
|
Class | Method | HTTP request | Description
|
|
------------ | ------------- | ------------- | -------------
|
|
*AdminApi* | [**AdminCreateOrg**](docs/AdminApi.md#admincreateorg) | **Post** /admin/users/{username}/orgs | Create an organization
|
|
*AdminApi* | [**AdminCreatePublicKey**](docs/AdminApi.md#admincreatepublickey) | **Post** /admin/users/{username}/keys | Add a public key on behalf of a user
|
|
*AdminApi* | [**AdminCreateRepo**](docs/AdminApi.md#admincreaterepo) | **Post** /admin/users/{username}/repos | Create a repository on behalf of a user
|
|
*AdminApi* | [**AdminCreateUser**](docs/AdminApi.md#admincreateuser) | **Post** /admin/users | Create a user
|
|
*AdminApi* | [**AdminDeleteUser**](docs/AdminApi.md#admindeleteuser) | **Delete** /admin/users/{username} | Delete a user
|
|
*AdminApi* | [**AdminDeleteUserPublicKey**](docs/AdminApi.md#admindeleteuserpublickey) | **Delete** /admin/users/{username}/keys/{id} | Delete a user's public key
|
|
*AdminApi* | [**AdminEditUser**](docs/AdminApi.md#adminedituser) | **Patch** /admin/users/{username} | Edit an existing user
|
|
*AdminApi* | [**AdminGetAllOrgs**](docs/AdminApi.md#admingetallorgs) | **Get** /admin/orgs | List all organizations
|
|
*AdminApi* | [**AdminGetAllUsers**](docs/AdminApi.md#admingetallusers) | **Get** /admin/users | List all users
|
|
*IssueApi* | [**IssueAddLabel**](docs/IssueApi.md#issueaddlabel) | **Post** /repos/{owner}/{repo}/issues/{index}/labels | Add a label to an issue
|
|
*IssueApi* | [**IssueAddSubscription**](docs/IssueApi.md#issueaddsubscription) | **Put** /repos/{owner}/{repo}/issues/{index}/subscriptions/{user} | Subscribe user to issue
|
|
*IssueApi* | [**IssueAddTime**](docs/IssueApi.md#issueaddtime) | **Post** /repos/{owner}/{repo}/issues/{index}/times | Add tracked time to a issue
|
|
*IssueApi* | [**IssueClearLabels**](docs/IssueApi.md#issueclearlabels) | **Delete** /repos/{owner}/{repo}/issues/{index}/labels | Remove all labels from an issue
|
|
*IssueApi* | [**IssueCreateComment**](docs/IssueApi.md#issuecreatecomment) | **Post** /repos/{owner}/{repo}/issues/{index}/comments | Add a comment to an issue
|
|
*IssueApi* | [**IssueCreateIssue**](docs/IssueApi.md#issuecreateissue) | **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* | [**IssueCreateLabel**](docs/IssueApi.md#issuecreatelabel) | **Post** /repos/{owner}/{repo}/labels | Create a label
|
|
*IssueApi* | [**IssueCreateMilestone**](docs/IssueApi.md#issuecreatemilestone) | **Post** /repos/{owner}/{repo}/milestones | Create a milestone
|
|
*IssueApi* | [**IssueDeleteComment**](docs/IssueApi.md#issuedeletecomment) | **Delete** /repos/{owner}/{repo}/issues/comments/{id} | Delete a comment
|
|
*IssueApi* | [**IssueDeleteCommentDeprecated**](docs/IssueApi.md#issuedeletecommentdeprecated) | **Delete** /repos/{owner}/{repo}/issues/{index}/comments/{id} | Delete a comment
|
|
*IssueApi* | [**IssueDeleteCommentReaction**](docs/IssueApi.md#issuedeletecommentreaction) | **Delete** /repos/{owner}/{repo}/issues/comments/{id}/reactions | Remove a reaction from a comment of an issue
|
|
*IssueApi* | [**IssueDeleteIssueReaction**](docs/IssueApi.md#issuedeleteissuereaction) | **Delete** /repos/{owner}/{repo}/issues/{index}/reactions | Remove a reaction from an issue
|
|
*IssueApi* | [**IssueDeleteLabel**](docs/IssueApi.md#issuedeletelabel) | **Delete** /repos/{owner}/{repo}/labels/{id} | Delete a label
|
|
*IssueApi* | [**IssueDeleteMilestone**](docs/IssueApi.md#issuedeletemilestone) | **Delete** /repos/{owner}/{repo}/milestones/{id} | Delete a milestone
|
|
*IssueApi* | [**IssueDeleteStopWatch**](docs/IssueApi.md#issuedeletestopwatch) | **Delete** /repos/{owner}/{repo}/issues/{index}/stopwatch/delete | Delete an issue's existing stopwatch.
|
|
*IssueApi* | [**IssueDeleteSubscription**](docs/IssueApi.md#issuedeletesubscription) | **Delete** /repos/{owner}/{repo}/issues/{index}/subscriptions/{user} | Unsubscribe user from issue
|
|
*IssueApi* | [**IssueDeleteTime**](docs/IssueApi.md#issuedeletetime) | **Delete** /repos/{owner}/{repo}/issues/{index}/times/{id} | Delete specific tracked time
|
|
*IssueApi* | [**IssueEditComment**](docs/IssueApi.md#issueeditcomment) | **Patch** /repos/{owner}/{repo}/issues/comments/{id} | Edit a comment
|
|
*IssueApi* | [**IssueEditCommentDeprecated**](docs/IssueApi.md#issueeditcommentdeprecated) | **Patch** /repos/{owner}/{repo}/issues/{index}/comments/{id} | Edit a comment
|
|
*IssueApi* | [**IssueEditIssue**](docs/IssueApi.md#issueeditissue) | **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* | [**IssueEditIssueDeadline**](docs/IssueApi.md#issueeditissuedeadline) | **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* | [**IssueEditLabel**](docs/IssueApi.md#issueeditlabel) | **Patch** /repos/{owner}/{repo}/labels/{id} | Update a label
|
|
*IssueApi* | [**IssueEditMilestone**](docs/IssueApi.md#issueeditmilestone) | **Patch** /repos/{owner}/{repo}/milestones/{id} | Update a milestone
|
|
*IssueApi* | [**IssueGetComment**](docs/IssueApi.md#issuegetcomment) | **Get** /repos/{owner}/{repo}/issues/comments/{id} | Get a comment
|
|
*IssueApi* | [**IssueGetCommentReactions**](docs/IssueApi.md#issuegetcommentreactions) | **Get** /repos/{owner}/{repo}/issues/comments/{id}/reactions | Get a list of reactions from a comment of an issue
|
|
*IssueApi* | [**IssueGetComments**](docs/IssueApi.md#issuegetcomments) | **Get** /repos/{owner}/{repo}/issues/{index}/comments | List all comments on an issue
|
|
*IssueApi* | [**IssueGetIssue**](docs/IssueApi.md#issuegetissue) | **Get** /repos/{owner}/{repo}/issues/{index} | Get an issue
|
|
*IssueApi* | [**IssueGetIssueReactions**](docs/IssueApi.md#issuegetissuereactions) | **Get** /repos/{owner}/{repo}/issues/{index}/reactions | Get a list reactions of an issue
|
|
*IssueApi* | [**IssueGetLabel**](docs/IssueApi.md#issuegetlabel) | **Get** /repos/{owner}/{repo}/labels/{id} | Get a single label
|
|
*IssueApi* | [**IssueGetLabels**](docs/IssueApi.md#issuegetlabels) | **Get** /repos/{owner}/{repo}/issues/{index}/labels | Get an issue's labels
|
|
*IssueApi* | [**IssueGetMilestone**](docs/IssueApi.md#issuegetmilestone) | **Get** /repos/{owner}/{repo}/milestones/{id} | Get a milestone
|
|
*IssueApi* | [**IssueGetMilestonesList**](docs/IssueApi.md#issuegetmilestoneslist) | **Get** /repos/{owner}/{repo}/milestones | Get all of a repository's opened milestones
|
|
*IssueApi* | [**IssueGetRepoComments**](docs/IssueApi.md#issuegetrepocomments) | **Get** /repos/{owner}/{repo}/issues/comments | List all comments in a repository
|
|
*IssueApi* | [**IssueListIssues**](docs/IssueApi.md#issuelistissues) | **Get** /repos/{owner}/{repo}/issues | List a repository's issues
|
|
*IssueApi* | [**IssueListLabels**](docs/IssueApi.md#issuelistlabels) | **Get** /repos/{owner}/{repo}/labels | Get all of a repository's labels
|
|
*IssueApi* | [**IssuePostCommentReaction**](docs/IssueApi.md#issuepostcommentreaction) | **Post** /repos/{owner}/{repo}/issues/comments/{id}/reactions | Add a reaction to a comment of an issue
|
|
*IssueApi* | [**IssuePostIssueReaction**](docs/IssueApi.md#issuepostissuereaction) | **Post** /repos/{owner}/{repo}/issues/{index}/reactions | Add a reaction to an issue
|
|
*IssueApi* | [**IssueRemoveLabel**](docs/IssueApi.md#issueremovelabel) | **Delete** /repos/{owner}/{repo}/issues/{index}/labels/{id} | Remove a label from an issue
|
|
*IssueApi* | [**IssueReplaceLabels**](docs/IssueApi.md#issuereplacelabels) | **Put** /repos/{owner}/{repo}/issues/{index}/labels | Replace an issue's labels
|
|
*IssueApi* | [**IssueResetTime**](docs/IssueApi.md#issueresettime) | **Delete** /repos/{owner}/{repo}/issues/{index}/times | Reset a tracked time of an issue
|
|
*IssueApi* | [**IssueSearchIssues**](docs/IssueApi.md#issuesearchissues) | **Get** /repos/issues/search | Search for issues across the repositories that the user has access to
|
|
*IssueApi* | [**IssueStartStopWatch**](docs/IssueApi.md#issuestartstopwatch) | **Post** /repos/{owner}/{repo}/issues/{index}/stopwatch/start | Start stopwatch on an issue.
|
|
*IssueApi* | [**IssueStopStopWatch**](docs/IssueApi.md#issuestopstopwatch) | **Post** /repos/{owner}/{repo}/issues/{index}/stopwatch/stop | Stop an issue's existing stopwatch.
|
|
*IssueApi* | [**IssueSubscriptions**](docs/IssueApi.md#issuesubscriptions) | **Get** /repos/{owner}/{repo}/issues/{index}/subscriptions | Get users who subscribed on an issue.
|
|
*IssueApi* | [**IssueTrackedTimes**](docs/IssueApi.md#issuetrackedtimes) | **Get** /repos/{owner}/{repo}/issues/{index}/times | List an issue's tracked times
|
|
*MiscellaneousApi* | [**GetSigningKey**](docs/MiscellaneousApi.md#getsigningkey) | **Get** /signing-key.gpg | Get default signing-key.gpg
|
|
*MiscellaneousApi* | [**GetVersion**](docs/MiscellaneousApi.md#getversion) | **Get** /version | Returns the version of the Gitea application
|
|
*MiscellaneousApi* | [**RenderMarkdown**](docs/MiscellaneousApi.md#rendermarkdown) | **Post** /markdown | Render a markdown document as HTML
|
|
*MiscellaneousApi* | [**RenderMarkdownRaw**](docs/MiscellaneousApi.md#rendermarkdownraw) | **Post** /markdown/raw | Render raw markdown as HTML
|
|
*NotificationApi* | [**NotifyGetList**](docs/NotificationApi.md#notifygetlist) | **Get** /notifications | List users's notification threads
|
|
*NotificationApi* | [**NotifyGetRepoList**](docs/NotificationApi.md#notifygetrepolist) | **Get** /repos/{owner}/{repo}/notifications | List users's notification threads on a specific repo
|
|
*NotificationApi* | [**NotifyGetThread**](docs/NotificationApi.md#notifygetthread) | **Get** /notifications/threads/{id} | Get notification thread by ID
|
|
*NotificationApi* | [**NotifyNewAvailable**](docs/NotificationApi.md#notifynewavailable) | **Get** /notifications/new | Check if unread notifications exist
|
|
*NotificationApi* | [**NotifyReadList**](docs/NotificationApi.md#notifyreadlist) | **Put** /notifications | Mark notification threads as read
|
|
*NotificationApi* | [**NotifyReadRepoList**](docs/NotificationApi.md#notifyreadrepolist) | **Put** /repos/{owner}/{repo}/notifications | Mark notification threads as read on a specific repo
|
|
*NotificationApi* | [**NotifyReadThread**](docs/NotificationApi.md#notifyreadthread) | **Patch** /notifications/threads/{id} | Mark notification thread as read by ID
|
|
*OrganizationApi* | [**CreateOrgRepo**](docs/OrganizationApi.md#createorgrepo) | **Post** /orgs/{org}/repos | Create a repository in an organization
|
|
*OrganizationApi* | [**CreateOrgRepoDeprecated**](docs/OrganizationApi.md#createorgrepodeprecated) | **Post** /org/{org}/repos | Create a repository in an organization
|
|
*OrganizationApi* | [**OrgAddTeamMember**](docs/OrganizationApi.md#orgaddteammember) | **Put** /teams/{id}/members/{username} | Add a team member
|
|
*OrganizationApi* | [**OrgAddTeamRepository**](docs/OrganizationApi.md#orgaddteamrepository) | **Put** /teams/{id}/repos/{org}/{repo} | Add a repository to a team
|
|
*OrganizationApi* | [**OrgConcealMember**](docs/OrganizationApi.md#orgconcealmember) | **Delete** /orgs/{org}/public_members/{username} | Conceal a user's membership
|
|
*OrganizationApi* | [**OrgCreate**](docs/OrganizationApi.md#orgcreate) | **Post** /orgs | Create an organization
|
|
*OrganizationApi* | [**OrgCreateHook**](docs/OrganizationApi.md#orgcreatehook) | **Post** /orgs/{org}/hooks/ | Create a hook
|
|
*OrganizationApi* | [**OrgCreateTeam**](docs/OrganizationApi.md#orgcreateteam) | **Post** /orgs/{org}/teams | Create a team
|
|
*OrganizationApi* | [**OrgDelete**](docs/OrganizationApi.md#orgdelete) | **Delete** /orgs/{org} | Delete an organization
|
|
*OrganizationApi* | [**OrgDeleteHook**](docs/OrganizationApi.md#orgdeletehook) | **Delete** /orgs/{org}/hooks/{id} | Delete a hook
|
|
*OrganizationApi* | [**OrgDeleteMember**](docs/OrganizationApi.md#orgdeletemember) | **Delete** /orgs/{org}/members/{username} | Remove a member from an organization
|
|
*OrganizationApi* | [**OrgDeleteTeam**](docs/OrganizationApi.md#orgdeleteteam) | **Delete** /teams/{id} | Delete a team
|
|
*OrganizationApi* | [**OrgEdit**](docs/OrganizationApi.md#orgedit) | **Patch** /orgs/{org} | Edit an organization
|
|
*OrganizationApi* | [**OrgEditHook**](docs/OrganizationApi.md#orgedithook) | **Patch** /orgs/{org}/hooks/{id} | Update a hook
|
|
*OrganizationApi* | [**OrgEditTeam**](docs/OrganizationApi.md#orgeditteam) | **Patch** /teams/{id} | Edit a team
|
|
*OrganizationApi* | [**OrgGet**](docs/OrganizationApi.md#orgget) | **Get** /orgs/{org} | Get an organization
|
|
*OrganizationApi* | [**OrgGetAll**](docs/OrganizationApi.md#orggetall) | **Get** /orgs | Get list of organizations
|
|
*OrganizationApi* | [**OrgGetHook**](docs/OrganizationApi.md#orggethook) | **Get** /orgs/{org}/hooks/{id} | Get a hook
|
|
*OrganizationApi* | [**OrgGetTeam**](docs/OrganizationApi.md#orggetteam) | **Get** /teams/{id} | Get a team
|
|
*OrganizationApi* | [**OrgIsMember**](docs/OrganizationApi.md#orgismember) | **Get** /orgs/{org}/members/{username} | Check if a user is a member of an organization
|
|
*OrganizationApi* | [**OrgIsPublicMember**](docs/OrganizationApi.md#orgispublicmember) | **Get** /orgs/{org}/public_members/{username} | Check if a user is a public member of an organization
|
|
*OrganizationApi* | [**OrgListCurrentUserOrgs**](docs/OrganizationApi.md#orglistcurrentuserorgs) | **Get** /user/orgs | List the current user's organizations
|
|
*OrganizationApi* | [**OrgListHooks**](docs/OrganizationApi.md#orglisthooks) | **Get** /orgs/{org}/hooks | List an organization's webhooks
|
|
*OrganizationApi* | [**OrgListMembers**](docs/OrganizationApi.md#orglistmembers) | **Get** /orgs/{org}/members | List an organization's members
|
|
*OrganizationApi* | [**OrgListPublicMembers**](docs/OrganizationApi.md#orglistpublicmembers) | **Get** /orgs/{org}/public_members | List an organization's public members
|
|
*OrganizationApi* | [**OrgListRepos**](docs/OrganizationApi.md#orglistrepos) | **Get** /orgs/{org}/repos | List an organization's repos
|
|
*OrganizationApi* | [**OrgListTeamMember**](docs/OrganizationApi.md#orglistteammember) | **Get** /teams/{id}/members/{username} | List a particular member of team
|
|
*OrganizationApi* | [**OrgListTeamMembers**](docs/OrganizationApi.md#orglistteammembers) | **Get** /teams/{id}/members | List a team's members
|
|
*OrganizationApi* | [**OrgListTeamRepos**](docs/OrganizationApi.md#orglistteamrepos) | **Get** /teams/{id}/repos | List a team's repos
|
|
*OrganizationApi* | [**OrgListTeams**](docs/OrganizationApi.md#orglistteams) | **Get** /orgs/{org}/teams | List an organization's teams
|
|
*OrganizationApi* | [**OrgListUserOrgs**](docs/OrganizationApi.md#orglistuserorgs) | **Get** /users/{username}/orgs | List a user's organizations
|
|
*OrganizationApi* | [**OrgPublicizeMember**](docs/OrganizationApi.md#orgpublicizemember) | **Put** /orgs/{org}/public_members/{username} | Publicize a user's membership
|
|
*OrganizationApi* | [**OrgRemoveTeamMember**](docs/OrganizationApi.md#orgremoveteammember) | **Delete** /teams/{id}/members/{username} | Remove a team member
|
|
*OrganizationApi* | [**OrgRemoveTeamRepository**](docs/OrganizationApi.md#orgremoveteamrepository) | **Delete** /teams/{id}/repos/{org}/{repo} | Remove a repository from a team
|
|
*OrganizationApi* | [**TeamSearch**](docs/OrganizationApi.md#teamsearch) | **Get** /orgs/{org}/teams/search | Search for teams within an organization
|
|
*RepositoryApi* | [**CreateCurrentUserRepo**](docs/RepositoryApi.md#createcurrentuserrepo) | **Post** /user/repos | Create a repository
|
|
*RepositoryApi* | [**CreateFork**](docs/RepositoryApi.md#createfork) | **Post** /repos/{owner}/{repo}/forks | Fork a repository
|
|
*RepositoryApi* | [**GetBlob**](docs/RepositoryApi.md#getblob) | **Get** /repos/{owner}/{repo}/git/blobs/{sha} | Gets the blob of a repository.
|
|
*RepositoryApi* | [**GetTag**](docs/RepositoryApi.md#gettag) | **Get** /repos/{owner}/{repo}/git/tags/{sha} | Gets the tag object of an annotated tag (not lightweight tags)
|
|
*RepositoryApi* | [**GetTree**](docs/RepositoryApi.md#gettree) | **Get** /repos/{owner}/{repo}/git/trees/{sha} | Gets the tree of a repository.
|
|
*RepositoryApi* | [**ListForks**](docs/RepositoryApi.md#listforks) | **Get** /repos/{owner}/{repo}/forks | List a repository's forks
|
|
*RepositoryApi* | [**RepoAddCollaborator**](docs/RepositoryApi.md#repoaddcollaborator) | **Put** /repos/{owner}/{repo}/collaborators/{collaborator} | Add a collaborator to a repository
|
|
*RepositoryApi* | [**RepoAddTopc**](docs/RepositoryApi.md#repoaddtopc) | **Put** /repos/{owner}/{repo}/topics/{topic} | Add a topic to a repository
|
|
*RepositoryApi* | [**RepoCheckCollaborator**](docs/RepositoryApi.md#repocheckcollaborator) | **Get** /repos/{owner}/{repo}/collaborators/{collaborator} | Check if a user is a collaborator of a repository
|
|
*RepositoryApi* | [**RepoCreateFile**](docs/RepositoryApi.md#repocreatefile) | **Post** /repos/{owner}/{repo}/contents/{filepath} | Create a file in a repository
|
|
*RepositoryApi* | [**RepoCreateHook**](docs/RepositoryApi.md#repocreatehook) | **Post** /repos/{owner}/{repo}/hooks | Create a hook
|
|
*RepositoryApi* | [**RepoCreateKey**](docs/RepositoryApi.md#repocreatekey) | **Post** /repos/{owner}/{repo}/keys | Add a key to a repository
|
|
*RepositoryApi* | [**RepoCreatePullRequest**](docs/RepositoryApi.md#repocreatepullrequest) | **Post** /repos/{owner}/{repo}/pulls | Create a pull request
|
|
*RepositoryApi* | [**RepoCreateRelease**](docs/RepositoryApi.md#repocreaterelease) | **Post** /repos/{owner}/{repo}/releases | Create a release
|
|
*RepositoryApi* | [**RepoCreateReleaseAttachment**](docs/RepositoryApi.md#repocreatereleaseattachment) | **Post** /repos/{owner}/{repo}/releases/{id}/assets | Create a release attachment
|
|
*RepositoryApi* | [**RepoCreateStatus**](docs/RepositoryApi.md#repocreatestatus) | **Post** /repos/{owner}/{repo}/statuses/{sha} | Create a commit status
|
|
*RepositoryApi* | [**RepoDelete**](docs/RepositoryApi.md#repodelete) | **Delete** /repos/{owner}/{repo} | Delete a repository
|
|
*RepositoryApi* | [**RepoDeleteCollaborator**](docs/RepositoryApi.md#repodeletecollaborator) | **Delete** /repos/{owner}/{repo}/collaborators/{collaborator} | Delete a collaborator from a repository
|
|
*RepositoryApi* | [**RepoDeleteFile**](docs/RepositoryApi.md#repodeletefile) | **Delete** /repos/{owner}/{repo}/contents/{filepath} | Delete a file in a repository
|
|
*RepositoryApi* | [**RepoDeleteGitHook**](docs/RepositoryApi.md#repodeletegithook) | **Delete** /repos/{owner}/{repo}/hooks/git/{id} | Delete a Git hook in a repository
|
|
*RepositoryApi* | [**RepoDeleteHook**](docs/RepositoryApi.md#repodeletehook) | **Delete** /repos/{owner}/{repo}/hooks/{id} | Delete a hook in a repository
|
|
*RepositoryApi* | [**RepoDeleteKey**](docs/RepositoryApi.md#repodeletekey) | **Delete** /repos/{owner}/{repo}/keys/{id} | Delete a key from a repository
|
|
*RepositoryApi* | [**RepoDeleteRelease**](docs/RepositoryApi.md#repodeleterelease) | **Delete** /repos/{owner}/{repo}/releases/{id} | Delete a release
|
|
*RepositoryApi* | [**RepoDeleteReleaseAttachment**](docs/RepositoryApi.md#repodeletereleaseattachment) | **Delete** /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id} | Delete a release attachment
|
|
*RepositoryApi* | [**RepoDeleteTopic**](docs/RepositoryApi.md#repodeletetopic) | **Delete** /repos/{owner}/{repo}/topics/{topic} | Delete a topic from a repository
|
|
*RepositoryApi* | [**RepoEdit**](docs/RepositoryApi.md#repoedit) | **Patch** /repos/{owner}/{repo} | Edit a repository's properties. Only fields that are set will be changed.
|
|
*RepositoryApi* | [**RepoEditGitHook**](docs/RepositoryApi.md#repoeditgithook) | **Patch** /repos/{owner}/{repo}/hooks/git/{id} | Edit a Git hook in a repository
|
|
*RepositoryApi* | [**RepoEditHook**](docs/RepositoryApi.md#repoedithook) | **Patch** /repos/{owner}/{repo}/hooks/{id} | Edit a hook in a repository
|
|
*RepositoryApi* | [**RepoEditPullRequest**](docs/RepositoryApi.md#repoeditpullrequest) | **Patch** /repos/{owner}/{repo}/pulls/{index} | Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.
|
|
*RepositoryApi* | [**RepoEditRelease**](docs/RepositoryApi.md#repoeditrelease) | **Patch** /repos/{owner}/{repo}/releases/{id} | Update a release
|
|
*RepositoryApi* | [**RepoEditReleaseAttachment**](docs/RepositoryApi.md#repoeditreleaseattachment) | **Patch** /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id} | Edit a release attachment
|
|
*RepositoryApi* | [**RepoGet**](docs/RepositoryApi.md#repoget) | **Get** /repos/{owner}/{repo} | Get a repository
|
|
*RepositoryApi* | [**RepoGetAllCommits**](docs/RepositoryApi.md#repogetallcommits) | **Get** /repos/{owner}/{repo}/commits | Get a list of all commits from a repository
|
|
*RepositoryApi* | [**RepoGetArchive**](docs/RepositoryApi.md#repogetarchive) | **Get** /repos/{owner}/{repo}/archive/{archive} | Get an archive of a repository
|
|
*RepositoryApi* | [**RepoGetBranch**](docs/RepositoryApi.md#repogetbranch) | **Get** /repos/{owner}/{repo}/branches/{branch} | Retrieve a specific branch from a repository, including its effective branch protection
|
|
*RepositoryApi* | [**RepoGetByID**](docs/RepositoryApi.md#repogetbyid) | **Get** /repositories/{id} | Get a repository by id
|
|
*RepositoryApi* | [**RepoGetCombinedStatusByRef**](docs/RepositoryApi.md#repogetcombinedstatusbyref) | **Get** /repos/{owner}/{repo}/commits/{ref}/statuses | Get a commit's combined status, by branch/tag/commit reference
|
|
*RepositoryApi* | [**RepoGetContents**](docs/RepositoryApi.md#repogetcontents) | **Get** /repos/{owner}/{repo}/contents/{filepath} | Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir
|
|
*RepositoryApi* | [**RepoGetContentsList**](docs/RepositoryApi.md#repogetcontentslist) | **Get** /repos/{owner}/{repo}/contents | Gets the metadata of all the entries of the root dir
|
|
*RepositoryApi* | [**RepoGetEditorConfig**](docs/RepositoryApi.md#repogeteditorconfig) | **Get** /repos/{owner}/{repo}/editorconfig/{filepath} | Get the EditorConfig definitions of a file in a repository
|
|
*RepositoryApi* | [**RepoGetGitHook**](docs/RepositoryApi.md#repogetgithook) | **Get** /repos/{owner}/{repo}/hooks/git/{id} | Get a Git hook
|
|
*RepositoryApi* | [**RepoGetHook**](docs/RepositoryApi.md#repogethook) | **Get** /repos/{owner}/{repo}/hooks/{id} | Get a hook
|
|
*RepositoryApi* | [**RepoGetKey**](docs/RepositoryApi.md#repogetkey) | **Get** /repos/{owner}/{repo}/keys/{id} | Get a repository's key by id
|
|
*RepositoryApi* | [**RepoGetPullRequest**](docs/RepositoryApi.md#repogetpullrequest) | **Get** /repos/{owner}/{repo}/pulls/{index} | Get a pull request
|
|
*RepositoryApi* | [**RepoGetRawFile**](docs/RepositoryApi.md#repogetrawfile) | **Get** /repos/{owner}/{repo}/raw/{filepath} | Get a file from a repository
|
|
*RepositoryApi* | [**RepoGetRelease**](docs/RepositoryApi.md#repogetrelease) | **Get** /repos/{owner}/{repo}/releases/{id} | Get a release
|
|
*RepositoryApi* | [**RepoGetReleaseAttachment**](docs/RepositoryApi.md#repogetreleaseattachment) | **Get** /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id} | Get a release attachment
|
|
*RepositoryApi* | [**RepoGetSingleCommit**](docs/RepositoryApi.md#repogetsinglecommit) | **Get** /repos/{owner}/{repo}/git/commits/{sha} | Get a single commit from a repository
|
|
*RepositoryApi* | [**RepoListAllGitRefs**](docs/RepositoryApi.md#repolistallgitrefs) | **Get** /repos/{owner}/{repo}/git/refs | Get specified ref or filtered repository's refs
|
|
*RepositoryApi* | [**RepoListBranches**](docs/RepositoryApi.md#repolistbranches) | **Get** /repos/{owner}/{repo}/branches | List a repository's branches
|
|
*RepositoryApi* | [**RepoListCollaborators**](docs/RepositoryApi.md#repolistcollaborators) | **Get** /repos/{owner}/{repo}/collaborators | List a repository's collaborators
|
|
*RepositoryApi* | [**RepoListGitHooks**](docs/RepositoryApi.md#repolistgithooks) | **Get** /repos/{owner}/{repo}/hooks/git | List the Git hooks in a repository
|
|
*RepositoryApi* | [**RepoListGitRefs**](docs/RepositoryApi.md#repolistgitrefs) | **Get** /repos/{owner}/{repo}/git/refs/{ref} | Get specified ref or filtered repository's refs
|
|
*RepositoryApi* | [**RepoListHooks**](docs/RepositoryApi.md#repolisthooks) | **Get** /repos/{owner}/{repo}/hooks | List the hooks in a repository
|
|
*RepositoryApi* | [**RepoListKeys**](docs/RepositoryApi.md#repolistkeys) | **Get** /repos/{owner}/{repo}/keys | List a repository's keys
|
|
*RepositoryApi* | [**RepoListPullRequests**](docs/RepositoryApi.md#repolistpullrequests) | **Get** /repos/{owner}/{repo}/pulls | List a repo's pull requests
|
|
*RepositoryApi* | [**RepoListReleaseAttachments**](docs/RepositoryApi.md#repolistreleaseattachments) | **Get** /repos/{owner}/{repo}/releases/{id}/assets | List release's attachments
|
|
*RepositoryApi* | [**RepoListReleases**](docs/RepositoryApi.md#repolistreleases) | **Get** /repos/{owner}/{repo}/releases | List a repo's releases
|
|
*RepositoryApi* | [**RepoListStargazers**](docs/RepositoryApi.md#repoliststargazers) | **Get** /repos/{owner}/{repo}/stargazers | List a repo's stargazers
|
|
*RepositoryApi* | [**RepoListStatuses**](docs/RepositoryApi.md#repoliststatuses) | **Get** /repos/{owner}/{repo}/statuses/{sha} | Get a commit's statuses
|
|
*RepositoryApi* | [**RepoListSubscribers**](docs/RepositoryApi.md#repolistsubscribers) | **Get** /repos/{owner}/{repo}/subscribers | List a repo's watchers
|
|
*RepositoryApi* | [**RepoListTags**](docs/RepositoryApi.md#repolisttags) | **Get** /repos/{owner}/{repo}/tags | List a repository's tags
|
|
*RepositoryApi* | [**RepoListTopics**](docs/RepositoryApi.md#repolisttopics) | **Get** /repos/{owner}/{repo}/topics | Get list of topics that a repository has
|
|
*RepositoryApi* | [**RepoMergePullRequest**](docs/RepositoryApi.md#repomergepullrequest) | **Post** /repos/{owner}/{repo}/pulls/{index}/merge | Merge a pull request
|
|
*RepositoryApi* | [**RepoMigrate**](docs/RepositoryApi.md#repomigrate) | **Post** /repos/migrate | Migrate a remote git repository
|
|
*RepositoryApi* | [**RepoMirrorSync**](docs/RepositoryApi.md#repomirrorsync) | **Post** /repos/{owner}/{repo}/mirror-sync | Sync a mirrored repository
|
|
*RepositoryApi* | [**RepoPullRequestIsMerged**](docs/RepositoryApi.md#repopullrequestismerged) | **Get** /repos/{owner}/{repo}/pulls/{index}/merge | Check if a pull request has been merged
|
|
*RepositoryApi* | [**RepoSearch**](docs/RepositoryApi.md#reposearch) | **Get** /repos/search | Search for repositories
|
|
*RepositoryApi* | [**RepoSigningKey**](docs/RepositoryApi.md#reposigningkey) | **Get** /repos/{owner}/{repo}/signing-key.gpg | Get signing-key.gpg for given repository
|
|
*RepositoryApi* | [**RepoTestHook**](docs/RepositoryApi.md#repotesthook) | **Post** /repos/{owner}/{repo}/hooks/{id}/tests | Test a push webhook
|
|
*RepositoryApi* | [**RepoTrackedTimes**](docs/RepositoryApi.md#repotrackedtimes) | **Get** /repos/{owner}/{repo}/times | List a repo's tracked times
|
|
*RepositoryApi* | [**RepoTransfer**](docs/RepositoryApi.md#repotransfer) | **Post** /repos/{owner}/{repo}/transfer | Transfer a repo ownership
|
|
*RepositoryApi* | [**RepoUpdateFile**](docs/RepositoryApi.md#repoupdatefile) | **Put** /repos/{owner}/{repo}/contents/{filepath} | Update a file in a repository
|
|
*RepositoryApi* | [**RepoUpdateTopics**](docs/RepositoryApi.md#repoupdatetopics) | **Put** /repos/{owner}/{repo}/topics | Replace list of topics for a repository
|
|
*RepositoryApi* | [**TopicSearch**](docs/RepositoryApi.md#topicsearch) | **Get** /topics/search | search topics via keyword
|
|
*RepositoryApi* | [**UserCurrentCheckSubscription**](docs/RepositoryApi.md#usercurrentchecksubscription) | **Get** /repos/{owner}/{repo}/subscription | Check if the current user is watching a repo
|
|
*RepositoryApi* | [**UserCurrentDeleteSubscription**](docs/RepositoryApi.md#usercurrentdeletesubscription) | **Delete** /repos/{owner}/{repo}/subscription | Unwatch a repo
|
|
*RepositoryApi* | [**UserCurrentPutSubscription**](docs/RepositoryApi.md#usercurrentputsubscription) | **Put** /repos/{owner}/{repo}/subscription | Watch a repo
|
|
*RepositoryApi* | [**UserTrackedTimes**](docs/RepositoryApi.md#usertrackedtimes) | **Get** /repos/{owner}/{repo}/times/{user} | List a user's tracked times in a repo
|
|
*UserApi* | [**CreateCurrentUserRepo**](docs/UserApi.md#createcurrentuserrepo) | **Post** /user/repos | Create a repository
|
|
*UserApi* | [**UserAddEmail**](docs/UserApi.md#useraddemail) | **Post** /user/emails | Add email addresses
|
|
*UserApi* | [**UserCheckFollowing**](docs/UserApi.md#usercheckfollowing) | **Get** /users/{follower}/following/{followee} | Check if one user is following another user
|
|
*UserApi* | [**UserCreateToken**](docs/UserApi.md#usercreatetoken) | **Post** /users/{username}/tokens | Create an access token
|
|
*UserApi* | [**UserCurrentCheckFollowing**](docs/UserApi.md#usercurrentcheckfollowing) | **Get** /user/following/{username} | Check whether a user is followed by the authenticated user
|
|
*UserApi* | [**UserCurrentCheckStarring**](docs/UserApi.md#usercurrentcheckstarring) | **Get** /user/starred/{owner}/{repo} | Whether the authenticated is starring the repo
|
|
*UserApi* | [**UserCurrentDeleteFollow**](docs/UserApi.md#usercurrentdeletefollow) | **Delete** /user/following/{username} | Unfollow a user
|
|
*UserApi* | [**UserCurrentDeleteGPGKey**](docs/UserApi.md#usercurrentdeletegpgkey) | **Delete** /user/gpg_keys/{id} | Remove a GPG key
|
|
*UserApi* | [**UserCurrentDeleteKey**](docs/UserApi.md#usercurrentdeletekey) | **Delete** /user/keys/{id} | Delete a public key
|
|
*UserApi* | [**UserCurrentDeleteStar**](docs/UserApi.md#usercurrentdeletestar) | **Delete** /user/starred/{owner}/{repo} | Unstar the given repo
|
|
*UserApi* | [**UserCurrentGetGPGKey**](docs/UserApi.md#usercurrentgetgpgkey) | **Get** /user/gpg_keys/{id} | Get a GPG key
|
|
*UserApi* | [**UserCurrentGetKey**](docs/UserApi.md#usercurrentgetkey) | **Get** /user/keys/{id} | Get a public key
|
|
*UserApi* | [**UserCurrentListFollowers**](docs/UserApi.md#usercurrentlistfollowers) | **Get** /user/followers | List the authenticated user's followers
|
|
*UserApi* | [**UserCurrentListFollowing**](docs/UserApi.md#usercurrentlistfollowing) | **Get** /user/following | List the users that the authenticated user is following
|
|
*UserApi* | [**UserCurrentListGPGKeys**](docs/UserApi.md#usercurrentlistgpgkeys) | **Get** /user/gpg_keys | List the authenticated user's GPG keys
|
|
*UserApi* | [**UserCurrentListKeys**](docs/UserApi.md#usercurrentlistkeys) | **Get** /user/keys | List the authenticated user's public keys
|
|
*UserApi* | [**UserCurrentListRepos**](docs/UserApi.md#usercurrentlistrepos) | **Get** /user/repos | List the repos that the authenticated user owns or has access to
|
|
*UserApi* | [**UserCurrentListStarred**](docs/UserApi.md#usercurrentliststarred) | **Get** /user/starred | The repos that the authenticated user has starred
|
|
*UserApi* | [**UserCurrentListSubscriptions**](docs/UserApi.md#usercurrentlistsubscriptions) | **Get** /user/subscriptions | List repositories watched by the authenticated user
|
|
*UserApi* | [**UserCurrentPostGPGKey**](docs/UserApi.md#usercurrentpostgpgkey) | **Post** /user/gpg_keys | Create a GPG key
|
|
*UserApi* | [**UserCurrentPostKey**](docs/UserApi.md#usercurrentpostkey) | **Post** /user/keys | Create a public key
|
|
*UserApi* | [**UserCurrentPutFollow**](docs/UserApi.md#usercurrentputfollow) | **Put** /user/following/{username} | Follow a user
|
|
*UserApi* | [**UserCurrentPutStar**](docs/UserApi.md#usercurrentputstar) | **Put** /user/starred/{owner}/{repo} | Star the given repo
|
|
*UserApi* | [**UserCurrentTrackedTimes**](docs/UserApi.md#usercurrenttrackedtimes) | **Get** /user/times | List the current user's tracked times
|
|
*UserApi* | [**UserDeleteAccessToken**](docs/UserApi.md#userdeleteaccesstoken) | **Delete** /users/{username}/tokens/{token} | delete an access token
|
|
*UserApi* | [**UserDeleteEmail**](docs/UserApi.md#userdeleteemail) | **Delete** /user/emails | Delete email addresses
|
|
*UserApi* | [**UserGet**](docs/UserApi.md#userget) | **Get** /users/{username} | Get a user
|
|
*UserApi* | [**UserGetCurrent**](docs/UserApi.md#usergetcurrent) | **Get** /user | Get the authenticated user
|
|
*UserApi* | [**UserGetHeatmapData**](docs/UserApi.md#usergetheatmapdata) | **Get** /users/{username}/heatmap | Get a user's heatmap
|
|
*UserApi* | [**UserGetStopWatches**](docs/UserApi.md#usergetstopwatches) | **Get** /user/stopwatches | Get list of all existing stopwatches
|
|
*UserApi* | [**UserGetTokens**](docs/UserApi.md#usergettokens) | **Get** /users/{username}/tokens | List the authenticated user's access tokens
|
|
*UserApi* | [**UserListEmails**](docs/UserApi.md#userlistemails) | **Get** /user/emails | List the authenticated user's email addresses
|
|
*UserApi* | [**UserListFollowers**](docs/UserApi.md#userlistfollowers) | **Get** /users/{username}/followers | List the given user's followers
|
|
*UserApi* | [**UserListFollowing**](docs/UserApi.md#userlistfollowing) | **Get** /users/{username}/following | List the users that the given user is following
|
|
*UserApi* | [**UserListGPGKeys**](docs/UserApi.md#userlistgpgkeys) | **Get** /users/{username}/gpg_keys | List the given user's GPG keys
|
|
*UserApi* | [**UserListKeys**](docs/UserApi.md#userlistkeys) | **Get** /users/{username}/keys | List the given user's public keys
|
|
*UserApi* | [**UserListRepos**](docs/UserApi.md#userlistrepos) | **Get** /users/{username}/repos | List the repos owned by the given user
|
|
*UserApi* | [**UserListStarred**](docs/UserApi.md#userliststarred) | **Get** /users/{username}/starred | The repos that the given user has starred
|
|
*UserApi* | [**UserListSubscriptions**](docs/UserApi.md#userlistsubscriptions) | **Get** /users/{username}/subscriptions | List the repositories watched by a user
|
|
*UserApi* | [**UserListTeams**](docs/UserApi.md#userlistteams) | **Get** /user/teams | List all the teams a user belongs to
|
|
*UserApi* | [**UserSearch**](docs/UserApi.md#usersearch) | **Get** /users/search | Search for users
|
|
|
|
|
|
## 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)
|
|
- [NotificationCount](docs/NotificationCount.md)
|
|
- [NotificationSubject](docs/NotificationSubject.md)
|
|
- [NotificationThread](docs/NotificationThread.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)
|
|
- [TransferRepoOption](docs/TransferRepoOption.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
|
|
```golang
|
|
auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
|
|
Key: "APIKEY",
|
|
Prefix: "Bearer", // Omit if not necessary.
|
|
})
|
|
r, err := client.Service.Operation(auth, args)
|
|
```
|
|
## AuthorizationHeaderToken
|
|
- **Type**: API key
|
|
|
|
Example
|
|
```golang
|
|
auth := context.WithValue(context.Background(), 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
|
|
```golang
|
|
auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
|
|
UserName: "username",
|
|
Password: "password",
|
|
})
|
|
r, err := client.Service.Operation(auth, args)
|
|
```
|
|
## SudoHeader
|
|
- **Type**: API key
|
|
|
|
Example
|
|
```golang
|
|
auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
|
|
Key: "APIKEY",
|
|
Prefix: "Bearer", // Omit if not necessary.
|
|
})
|
|
r, err := client.Service.Operation(auth, args)
|
|
```
|
|
## SudoParam
|
|
- **Type**: API key
|
|
|
|
Example
|
|
```golang
|
|
auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
|
|
Key: "APIKEY",
|
|
Prefix: "Bearer", // Omit if not necessary.
|
|
})
|
|
r, err := client.Service.Operation(auth, args)
|
|
```
|
|
## Token
|
|
- **Type**: API key
|
|
|
|
Example
|
|
```golang
|
|
auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
|
|
Key: "APIKEY",
|
|
Prefix: "Bearer", // Omit if not necessary.
|
|
})
|
|
r, err := client.Service.Operation(auth, args)
|
|
```
|
|
|
|
## Author
|
|
|
|
|
|
|