dcs-api

dcs

dcs - JavaScript client for DCS This documentation describes the DCS (Gitea) API. This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.15.6a+dcs
• Package version: 1.15.6a+dcs
• Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install dcs --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var dcs = require('dcs');
var defaultClient = dcs.ApiClient.instance;

// Configure API key authorization: AccessToken
var AccessToken = defaultClient.authentications['AccessToken'];
AccessToken.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//AccessToken.apiKeyPrefix['access_token'] = "Token"

// Configure API key authorization: AuthorizationHeaderToken
var AuthorizationHeaderToken = defaultClient.authentications['AuthorizationHeaderToken'];
AuthorizationHeaderToken.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//AuthorizationHeaderToken.apiKeyPrefix['Authorization'] = "Token"
// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

// Configure API key authorization: SudoHeader
var SudoHeader = defaultClient.authentications['SudoHeader'];
SudoHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//SudoHeader.apiKeyPrefix['Sudo'] = "Token"

// Configure API key authorization: SudoParam
var SudoParam = defaultClient.authentications['SudoParam'];
SudoParam.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//SudoParam.apiKeyPrefix['sudo'] = "Token"

// Configure API key authorization: TOTPHeader
var TOTPHeader = defaultClient.authentications['TOTPHeader'];
TOTPHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//TOTPHeader.apiKeyPrefix['X-GITEA-OTP'] = "Token"

// Configure API key authorization: Token
var Token = defaultClient.authentications['Token'];
Token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Token.apiKeyPrefix['token'] = "Token"

var api = new dcs.AdminApi()
var owner = "owner_example"; // {String} owner of the repo
var repo = "repo_example"; // {String} name of the repo

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.adminAdoptRepository(owner, repo, callback);

Documentation for API Endpoints

All URIs are relative to https://git.door43.org/api/v1

Class	Method	HTTP request	Description
dcs.AdminApi	adminAdoptRepository	POST /admin/unadopted/{owner}/{repo}	Adopt unadopted files as a repository
dcs.AdminApi	adminCreateOrg	POST /admin/users/{username}/orgs	Create an organization
dcs.AdminApi	adminCreatePublicKey	POST /admin/users/{username}/keys	Add a public key on behalf of a user
dcs.AdminApi	adminCreateRepo	POST /admin/users/{username}/repos	Create a repository on behalf of a user
dcs.AdminApi	adminCreateUser	POST /admin/users	Create a user
dcs.AdminApi	adminCronList	GET /admin/cron	List cron tasks
dcs.AdminApi	adminCronRun	POST /admin/cron/{task}	Run cron task
dcs.AdminApi	adminDeleteUnadoptedRepository	DELETE /admin/unadopted/{owner}/{repo}	Delete unadopted files
dcs.AdminApi	adminDeleteUser	DELETE /admin/users/{username}	Delete a user
dcs.AdminApi	adminDeleteUserPublicKey	DELETE /admin/users/{username}/keys/{id}	Delete a user's public key
dcs.AdminApi	adminEditUser	PATCH /admin/users/{username}	Edit an existing user
dcs.AdminApi	adminGetAllOrgs	GET /admin/orgs	List all organizations
dcs.AdminApi	adminGetAllUsers	GET /admin/users	List all users
dcs.AdminApi	adminUnadoptedList	GET /admin/unadopted	List unadopted repositories
dcs.IssueApi	issueAddLabel	POST /repos/{owner}/{repo}/issues/{index}/labels	Add a label to an issue
dcs.IssueApi	issueAddSubscription	PUT /repos/{owner}/{repo}/issues/{index}/subscriptions/{user}	Subscribe user to issue
dcs.IssueApi	issueAddTime	POST /repos/{owner}/{repo}/issues/{index}/times	Add tracked time to a issue
dcs.IssueApi	issueCheckSubscription	GET /repos/{owner}/{repo}/issues/{index}/subscriptions/check	Check if user is subscribed to an issue
dcs.IssueApi	issueClearLabels	DELETE /repos/{owner}/{repo}/issues/{index}/labels	Remove all labels from an issue
dcs.IssueApi	issueCreateComment	POST /repos/{owner}/{repo}/issues/{index}/comments	Add a comment to an issue
dcs.IssueApi	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.
dcs.IssueApi	issueCreateLabel	POST /repos/{owner}/{repo}/labels	Create a label
dcs.IssueApi	issueCreateMilestone	POST /repos/{owner}/{repo}/milestones	Create a milestone
dcs.IssueApi	issueDeleteComment	DELETE /repos/{owner}/{repo}/issues/comments/{id}	Delete a comment
dcs.IssueApi	issueDeleteCommentDeprecated	DELETE /repos/{owner}/{repo}/issues/{index}/comments/{id}	Delete a comment
dcs.IssueApi	issueDeleteLabel	DELETE /repos/{owner}/{repo}/labels/{id}	Delete a label
dcs.IssueApi	issueDeleteMilestone	DELETE /repos/{owner}/{repo}/milestones/{id}	Delete a milestone
dcs.IssueApi	issueDeleteStopWatch	DELETE /repos/{owner}/{repo}/issues/{index}/stopwatch/delete	Delete an issue's existing stopwatch.
dcs.IssueApi	issueDeleteSubscription	DELETE /repos/{owner}/{repo}/issues/{index}/subscriptions/{user}	Unsubscribe user from issue
dcs.IssueApi	issueDeleteTime	DELETE /repos/{owner}/{repo}/issues/{index}/times/{id}	Delete specific tracked time
dcs.IssueApi	issueEditComment	PATCH /repos/{owner}/{repo}/issues/comments/{id}	Edit a comment
dcs.IssueApi	issueEditCommentDeprecated	PATCH /repos/{owner}/{repo}/issues/{index}/comments/{id}	Edit a comment
dcs.IssueApi	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.
dcs.IssueApi	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.
dcs.IssueApi	issueEditLabel	PATCH /repos/{owner}/{repo}/labels/{id}	Update a label
dcs.IssueApi	issueEditMilestone	PATCH /repos/{owner}/{repo}/milestones/{id}	Update a milestone
dcs.IssueApi	issueGetComment	GET /repos/{owner}/{repo}/issues/comments/{id}	Get a comment
dcs.IssueApi	issueGetCommentReactions	GET /repos/{owner}/{repo}/issues/comments/{id}/reactions	Get a list of reactions from a comment of an issue
dcs.IssueApi	issueGetComments	GET /repos/{owner}/{repo}/issues/{index}/comments	List all comments on an issue
dcs.IssueApi	issueGetIssue	GET /repos/{owner}/{repo}/issues/{index}	Get an issue
dcs.IssueApi	issueGetIssueReactions	GET /repos/{owner}/{repo}/issues/{index}/reactions	Get a list reactions of an issue
dcs.IssueApi	issueGetLabel	GET /repos/{owner}/{repo}/labels/{id}	Get a single label
dcs.IssueApi	issueGetLabels	GET /repos/{owner}/{repo}/issues/{index}/labels	Get an issue's labels
dcs.IssueApi	issueGetMilestone	GET /repos/{owner}/{repo}/milestones/{id}	Get a milestone
dcs.IssueApi	issueGetMilestonesList	GET /repos/{owner}/{repo}/milestones	Get all of a repository's opened milestones
dcs.IssueApi	issueGetRepoComments	GET /repos/{owner}/{repo}/issues/comments	List all comments in a repository
dcs.IssueApi	issueListIssues	GET /repos/{owner}/{repo}/issues	List a repository's issues
dcs.IssueApi	issueListLabels	GET /repos/{owner}/{repo}/labels	Get all of a repository's labels
dcs.IssueApi	issuePostCommentReaction	POST /repos/{owner}/{repo}/issues/comments/{id}/reactions	Add a reaction to a comment of an issue
dcs.IssueApi	issuePostIssueReaction	POST /repos/{owner}/{repo}/issues/{index}/reactions	Add a reaction to an issue
dcs.IssueApi	issueRemoveLabel	DELETE /repos/{owner}/{repo}/issues/{index}/labels/{id}	Remove a label from an issue
dcs.IssueApi	issueReplaceLabels	PUT /repos/{owner}/{repo}/issues/{index}/labels	Replace an issue's labels
dcs.IssueApi	issueResetTime	DELETE /repos/{owner}/{repo}/issues/{index}/times	Reset a tracked time of an issue
dcs.IssueApi	issueSearchIssues	GET /repos/issues/search	Search for issues across the repositories that the user has access to
dcs.IssueApi	issueStartStopWatch	POST /repos/{owner}/{repo}/issues/{index}/stopwatch/start	Start stopwatch on an issue.
dcs.IssueApi	issueStopStopWatch	POST /repos/{owner}/{repo}/issues/{index}/stopwatch/stop	Stop an issue's existing stopwatch.
dcs.IssueApi	issueSubscriptions	GET /repos/{owner}/{repo}/issues/{index}/subscriptions	Get users who subscribed on an issue.
dcs.IssueApi	issueTrackedTimes	GET /repos/{owner}/{repo}/issues/{index}/times	List an issue's tracked times
dcs.MiscellaneousApi	getSigningKey	GET /signing-key.gpg	Get default signing-key.gpg
dcs.MiscellaneousApi	getVersion	GET /version	Returns the version of the Gitea application
dcs.MiscellaneousApi	renderMarkdown	POST /markdown	Render a markdown document as HTML
dcs.MiscellaneousApi	renderMarkdownRaw	POST /markdown/raw	Render raw markdown as HTML
dcs.NotificationApi	notifyGetList	GET /notifications	List users's notification threads
dcs.NotificationApi	notifyGetRepoList	GET /repos/{owner}/{repo}/notifications	List users's notification threads on a specific repo
dcs.NotificationApi	notifyGetThread	GET /notifications/threads/{id}	Get notification thread by ID
dcs.NotificationApi	notifyNewAvailable	GET /notifications/new	Check if unread notifications exist
dcs.NotificationApi	notifyReadList	PUT /notifications	Mark notification threads as read, pinned or unread
dcs.NotificationApi	notifyReadRepoList	PUT /repos/{owner}/{repo}/notifications	Mark notification threads as read, pinned or unread on a specific repo
dcs.NotificationApi	notifyReadThread	PATCH /notifications/threads/{id}	Mark notification thread as read by ID
dcs.OrganizationApi	createOrgRepo	POST /orgs/{org}/repos	Create a repository in an organization
dcs.OrganizationApi	createOrgRepoDeprecated	POST /org/{org}/repos	Create a repository in an organization
dcs.OrganizationApi	orgAddTeamMember	PUT /teams/{id}/members/{username}	Add a team member
dcs.OrganizationApi	orgAddTeamRepository	PUT /teams/{id}/repos/{org}/{repo}	Add a repository to a team
dcs.OrganizationApi	orgConcealMember	DELETE /orgs/{org}/public_members/{username}	Conceal a user's membership
dcs.OrganizationApi	orgCreate	POST /orgs	Create an organization
dcs.OrganizationApi	orgCreateHook	POST /orgs/{org}/hooks/	Create a hook
dcs.OrganizationApi	orgCreateLabel	POST /orgs/{org}/labels	Create a label for an organization
dcs.OrganizationApi	orgCreateTeam	POST /orgs/{org}/teams	Create a team
dcs.OrganizationApi	orgDelete	DELETE /orgs/{org}	Delete an organization
dcs.OrganizationApi	orgDeleteHook	DELETE /orgs/{org}/hooks/{id}	Delete a hook
dcs.OrganizationApi	orgDeleteLabel	DELETE /orgs/{org}/labels/{id}	Delete a label
dcs.OrganizationApi	orgDeleteMember	DELETE /orgs/{org}/members/{username}	Remove a member from an organization
dcs.OrganizationApi	orgDeleteTeam	DELETE /teams/{id}	Delete a team
dcs.OrganizationApi	orgEdit	PATCH /orgs/{org}	Edit an organization
dcs.OrganizationApi	orgEditHook	PATCH /orgs/{org}/hooks/{id}	Update a hook
dcs.OrganizationApi	orgEditLabel	PATCH /orgs/{org}/labels/{id}	Update a label
dcs.OrganizationApi	orgEditTeam	PATCH /teams/{id}	Edit a team
dcs.OrganizationApi	orgGet	GET /orgs/{org}	Get an organization
dcs.OrganizationApi	orgGetAll	GET /orgs	Get list of organizations
dcs.OrganizationApi	orgGetHook	GET /orgs/{org}/hooks/{id}	Get a hook
dcs.OrganizationApi	orgGetLabel	GET /orgs/{org}/labels/{id}	Get a single label
dcs.OrganizationApi	orgGetTeam	GET /teams/{id}	Get a team
dcs.OrganizationApi	orgIsMember	GET /orgs/{org}/members/{username}	Check if a user is a member of an organization
dcs.OrganizationApi	orgIsPublicMember	GET /orgs/{org}/public_members/{username}	Check if a user is a public member of an organization
dcs.OrganizationApi	orgListCurrentUserOrgs	GET /user/orgs	List the current user's organizations
dcs.OrganizationApi	orgListHooks	GET /orgs/{org}/hooks	List an organization's webhooks
dcs.OrganizationApi	orgListLabels	GET /orgs/{org}/labels	List an organization's labels
dcs.OrganizationApi	orgListMembers	GET /orgs/{org}/members	List an organization's members
dcs.OrganizationApi	orgListPublicMembers	GET /orgs/{org}/public_members	List an organization's public members
dcs.OrganizationApi	orgListRepos	GET /orgs/{org}/repos	List an organization's repos
dcs.OrganizationApi	orgListTeamMember	GET /teams/{id}/members/{username}	List a particular member of team
dcs.OrganizationApi	orgListTeamMembers	GET /teams/{id}/members	List a team's members
dcs.OrganizationApi	orgListTeamRepos	GET /teams/{id}/repos	List a team's repos
dcs.OrganizationApi	orgListTeams	GET /orgs/{org}/teams	List an organization's teams
dcs.OrganizationApi	orgListUserOrgs	GET /users/{username}/orgs	List a user's organizations
dcs.OrganizationApi	orgPublicizeMember	PUT /orgs/{org}/public_members/{username}	Publicize a user's membership
dcs.OrganizationApi	orgRemoveTeamMember	DELETE /teams/{id}/members/{username}	Remove a team member
dcs.OrganizationApi	orgRemoveTeamRepository	DELETE /teams/{id}/repos/{org}/{repo}	Remove a repository from a team
dcs.OrganizationApi	teamSearch	GET /orgs/{org}/teams/search	Search for teams within an organization
dcs.RepositoryApi	createCurrentUserRepo	POST /user/repos	Create a repository
dcs.RepositoryApi	createFork	POST /repos/{owner}/{repo}/forks	Fork a repository
dcs.RepositoryApi	generateRepo	POST /repos/{template_owner}/{template_repo}/generate	Create a repository using a template
dcs.RepositoryApi	getAnnotatedTag	GET /repos/{owner}/{repo}/git/tags/{sha}	Gets the tag object of an annotated tag (not lightweight tags)
dcs.RepositoryApi	getBlob	GET /repos/{owner}/{repo}/git/blobs/{sha}	Gets the blob of a repository.
dcs.RepositoryApi	getTree	GET /repos/{owner}/{repo}/git/trees/{sha}	Gets the tree of a repository.
dcs.RepositoryApi	listForks	GET /repos/{owner}/{repo}/forks	List a repository's forks
dcs.RepositoryApi	repoAddCollaborator	PUT /repos/{owner}/{repo}/collaborators/{collaborator}	Add a collaborator to a repository
dcs.RepositoryApi	repoAddTeam	PUT /repos/{owner}/{repo}/teams/{team}	Add a team to a repository
dcs.RepositoryApi	repoAddTopc	PUT /repos/{owner}/{repo}/topics/{topic}	Add a topic to a repository
dcs.RepositoryApi	repoCheckCollaborator	GET /repos/{owner}/{repo}/collaborators/{collaborator}	Check if a user is a collaborator of a repository
dcs.RepositoryApi	repoCheckTeam	GET /repos/{owner}/{repo}/teams/{team}	Check if a team is assigned to a repository
dcs.RepositoryApi	repoCreateBranch	POST /repos/{owner}/{repo}/branches	Create a branch
dcs.RepositoryApi	repoCreateBranchProtection	POST /repos/{owner}/{repo}/branch_protections	Create a branch protections for a repository
dcs.RepositoryApi	repoCreateFile	POST /repos/{owner}/{repo}/contents/{filepath}	Create a file in a repository
dcs.RepositoryApi	repoCreateHook	POST /repos/{owner}/{repo}/hooks	Create a hook
dcs.RepositoryApi	repoCreateKey	POST /repos/{owner}/{repo}/keys	Add a key to a repository
dcs.RepositoryApi	repoCreatePullRequest	POST /repos/{owner}/{repo}/pulls	Create a pull request
dcs.RepositoryApi	repoCreatePullReview	POST /repos/{owner}/{repo}/pulls/{index}/reviews	Create a review to an pull request
dcs.RepositoryApi	repoCreatePullReviewRequests	POST /repos/{owner}/{repo}/pulls/{index}/requested_reviewers	create review requests for a pull request
dcs.RepositoryApi	repoCreateRelease	POST /repos/{owner}/{repo}/releases	Create a release
dcs.RepositoryApi	repoCreateReleaseAttachment	POST /repos/{owner}/{repo}/releases/{id}/assets	Create a release attachment
dcs.RepositoryApi	repoCreateStatus	POST /repos/{owner}/{repo}/statuses/{sha}	Create a commit status
dcs.RepositoryApi	repoCreateTag	POST /repos/{owner}/{repo}/tags	Create a new git tag in a repository
dcs.RepositoryApi	repoDelete	DELETE /repos/{owner}/{repo}	Delete a repository
dcs.RepositoryApi	repoDeleteBranch	DELETE /repos/{owner}/{repo}/branches/{branch}	Delete a specific branch from a repository
dcs.RepositoryApi	repoDeleteBranchProtection	DELETE /repos/{owner}/{repo}/branch_protections/{name}	Delete a specific branch protection for the repository
dcs.RepositoryApi	repoDeleteCollaborator	DELETE /repos/{owner}/{repo}/collaborators/{collaborator}	Delete a collaborator from a repository
dcs.RepositoryApi	repoDeleteGitHook	DELETE /repos/{owner}/{repo}/hooks/git/{id}	Delete a Git hook in a repository
dcs.RepositoryApi	repoDeleteHook	DELETE /repos/{owner}/{repo}/hooks/{id}	Delete a hook in a repository
dcs.RepositoryApi	repoDeleteKey	DELETE /repos/{owner}/{repo}/keys/{id}	Delete a key from a repository
dcs.RepositoryApi	repoDeletePullReview	DELETE /repos/{owner}/{repo}/pulls/{index}/reviews/{id}	Delete a specific review from a pull request
dcs.RepositoryApi	repoDeleteRelease	DELETE /repos/{owner}/{repo}/releases/{id}	Delete a release
dcs.RepositoryApi	repoDeleteReleaseAttachment	DELETE /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}	Delete a release attachment
dcs.RepositoryApi	repoDeleteReleaseByTag	DELETE /repos/{owner}/{repo}/releases/tags/{tag}	Delete a release by tag name
dcs.RepositoryApi	repoDeleteTag	DELETE /repos/{owner}/{repo}/tags/{tag}	Delete a repository's tag by name
dcs.RepositoryApi	repoDeleteTeam	DELETE /repos/{owner}/{repo}/teams/{team}	Delete a team from a repository
dcs.RepositoryApi	repoDeleteTopic	DELETE /repos/{owner}/{repo}/topics/{topic}	Delete a topic from a repository
dcs.RepositoryApi	repoDismissPullReview	POST /repos/{owner}/{repo}/pulls/{index}/reviews/{id}/dismissals	Dismiss a review for a pull request
dcs.RepositoryApi	repoDownloadPullDiff	GET /repos/{owner}/{repo}/pulls/{index}.diff	Get a pull request diff
dcs.RepositoryApi	repoDownloadPullPatch	GET /repos/{owner}/{repo}/pulls/{index}.patch	Get a pull request patch file
dcs.RepositoryApi	repoEdit	PATCH /repos/{owner}/{repo}	Edit a repository's properties. Only fields that are set will be changed.
dcs.RepositoryApi	repoEditBranchProtection	PATCH /repos/{owner}/{repo}/branch_protections/{name}	Edit a branch protections for a repository. Only fields that are set will be changed
dcs.RepositoryApi	repoEditGitHook	PATCH /repos/{owner}/{repo}/hooks/git/{id}	Edit a Git hook in a repository
dcs.RepositoryApi	repoEditHook	PATCH /repos/{owner}/{repo}/hooks/{id}	Edit a hook in a repository
dcs.RepositoryApi	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.
dcs.RepositoryApi	repoEditRelease	PATCH /repos/{owner}/{repo}/releases/{id}	Update a release
dcs.RepositoryApi	repoEditReleaseAttachment	PATCH /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}	Edit a release attachment
dcs.RepositoryApi	repoGet	GET /repos/{owner}/{repo}	Get a repository
dcs.RepositoryApi	repoGetAllCommits	GET /repos/{owner}/{repo}/commits	Get a list of all commits from a repository
dcs.RepositoryApi	repoGetArchive	GET /repos/{owner}/{repo}/archive/{archive}	Get an archive of a repository
dcs.RepositoryApi	repoGetAssignees	GET /repos/{owner}/{repo}/assignees	Return all users that have write access and can be assigned to issues
dcs.RepositoryApi	repoGetBranch	GET /repos/{owner}/{repo}/branches/{branch}	Retrieve a specific branch from a repository, including its effective branch protection
dcs.RepositoryApi	repoGetBranchProtection	GET /repos/{owner}/{repo}/branch_protections/{name}	Get a specific branch protection for the repository
dcs.RepositoryApi	repoGetByID	GET /repositories/{id}	Get a repository by id
dcs.RepositoryApi	repoGetCombinedStatusByRef	GET /repos/{owner}/{repo}/commits/{ref}/status	Get a commit's combined status, by branch/tag/commit reference
dcs.RepositoryApi	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
dcs.RepositoryApi	repoGetContentsList	GET /repos/{owner}/{repo}/contents	Gets the metadata of all the entries of the root dir
dcs.RepositoryApi	repoGetEditorConfig	GET /repos/{owner}/{repo}/editorconfig/{filepath}	Get the EditorConfig definitions of a file in a repository
dcs.RepositoryApi	repoGetGitHook	GET /repos/{owner}/{repo}/hooks/git/{id}	Get a Git hook
dcs.RepositoryApi	repoGetHook	GET /repos/{owner}/{repo}/hooks/{id}	Get a hook
dcs.RepositoryApi	repoGetIssueTemplates	GET /repos/{owner}/{repo}/issue_templates	Get available issue templates for a repository
dcs.RepositoryApi	repoGetKey	GET /repos/{owner}/{repo}/keys/{id}	Get a repository's key by id
dcs.RepositoryApi	repoGetLanguages	GET /repos/{owner}/{repo}/languages	Get languages and number of bytes of code written
dcs.RepositoryApi	repoGetPullRequest	GET /repos/{owner}/{repo}/pulls/{index}	Get a pull request
dcs.RepositoryApi	repoGetPullRequestCommits	GET /repos/{owner}/{repo}/pulls/{index}/commits	Get commits for a pull request
dcs.RepositoryApi	repoGetPullReview	GET /repos/{owner}/{repo}/pulls/{index}/reviews/{id}	Get a specific review for a pull request
dcs.RepositoryApi	repoGetPullReviewComments	GET /repos/{owner}/{repo}/pulls/{index}/reviews/{id}/comments	Get a specific review for a pull request
dcs.RepositoryApi	repoGetRawFile	GET /repos/{owner}/{repo}/raw/{filepath}	Get a file from a repository
dcs.RepositoryApi	repoGetRelease	GET /repos/{owner}/{repo}/releases/{id}	Get a release
dcs.RepositoryApi	repoGetReleaseAttachment	GET /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}	Get a release attachment
dcs.RepositoryApi	repoGetReleaseByTag	GET /repos/{owner}/{repo}/releases/tags/{tag}	Get a release by tag name
dcs.RepositoryApi	repoGetReviewers	GET /repos/{owner}/{repo}/reviewers	Return all users that can be requested to review in this repo
dcs.RepositoryApi	repoGetSingleCommit	GET /repos/{owner}/{repo}/git/commits/{sha}	Get a single commit from a repository
dcs.RepositoryApi	repoGetTag	GET /repos/{owner}/{repo}/tags/{tag}	Get the tag of a repository by tag name
dcs.RepositoryApi	repoListAllGitRefs	GET /repos/{owner}/{repo}/git/refs	Get specified ref or filtered repository's refs
dcs.RepositoryApi	repoListBranchProtection	GET /repos/{owner}/{repo}/branch_protections	List branch protections for a repository
dcs.RepositoryApi	repoListBranches	GET /repos/{owner}/{repo}/branches	List a repository's branches
dcs.RepositoryApi	repoListCollaborators	GET /repos/{owner}/{repo}/collaborators	List a repository's collaborators
dcs.RepositoryApi	repoListGitHooks	GET /repos/{owner}/{repo}/hooks/git	List the Git hooks in a repository
dcs.RepositoryApi	repoListGitRefs	GET /repos/{owner}/{repo}/git/refs/{ref}	Get specified ref or filtered repository's refs
dcs.RepositoryApi	repoListHooks	GET /repos/{owner}/{repo}/hooks	List the hooks in a repository
dcs.RepositoryApi	repoListKeys	GET /repos/{owner}/{repo}/keys	List a repository's keys
dcs.RepositoryApi	repoListPullRequests	GET /repos/{owner}/{repo}/pulls	List a repo's pull requests
dcs.RepositoryApi	repoListPullReviews	GET /repos/{owner}/{repo}/pulls/{index}/reviews	List all reviews for a pull request
dcs.RepositoryApi	repoListReleaseAttachments	GET /repos/{owner}/{repo}/releases/{id}/assets	List release's attachments
dcs.RepositoryApi	repoListReleases	GET /repos/{owner}/{repo}/releases	List a repo's releases
dcs.RepositoryApi	repoListStargazers	GET /repos/{owner}/{repo}/stargazers	List a repo's stargazers
dcs.RepositoryApi	repoListStatuses	GET /repos/{owner}/{repo}/statuses/{sha}	Get a commit's statuses
dcs.RepositoryApi	repoListStatusesByRef	GET /repos/{owner}/{repo}/commits/{ref}/statuses	Get a commit's statuses, by branch/tag/commit reference
dcs.RepositoryApi	repoListSubscribers	GET /repos/{owner}/{repo}/subscribers	List a repo's watchers
dcs.RepositoryApi	repoListTags	GET /repos/{owner}/{repo}/tags	List a repository's tags
dcs.RepositoryApi	repoListTeams	GET /repos/{owner}/{repo}/teams	List a repository's teams
dcs.RepositoryApi	repoListTopics	GET /repos/{owner}/{repo}/topics	Get list of topics that a repository has
dcs.RepositoryApi	repoMergePullRequest	POST /repos/{owner}/{repo}/pulls/{index}/merge	Merge a pull request
dcs.RepositoryApi	repoMigrate	POST /repos/migrate	Migrate a remote git repository
dcs.RepositoryApi	repoMirrorSync	POST /repos/{owner}/{repo}/mirror-sync	Sync a mirrored repository
dcs.RepositoryApi	repoPullRequestIsMerged	GET /repos/{owner}/{repo}/pulls/{index}/merge	Check if a pull request has been merged
dcs.RepositoryApi	repoSearch	GET /repos/search	Search for repositories
dcs.RepositoryApi	repoSigningKey	GET /repos/{owner}/{repo}/signing-key.gpg	Get signing-key.gpg for given repository
dcs.RepositoryApi	repoSubmitPullReview	POST /repos/{owner}/{repo}/pulls/{index}/reviews/{id}	Submit a pending review to an pull request
dcs.RepositoryApi	repoTestHook	POST /repos/{owner}/{repo}/hooks/{id}/tests	Test a push webhook
dcs.RepositoryApi	repoTrackedTimes	GET /repos/{owner}/{repo}/times	List a repo's tracked times
dcs.RepositoryApi	repoTransfer	POST /repos/{owner}/{repo}/transfer	Transfer a repo ownership
dcs.RepositoryApi	repoUnDismissPullReview	POST /repos/{owner}/{repo}/pulls/{index}/reviews/{id}/undismissals	Cancel to dismiss a review for a pull request
dcs.RepositoryApi	repoUpdateFile	PUT /repos/{owner}/{repo}/contents/{filepath}	Update a file in a repository
dcs.RepositoryApi	repoUpdatePullRequest	POST /repos/{owner}/{repo}/pulls/{index}/update	Merge PR's baseBranch into headBranch
dcs.RepositoryApi	repoUpdateTopics	PUT /repos/{owner}/{repo}/topics	Replace list of topics for a repository
dcs.RepositoryApi	topicSearch	GET /topics/search	search topics via keyword
dcs.RepositoryApi	userCurrentCheckSubscription	GET /repos/{owner}/{repo}/subscription	Check if the current user is watching a repo
dcs.RepositoryApi	userCurrentDeleteSubscription	DELETE /repos/{owner}/{repo}/subscription	Unwatch a repo
dcs.RepositoryApi	userCurrentPutSubscription	PUT /repos/{owner}/{repo}/subscription	Watch a repo
dcs.RepositoryApi	userTrackedTimes	GET /repos/{owner}/{repo}/times/{user}	List a user's tracked times in a repo
dcs.SettingsApi	getGeneralAPISettings	GET /settings/api	Get instance's global settings for api
dcs.SettingsApi	getGeneralAttachmentSettings	GET /settings/attachment	Get instance's global settings for Attachment
dcs.SettingsApi	getGeneralRepositorySettings	GET /settings/repository	Get instance's global settings for repositories
dcs.SettingsApi	getGeneralUISettings	GET /settings/ui	Get instance's global settings for ui
dcs.UserApi	createCurrentUserRepo	POST /user/repos	Create a repository
dcs.UserApi	getUserSettings	GET /user/settings	Get user settings
dcs.UserApi	getVerificationToken	GET /user/gpg_key_token	Get a Token to verify
dcs.UserApi	updateUserSettings	PATCH /user/settings	Update user settings
dcs.UserApi	userAddEmail	POST /user/emails	Add email addresses
dcs.UserApi	userCheckFollowing	GET /users/{follower}/following/{followee}	Check if one user is following another user
dcs.UserApi	userCreateOAuth2Application	POST /user/applications/oauth2	creates a new OAuth2 application
dcs.UserApi	userCreateToken	POST /users/{username}/tokens	Create an access token
dcs.UserApi	userCurrentCheckFollowing	GET /user/following/{username}	Check whether a user is followed by the authenticated user
dcs.UserApi	userCurrentCheckStarring	GET /user/starred/{owner}/{repo}	Whether the authenticated is starring the repo
dcs.UserApi	userCurrentDeleteFollow	DELETE /user/following/{username}	Unfollow a user
dcs.UserApi	userCurrentDeleteGPGKey	DELETE /user/gpg_keys/{id}	Remove a GPG key
dcs.UserApi	userCurrentDeleteKey	DELETE /user/keys/{id}	Delete a public key
dcs.UserApi	userCurrentDeleteStar	DELETE /user/starred/{owner}/{repo}	Unstar the given repo
dcs.UserApi	userCurrentGetGPGKey	GET /user/gpg_keys/{id}	Get a GPG key
dcs.UserApi	userCurrentGetKey	GET /user/keys/{id}	Get a public key
dcs.UserApi	userCurrentListFollowers	GET /user/followers	List the authenticated user's followers
dcs.UserApi	userCurrentListFollowing	GET /user/following	List the users that the authenticated user is following
dcs.UserApi	userCurrentListGPGKeys	GET /user/gpg_keys	List the authenticated user's GPG keys
dcs.UserApi	userCurrentListKeys	GET /user/keys	List the authenticated user's public keys
dcs.UserApi	userCurrentListRepos	GET /user/repos	List the repos that the authenticated user owns or has access to
dcs.UserApi	userCurrentListStarred	GET /user/starred	The repos that the authenticated user has starred
dcs.UserApi	userCurrentListSubscriptions	GET /user/subscriptions	List repositories watched by the authenticated user
dcs.UserApi	userCurrentPostGPGKey	POST /user/gpg_keys	Create a GPG key
dcs.UserApi	userCurrentPostKey	POST /user/keys	Create a public key
dcs.UserApi	userCurrentPutFollow	PUT /user/following/{username}	Follow a user
dcs.UserApi	userCurrentPutStar	PUT /user/starred/{owner}/{repo}	Star the given repo
dcs.UserApi	userCurrentTrackedTimes	GET /user/times	List the current user's tracked times
dcs.UserApi	userDeleteAccessToken	DELETE /users/{username}/tokens/{token}	delete an access token
dcs.UserApi	userDeleteOAuth2Application	DELETE /user/applications/oauth2/{id}	delete an OAuth2 Application
dcs.UserApi	userGet	GET /users/{username}	Get a user
dcs.UserApi	userGetCurrent	GET /user	Get the authenticated user
dcs.UserApi	userGetHeatmapData	GET /users/{username}/heatmap	Get a user's heatmap
dcs.UserApi	userGetOAuth2Application	GET /user/applications/oauth2/{id}	get an OAuth2 Application
dcs.UserApi	userGetOauth2Application	GET /user/applications/oauth2	List the authenticated user's oauth2 applications
dcs.UserApi	userGetStopWatches	GET /user/stopwatches	Get list of all existing stopwatches
dcs.UserApi	userGetTokens	GET /users/{username}/tokens	List the authenticated user's access tokens
dcs.UserApi	userListEmails	GET /user/emails	List the authenticated user's email addresses
dcs.UserApi	userListFollowers	GET /users/{username}/followers	List the given user's followers
dcs.UserApi	userListFollowing	GET /users/{username}/following	List the users that the given user is following
dcs.UserApi	userListGPGKeys	GET /users/{username}/gpg_keys	List the given user's GPG keys
dcs.UserApi	userListKeys	GET /users/{username}/keys	List the given user's public keys
dcs.UserApi	userListRepos	GET /users/{username}/repos	List the repos owned by the given user
dcs.UserApi	userListStarred	GET /users/{username}/starred	The repos that the given user has starred
dcs.UserApi	userListSubscriptions	GET /users/{username}/subscriptions	List the repositories watched by a user
dcs.UserApi	userListTeams	GET /user/teams	List all the teams a user belongs to
dcs.UserApi	userSearch	GET /users/search	Search for users
dcs.UserApi	userUpdateOAuth2Application	PATCH /user/applications/oauth2/{id}	update an OAuth2 Application, this includes regenerating the client secret
dcs.UserApi	userVerifyGPGKey	POST /user/gpg_key_verify	Verify a GPG key

Documentation for Models

• dcs.APIError
• dcs.AccessToken
• dcs.AddCollaboratorOption
• dcs.AddTimeOption
• dcs.AnnotatedTag
• dcs.AnnotatedTagObject
• dcs.Attachment
• dcs.Branch
• dcs.BranchProtection
• dcs.CatalogStage
• dcs.CatalogStages
• dcs.CombinedStatus
• dcs.Comment
• dcs.Commit
• dcs.CommitAffectedFiles
• dcs.CommitDateOptions
• dcs.CommitMeta
• dcs.CommitStatus
• dcs.CommitStatusState
• dcs.CommitUser
• dcs.ContentsResponse
• dcs.CreateAccessTokenOption
• dcs.CreateBranchProtectionOption
• dcs.CreateBranchRepoOption
• dcs.CreateEmailOption
• dcs.CreateFileOptions
• dcs.CreateForkOption
• dcs.CreateGPGKeyOption
• dcs.CreateHookOption
• dcs.CreateHookOptionConfig
• dcs.CreateIssueCommentOption
• dcs.CreateIssueOption
• dcs.CreateKeyOption
• dcs.CreateLabelOption
• dcs.CreateMilestoneOption
• dcs.CreateOAuth2ApplicationOptions
• dcs.CreateOrgOption
• dcs.CreatePullRequestOption
• dcs.CreatePullReviewComment
• dcs.CreatePullReviewOptions
• dcs.CreateReleaseOption
• dcs.CreateRepoOption
• dcs.CreateStatusOption
• dcs.CreateTagOption
• dcs.CreateTeamOption
• dcs.CreateUserOption
• dcs.Cron
• dcs.DeployKey
• dcs.DismissPullReviewOptions
• dcs.EditAttachmentOptions
• dcs.EditBranchProtectionOption
• dcs.EditDeadlineOption
• dcs.EditGitHookOption
• dcs.EditHookOption
• dcs.EditIssueCommentOption
• dcs.EditIssueOption
• dcs.EditLabelOption
• dcs.EditMilestoneOption
• dcs.EditOrgOption
• dcs.EditPullRequestOption
• dcs.EditReactionOption
• dcs.EditReleaseOption
• dcs.EditRepoOption
• dcs.EditTeamOption
• dcs.EditUserOption
• dcs.Email
• dcs.ExternalTracker
• dcs.ExternalWiki
• dcs.FileCommitResponse
• dcs.FileDeleteResponse
• dcs.FileLinksResponse
• dcs.FileResponse
• dcs.GPGKey
• dcs.GPGKeyEmail
• dcs.GeneralAPISettings
• dcs.GeneralAttachmentSettings
• dcs.GeneralRepoSettings
• dcs.GeneralUISettings
• dcs.GenerateRepoOption
• dcs.GitBlobResponse
• dcs.GitEntry
• dcs.GitHook
• dcs.GitObject
• dcs.GitServiceType
• dcs.GitTreeResponse
• dcs.Hook
• dcs.IdAssetsBody
• dcs.Identity
• dcs.InlineResponse200
• dcs.InlineResponse2001
• dcs.InternalTracker
• dcs.Issue
• dcs.IssueDeadline
• dcs.IssueLabelsOption
• dcs.IssueTemplate
• dcs.Label
• dcs.MarkdownOption
• dcs.MergePullRequestOption
• dcs.MigrateRepoOptions
• dcs.Milestone
• dcs.NotificationCount
• dcs.NotificationSubject
• dcs.NotificationThread
• dcs.NotifySubjectType
• dcs.OAuth2Application
• dcs.Organization
• dcs.PRBranchInfo
• dcs.PayloadCommit
• dcs.PayloadCommitVerification
• dcs.PayloadUser
• dcs.Permission
• dcs.PublicKey
• dcs.PullRequest
• dcs.PullRequestMeta
• dcs.PullReview
• dcs.PullReviewComment
• dcs.PullReviewRequestOptions
• dcs.Reaction
• dcs.Reference
• dcs.Release
• dcs.RepoCommit
• dcs.RepoTopicOptions
• dcs.Repository
• dcs.RepositoryMeta
• dcs.ReviewStateType
• dcs.SearchResults
• dcs.ServerVersion
• dcs.StateType
• dcs.StopWatch
• dcs.SubmitPullReviewOptions
• dcs.Tag
• dcs.Team
• dcs.TimeStamp
• dcs.TopicName
• dcs.TopicResponse
• dcs.TrackedTime
• dcs.TransferRepoOption
• dcs.UpdateFileOptions
• dcs.User
• dcs.UserHeatmapData
• dcs.UserSettings
• dcs.UserSettingsOptions
• dcs.WatchInfo

Documentation for Authorization

AccessToken

• Type: API key
• API key parameter name: access_token
• Location: URL query string

AuthorizationHeaderToken

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

BasicAuth

• Type: HTTP basic authentication

SudoHeader

• Type: API key
• API key parameter name: Sudo
• Location: HTTP header

SudoParam

• Type: API key
• API key parameter name: sudo
• Location: URL query string

TOTPHeader

• Type: API key
• API key parameter name: X-GITEA-OTP
• Location: HTTP header

Token

• Type: API key
• API key parameter name: token
• Location: URL query string