# RepositoryApi All URIs are relative to *http://localhost/api/v1* Method | HTTP request | Description ------------- | ------------- | ------------- [**createCurrentUserRepo**](RepositoryApi.md#createCurrentUserRepo) | **POST** /user/repos | Create a repository [**createFork**](RepositoryApi.md#createFork) | **POST** /repos/{owner}/{repo}/forks | Fork a repository [**getBlob**](RepositoryApi.md#getBlob) | **GET** /repos/{owner}/{repo}/git/blobs/{sha} | Gets the blob of a repository. [**getTag**](RepositoryApi.md#getTag) | **GET** /repos/{owner}/{repo}/git/tags/{sha} | Gets the tag object of an annotated tag (not lightweight tags) [**getTree**](RepositoryApi.md#getTree) | **GET** /repos/{owner}/{repo}/git/trees/{sha} | Gets the tree of a repository. [**listForks**](RepositoryApi.md#listForks) | **GET** /repos/{owner}/{repo}/forks | List a repository's forks [**repoAddCollaborator**](RepositoryApi.md#repoAddCollaborator) | **PUT** /repos/{owner}/{repo}/collaborators/{collaborator} | Add a collaborator to a repository [**repoAddTopc**](RepositoryApi.md#repoAddTopc) | **PUT** /repos/{owner}/{repo}/topics/{topic} | Add a topic to a repository [**repoCheckCollaborator**](RepositoryApi.md#repoCheckCollaborator) | **GET** /repos/{owner}/{repo}/collaborators/{collaborator} | Check if a user is a collaborator of a repository [**repoCreateBranch**](RepositoryApi.md#repoCreateBranch) | **POST** /repos/{owner}/{repo}/branches | Create a branch [**repoCreateBranchProtection**](RepositoryApi.md#repoCreateBranchProtection) | **POST** /repos/{owner}/{repo}/branch_protections | Create a branch protections for a repository [**repoCreateFile**](RepositoryApi.md#repoCreateFile) | **POST** /repos/{owner}/{repo}/contents/{filepath} | Create a file in a repository [**repoCreateHook**](RepositoryApi.md#repoCreateHook) | **POST** /repos/{owner}/{repo}/hooks | Create a hook [**repoCreateKey**](RepositoryApi.md#repoCreateKey) | **POST** /repos/{owner}/{repo}/keys | Add a key to a repository [**repoCreatePullRequest**](RepositoryApi.md#repoCreatePullRequest) | **POST** /repos/{owner}/{repo}/pulls | Create a pull request [**repoCreatePullReview**](RepositoryApi.md#repoCreatePullReview) | **POST** /repos/{owner}/{repo}/pulls/{index}/reviews | Create a review to an pull request [**repoCreateRelease**](RepositoryApi.md#repoCreateRelease) | **POST** /repos/{owner}/{repo}/releases | Create a release [**repoCreateReleaseAttachment**](RepositoryApi.md#repoCreateReleaseAttachment) | **POST** /repos/{owner}/{repo}/releases/{id}/assets | Create a release attachment [**repoCreateStatus**](RepositoryApi.md#repoCreateStatus) | **POST** /repos/{owner}/{repo}/statuses/{sha} | Create a commit status [**repoDelete**](RepositoryApi.md#repoDelete) | **DELETE** /repos/{owner}/{repo} | Delete a repository [**repoDeleteBranch**](RepositoryApi.md#repoDeleteBranch) | **DELETE** /repos/{owner}/{repo}/branches/{branch} | Delete a specific branch from a repository [**repoDeleteBranchProtection**](RepositoryApi.md#repoDeleteBranchProtection) | **DELETE** /repos/{owner}/{repo}/branch_protections/{name} | Delete a specific branch protection for the repository [**repoDeleteCollaborator**](RepositoryApi.md#repoDeleteCollaborator) | **DELETE** /repos/{owner}/{repo}/collaborators/{collaborator} | Delete a collaborator from a repository [**repoDeleteFile**](RepositoryApi.md#repoDeleteFile) | **DELETE** /repos/{owner}/{repo}/contents/{filepath} | Delete a file in a repository [**repoDeleteGitHook**](RepositoryApi.md#repoDeleteGitHook) | **DELETE** /repos/{owner}/{repo}/hooks/git/{id} | Delete a Git hook in a repository [**repoDeleteHook**](RepositoryApi.md#repoDeleteHook) | **DELETE** /repos/{owner}/{repo}/hooks/{id} | Delete a hook in a repository [**repoDeleteKey**](RepositoryApi.md#repoDeleteKey) | **DELETE** /repos/{owner}/{repo}/keys/{id} | Delete a key from a repository [**repoDeletePullReview**](RepositoryApi.md#repoDeletePullReview) | **DELETE** /repos/{owner}/{repo}/pulls/{index}/reviews/{id} | Delete a specific review from a pull request [**repoDeleteRelease**](RepositoryApi.md#repoDeleteRelease) | **DELETE** /repos/{owner}/{repo}/releases/{id} | Delete a release [**repoDeleteReleaseAttachment**](RepositoryApi.md#repoDeleteReleaseAttachment) | **DELETE** /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id} | Delete a release attachment [**repoDeleteTopic**](RepositoryApi.md#repoDeleteTopic) | **DELETE** /repos/{owner}/{repo}/topics/{topic} | Delete a topic from a repository [**repoDownloadPullDiff**](RepositoryApi.md#repoDownloadPullDiff) | **GET** /repos/{owner}/{repo}/pulls/{index}.diff | Get a pull request diff [**repoDownloadPullPatch**](RepositoryApi.md#repoDownloadPullPatch) | **GET** /repos/{owner}/{repo}/pulls/{index}.patch | Get a pull request patch file [**repoEdit**](RepositoryApi.md#repoEdit) | **PATCH** /repos/{owner}/{repo} | Edit a repository's properties. Only fields that are set will be changed. [**repoEditBranchProtection**](RepositoryApi.md#repoEditBranchProtection) | **PATCH** /repos/{owner}/{repo}/branch_protections/{name} | Edit a branch protections for a repository. Only fields that are set will be changed [**repoEditGitHook**](RepositoryApi.md#repoEditGitHook) | **PATCH** /repos/{owner}/{repo}/hooks/git/{id} | Edit a Git hook in a repository [**repoEditHook**](RepositoryApi.md#repoEditHook) | **PATCH** /repos/{owner}/{repo}/hooks/{id} | Edit a hook in a repository [**repoEditPullRequest**](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. [**repoEditRelease**](RepositoryApi.md#repoEditRelease) | **PATCH** /repos/{owner}/{repo}/releases/{id} | Update a release [**repoEditReleaseAttachment**](RepositoryApi.md#repoEditReleaseAttachment) | **PATCH** /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id} | Edit a release attachment [**repoGet**](RepositoryApi.md#repoGet) | **GET** /repos/{owner}/{repo} | Get a repository [**repoGetAllCommits**](RepositoryApi.md#repoGetAllCommits) | **GET** /repos/{owner}/{repo}/commits | Get a list of all commits from a repository [**repoGetArchive**](RepositoryApi.md#repoGetArchive) | **GET** /repos/{owner}/{repo}/archive/{archive} | Get an archive of a repository [**repoGetBranch**](RepositoryApi.md#repoGetBranch) | **GET** /repos/{owner}/{repo}/branches/{branch} | Retrieve a specific branch from a repository, including its effective branch protection [**repoGetBranchProtection**](RepositoryApi.md#repoGetBranchProtection) | **GET** /repos/{owner}/{repo}/branch_protections/{name} | Get a specific branch protection for the repository [**repoGetByID**](RepositoryApi.md#repoGetByID) | **GET** /repositories/{id} | Get a repository by id [**repoGetCombinedStatusByRef**](RepositoryApi.md#repoGetCombinedStatusByRef) | **GET** /repos/{owner}/{repo}/commits/{ref}/status | Get a commit's combined status, by branch/tag/commit reference [**repoGetContents**](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 [**repoGetContentsList**](RepositoryApi.md#repoGetContentsList) | **GET** /repos/{owner}/{repo}/contents | Gets the metadata of all the entries of the root dir [**repoGetEditorConfig**](RepositoryApi.md#repoGetEditorConfig) | **GET** /repos/{owner}/{repo}/editorconfig/{filepath} | Get the EditorConfig definitions of a file in a repository [**repoGetGitHook**](RepositoryApi.md#repoGetGitHook) | **GET** /repos/{owner}/{repo}/hooks/git/{id} | Get a Git hook [**repoGetHook**](RepositoryApi.md#repoGetHook) | **GET** /repos/{owner}/{repo}/hooks/{id} | Get a hook [**repoGetIssueTemplates**](RepositoryApi.md#repoGetIssueTemplates) | **GET** /repos/{owner}/{repo}/issue_templates | Get available issue templates for a repository [**repoGetKey**](RepositoryApi.md#repoGetKey) | **GET** /repos/{owner}/{repo}/keys/{id} | Get a repository's key by id [**repoGetLanguages**](RepositoryApi.md#repoGetLanguages) | **GET** /repos/{owner}/{repo}/languages | Get languages and number of bytes of code written [**repoGetPullRequest**](RepositoryApi.md#repoGetPullRequest) | **GET** /repos/{owner}/{repo}/pulls/{index} | Get a pull request [**repoGetPullReview**](RepositoryApi.md#repoGetPullReview) | **GET** /repos/{owner}/{repo}/pulls/{index}/reviews/{id} | Get a specific review for a pull request [**repoGetPullReviewComments**](RepositoryApi.md#repoGetPullReviewComments) | **GET** /repos/{owner}/{repo}/pulls/{index}/reviews/{id}/comments | Get a specific review for a pull request [**repoGetRawFile**](RepositoryApi.md#repoGetRawFile) | **GET** /repos/{owner}/{repo}/raw/{filepath} | Get a file from a repository [**repoGetRelease**](RepositoryApi.md#repoGetRelease) | **GET** /repos/{owner}/{repo}/releases/{id} | Get a release [**repoGetReleaseAttachment**](RepositoryApi.md#repoGetReleaseAttachment) | **GET** /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id} | Get a release attachment [**repoGetReleaseTag**](RepositoryApi.md#repoGetReleaseTag) | **GET** /repos/{owner}/{repo}/releases/tags/{tag} | Get a release by tag name [**repoGetSingleCommit**](RepositoryApi.md#repoGetSingleCommit) | **GET** /repos/{owner}/{repo}/git/commits/{sha} | Get a single commit from a repository [**repoListAllGitRefs**](RepositoryApi.md#repoListAllGitRefs) | **GET** /repos/{owner}/{repo}/git/refs | Get specified ref or filtered repository's refs [**repoListBranchProtection**](RepositoryApi.md#repoListBranchProtection) | **GET** /repos/{owner}/{repo}/branch_protections | List branch protections for a repository [**repoListBranches**](RepositoryApi.md#repoListBranches) | **GET** /repos/{owner}/{repo}/branches | List a repository's branches [**repoListCollaborators**](RepositoryApi.md#repoListCollaborators) | **GET** /repos/{owner}/{repo}/collaborators | List a repository's collaborators [**repoListGitHooks**](RepositoryApi.md#repoListGitHooks) | **GET** /repos/{owner}/{repo}/hooks/git | List the Git hooks in a repository [**repoListGitRefs**](RepositoryApi.md#repoListGitRefs) | **GET** /repos/{owner}/{repo}/git/refs/{ref} | Get specified ref or filtered repository's refs [**repoListHooks**](RepositoryApi.md#repoListHooks) | **GET** /repos/{owner}/{repo}/hooks | List the hooks in a repository [**repoListKeys**](RepositoryApi.md#repoListKeys) | **GET** /repos/{owner}/{repo}/keys | List a repository's keys [**repoListPullRequests**](RepositoryApi.md#repoListPullRequests) | **GET** /repos/{owner}/{repo}/pulls | List a repo's pull requests [**repoListPullReviews**](RepositoryApi.md#repoListPullReviews) | **GET** /repos/{owner}/{repo}/pulls/{index}/reviews | List all reviews for a pull request [**repoListReleaseAttachments**](RepositoryApi.md#repoListReleaseAttachments) | **GET** /repos/{owner}/{repo}/releases/{id}/assets | List release's attachments [**repoListReleases**](RepositoryApi.md#repoListReleases) | **GET** /repos/{owner}/{repo}/releases | List a repo's releases [**repoListStargazers**](RepositoryApi.md#repoListStargazers) | **GET** /repos/{owner}/{repo}/stargazers | List a repo's stargazers [**repoListStatuses**](RepositoryApi.md#repoListStatuses) | **GET** /repos/{owner}/{repo}/statuses/{sha} | Get a commit's statuses [**repoListStatusesByRef**](RepositoryApi.md#repoListStatusesByRef) | **GET** /repos/{owner}/{repo}/commits/{ref}/statuses | Get a commit's statuses, by branch/tag/commit reference [**repoListSubscribers**](RepositoryApi.md#repoListSubscribers) | **GET** /repos/{owner}/{repo}/subscribers | List a repo's watchers [**repoListTags**](RepositoryApi.md#repoListTags) | **GET** /repos/{owner}/{repo}/tags | List a repository's tags [**repoListTopics**](RepositoryApi.md#repoListTopics) | **GET** /repos/{owner}/{repo}/topics | Get list of topics that a repository has [**repoMergePullRequest**](RepositoryApi.md#repoMergePullRequest) | **POST** /repos/{owner}/{repo}/pulls/{index}/merge | Merge a pull request [**repoMigrate**](RepositoryApi.md#repoMigrate) | **POST** /repos/migrate | Migrate a remote git repository [**repoMirrorSync**](RepositoryApi.md#repoMirrorSync) | **POST** /repos/{owner}/{repo}/mirror-sync | Sync a mirrored repository [**repoPullRequestIsMerged**](RepositoryApi.md#repoPullRequestIsMerged) | **GET** /repos/{owner}/{repo}/pulls/{index}/merge | Check if a pull request has been merged [**repoSearch**](RepositoryApi.md#repoSearch) | **GET** /repos/search | Search for repositories [**repoSigningKey**](RepositoryApi.md#repoSigningKey) | **GET** /repos/{owner}/{repo}/signing-key.gpg | Get signing-key.gpg for given repository [**repoSubmitPullReview**](RepositoryApi.md#repoSubmitPullReview) | **POST** /repos/{owner}/{repo}/pulls/{index}/reviews/{id} | Submit a pending review to an pull request [**repoTestHook**](RepositoryApi.md#repoTestHook) | **POST** /repos/{owner}/{repo}/hooks/{id}/tests | Test a push webhook [**repoTrackedTimes**](RepositoryApi.md#repoTrackedTimes) | **GET** /repos/{owner}/{repo}/times | List a repo's tracked times [**repoTransfer**](RepositoryApi.md#repoTransfer) | **POST** /repos/{owner}/{repo}/transfer | Transfer a repo ownership [**repoUpdateFile**](RepositoryApi.md#repoUpdateFile) | **PUT** /repos/{owner}/{repo}/contents/{filepath} | Update a file in a repository [**repoUpdatePullRequest**](RepositoryApi.md#repoUpdatePullRequest) | **POST** /repos/{owner}/{repo}/pulls/{index}/update | Merge PR's baseBranch into headBranch [**repoUpdateTopics**](RepositoryApi.md#repoUpdateTopics) | **PUT** /repos/{owner}/{repo}/topics | Replace list of topics for a repository [**topicSearch**](RepositoryApi.md#topicSearch) | **GET** /topics/search | search topics via keyword [**userCurrentCheckSubscription**](RepositoryApi.md#userCurrentCheckSubscription) | **GET** /repos/{owner}/{repo}/subscription | Check if the current user is watching a repo [**userCurrentDeleteSubscription**](RepositoryApi.md#userCurrentDeleteSubscription) | **DELETE** /repos/{owner}/{repo}/subscription | Unwatch a repo [**userCurrentPutSubscription**](RepositoryApi.md#userCurrentPutSubscription) | **PUT** /repos/{owner}/{repo}/subscription | Watch a repo [**userTrackedTimes**](RepositoryApi.md#userTrackedTimes) | **GET** /repos/{owner}/{repo}/times/{user} | List a user's tracked times in a repo # **createCurrentUserRepo** > Repository createCurrentUserRepo(body) Create a repository ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); CreateRepoOption body = new CreateRepoOption(); // CreateRepoOption | try { Repository result = apiInstance.createCurrentUserRepo(body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#createCurrentUserRepo"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**CreateRepoOption**](CreateRepoOption.md)| | [optional] ### Return type [**Repository**](Repository.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Repository | - | **409** | The repository with the same name already exists. | - | **422** | APIValidationError is error format response related to input validation | * message -
* url -
| # **createFork** > Repository createFork(owner, repo, body) Fork a repository ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo to fork String repo = "repo_example"; // String | name of the repo to fork CreateForkOption body = new CreateForkOption(); // CreateForkOption | try { Repository result = apiInstance.createFork(owner, repo, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#createFork"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo to fork | **repo** | **String**| name of the repo to fork | **body** | [**CreateForkOption**](CreateForkOption.md)| | [optional] ### Return type [**Repository**](Repository.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **202** | Repository | - | **403** | APIForbiddenError is a forbidden error response | * message -
* url -
| **422** | APIValidationError is error format response related to input validation | * message -
* url -
| # **getBlob** > GitBlobResponse getBlob(owner, repo, sha) Gets the blob of a repository. ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String sha = "sha_example"; // String | sha of the commit try { GitBlobResponse result = apiInstance.getBlob(owner, repo, sha); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#getBlob"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **sha** | **String**| sha of the commit | ### Return type [**GitBlobResponse**](GitBlobResponse.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | GitBlobResponse | - | **400** | APIError is error format response | * message -
* url -
| # **getTag** > AnnotatedTag getTag(owner, repo, sha) Gets the tag object of an annotated tag (not lightweight tags) ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String sha = "sha_example"; // String | sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags. try { AnnotatedTag result = apiInstance.getTag(owner, repo, sha); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#getTag"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **sha** | **String**| sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags. | ### Return type [**AnnotatedTag**](AnnotatedTag.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | AnnotatedTag | - | **400** | APIError is error format response | * message -
* url -
| # **getTree** > GitTreeResponse getTree(owner, repo, sha, recursive, page, perPage) Gets the tree of a repository. ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String sha = "sha_example"; // String | sha of the commit Boolean recursive = true; // Boolean | show all directories and files Integer page = 56; // Integer | page number; the 'truncated' field in the response will be true if there are still more items after this page, false if the last page Integer perPage = 56; // Integer | number of items per page try { GitTreeResponse result = apiInstance.getTree(owner, repo, sha, recursive, page, perPage); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#getTree"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **sha** | **String**| sha of the commit | **recursive** | **Boolean**| show all directories and files | [optional] **page** | **Integer**| page number; the 'truncated' field in the response will be true if there are still more items after this page, false if the last page | [optional] **perPage** | **Integer**| number of items per page | [optional] ### Return type [**GitTreeResponse**](GitTreeResponse.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | GitTreeResponse | - | **400** | APIError is error format response | * message -
* url -
| # **listForks** > List<Repository> listForks(owner, repo, page, limit) List a repository's forks ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Integer page = 56; // Integer | page number of results to return (1-based) Integer limit = 56; // Integer | page size of results try { List result = apiInstance.listForks(owner, repo, page, limit); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#listForks"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **page** | **Integer**| page number of results to return (1-based) | [optional] **limit** | **Integer**| page size of results | [optional] ### Return type [**List<Repository>**](Repository.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | RepositoryList | - | # **repoAddCollaborator** > repoAddCollaborator(owner, repo, collaborator, body) Add a collaborator to a repository ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String collaborator = "collaborator_example"; // String | username of the collaborator to add AddCollaboratorOption body = new AddCollaboratorOption(); // AddCollaboratorOption | try { apiInstance.repoAddCollaborator(owner, repo, collaborator, body); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoAddCollaborator"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **collaborator** | **String**| username of the collaborator to add | **body** | [**AddCollaboratorOption**](AddCollaboratorOption.md)| | [optional] ### Return type null (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | APIEmpty is an empty response | - | **422** | APIValidationError is error format response related to input validation | * message -
* url -
| # **repoAddTopc** > repoAddTopc(owner, repo, topic) Add a topic to a repository ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String topic = "topic_example"; // String | name of the topic to add try { apiInstance.repoAddTopc(owner, repo, topic); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoAddTopc"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **topic** | **String**| name of the topic to add | ### Return type null (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | APIEmpty is an empty response | - | **422** | APIInvalidTopicsError is error format response to invalid topics | * invalidTopics -
* message -
| # **repoCheckCollaborator** > repoCheckCollaborator(owner, repo, collaborator) Check if a user is a collaborator of a repository ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String collaborator = "collaborator_example"; // String | username of the collaborator try { apiInstance.repoCheckCollaborator(owner, repo, collaborator); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoCheckCollaborator"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **collaborator** | **String**| username of the collaborator | ### Return type null (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | APIEmpty is an empty response | - | **404** | APINotFound is a not found empty response | - | **422** | APIValidationError is error format response related to input validation | * message -
* url -
| # **repoCreateBranch** > Branch repoCreateBranch(owner, repo, body) Create a branch ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo CreateBranchRepoOption body = new CreateBranchRepoOption(); // CreateBranchRepoOption | try { Branch result = apiInstance.repoCreateBranch(owner, repo, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoCreateBranch"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **body** | [**CreateBranchRepoOption**](CreateBranchRepoOption.md)| | [optional] ### Return type [**Branch**](Branch.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Branch | - | **404** | The old branch does not exist. | - | **409** | The branch with the same name already exists. | - | # **repoCreateBranchProtection** > BranchProtection repoCreateBranchProtection(owner, repo, body) Create a branch protections for a repository ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo CreateBranchProtectionOption body = new CreateBranchProtectionOption(); // CreateBranchProtectionOption | try { BranchProtection result = apiInstance.repoCreateBranchProtection(owner, repo, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoCreateBranchProtection"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **body** | [**CreateBranchProtectionOption**](CreateBranchProtectionOption.md)| | [optional] ### Return type [**BranchProtection**](BranchProtection.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | BranchProtection | - | **403** | APIForbiddenError is a forbidden error response | * message -
* url -
| **404** | APINotFound is a not found empty response | - | **422** | APIValidationError is error format response related to input validation | * message -
* url -
| # **repoCreateFile** > FileResponse repoCreateFile(owner, repo, filepath, body) Create a file in a repository ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String filepath = "filepath_example"; // String | path of the file to create CreateFileOptions body = new CreateFileOptions(); // CreateFileOptions | try { FileResponse result = apiInstance.repoCreateFile(owner, repo, filepath, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoCreateFile"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **filepath** | **String**| path of the file to create | **body** | [**CreateFileOptions**](CreateFileOptions.md)| | ### Return type [**FileResponse**](FileResponse.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | FileResponse | - | **403** | APIError is error format response | * message -
* url -
| **404** | APINotFound is a not found empty response | - | **422** | APIError is error format response | * message -
* url -
| # **repoCreateHook** > Hook repoCreateHook(owner, repo, body) Create a hook ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo CreateHookOption body = new CreateHookOption(); // CreateHookOption | try { Hook result = apiInstance.repoCreateHook(owner, repo, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoCreateHook"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **body** | [**CreateHookOption**](CreateHookOption.md)| | [optional] ### Return type [**Hook**](Hook.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Hook | - | # **repoCreateKey** > DeployKey repoCreateKey(owner, repo, body) Add a key to a repository ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo CreateKeyOption body = new CreateKeyOption(); // CreateKeyOption | try { DeployKey result = apiInstance.repoCreateKey(owner, repo, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoCreateKey"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **body** | [**CreateKeyOption**](CreateKeyOption.md)| | [optional] ### Return type [**DeployKey**](DeployKey.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | DeployKey | - | **422** | APIValidationError is error format response related to input validation | * message -
* url -
| # **repoCreatePullRequest** > PullRequest repoCreatePullRequest(owner, repo, body) Create a pull request ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo CreatePullRequestOption body = new CreatePullRequestOption(); // CreatePullRequestOption | try { PullRequest result = apiInstance.repoCreatePullRequest(owner, repo, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoCreatePullRequest"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **body** | [**CreatePullRequestOption**](CreatePullRequestOption.md)| | [optional] ### Return type [**PullRequest**](PullRequest.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | PullRequest | - | **409** | APIError is error format response | * message -
* url -
| **422** | APIValidationError is error format response related to input validation | * message -
* url -
| # **repoCreatePullReview** > PullReview repoCreatePullReview(owner, repo, index, body) Create a review to an pull request ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Long index = 56L; // Long | index of the pull request CreatePullReviewOptions body = new CreatePullReviewOptions(); // CreatePullReviewOptions | try { PullReview result = apiInstance.repoCreatePullReview(owner, repo, index, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoCreatePullReview"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **index** | **Long**| index of the pull request | **body** | [**CreatePullReviewOptions**](CreatePullReviewOptions.md)| | ### Return type [**PullReview**](PullReview.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | PullReview | - | **404** | APINotFound is a not found empty response | - | **422** | APIValidationError is error format response related to input validation | * message -
* url -
| # **repoCreateRelease** > Release repoCreateRelease(owner, repo, body) Create a release ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo CreateReleaseOption body = new CreateReleaseOption(); // CreateReleaseOption | try { Release result = apiInstance.repoCreateRelease(owner, repo, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoCreateRelease"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **body** | [**CreateReleaseOption**](CreateReleaseOption.md)| | [optional] ### Return type [**Release**](Release.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Release | - | **404** | APINotFound is a not found empty response | - | **409** | APIError is error format response | * message -
* url -
| # **repoCreateReleaseAttachment** > Attachment repoCreateReleaseAttachment(owner, repo, id, attachment, name) Create a release attachment ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Long id = 56L; // Long | id of the release File attachment = new File("/path/to/file"); // File | attachment to upload String name = "name_example"; // String | name of the attachment try { Attachment result = apiInstance.repoCreateReleaseAttachment(owner, repo, id, attachment, name); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoCreateReleaseAttachment"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **id** | **Long**| id of the release | **attachment** | **File**| attachment to upload | **name** | **String**| name of the attachment | [optional] ### Return type [**Attachment**](Attachment.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: multipart/form-data - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Attachment | - | **400** | APIError is error format response | * message -
* url -
| # **repoCreateStatus** > Status repoCreateStatus(owner, repo, sha, body) Create a commit status ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String sha = "sha_example"; // String | sha of the commit CreateStatusOption body = new CreateStatusOption(); // CreateStatusOption | try { Status result = apiInstance.repoCreateStatus(owner, repo, sha, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoCreateStatus"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **sha** | **String**| sha of the commit | **body** | [**CreateStatusOption**](CreateStatusOption.md)| | [optional] ### Return type [**Status**](Status.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Status | - | **400** | APIError is error format response | * message -
* url -
| # **repoDelete** > repoDelete(owner, repo) Delete a repository ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo to delete String repo = "repo_example"; // String | name of the repo to delete try { apiInstance.repoDelete(owner, repo); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoDelete"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo to delete | **repo** | **String**| name of the repo to delete | ### Return type null (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | APIEmpty is an empty response | - | **403** | APIForbiddenError is a forbidden error response | * message -
* url -
| # **repoDeleteBranch** > repoDeleteBranch(owner, repo, branch) Delete a specific branch from a repository ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String branch = "branch_example"; // String | branch to delete try { apiInstance.repoDeleteBranch(owner, repo, branch); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoDeleteBranch"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **branch** | **String**| branch to delete | ### Return type null (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | APIEmpty is an empty response | - | **403** | APIError is error format response | * message -
* url -
| **404** | APINotFound is a not found empty response | - | # **repoDeleteBranchProtection** > repoDeleteBranchProtection(owner, repo, name) Delete a specific branch protection for the repository ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String name = "name_example"; // String | name of protected branch try { apiInstance.repoDeleteBranchProtection(owner, repo, name); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoDeleteBranchProtection"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **name** | **String**| name of protected branch | ### Return type null (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | APIEmpty is an empty response | - | **404** | APINotFound is a not found empty response | - | # **repoDeleteCollaborator** > repoDeleteCollaborator(owner, repo, collaborator) Delete a collaborator from a repository ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String collaborator = "collaborator_example"; // String | username of the collaborator to delete try { apiInstance.repoDeleteCollaborator(owner, repo, collaborator); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoDeleteCollaborator"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **collaborator** | **String**| username of the collaborator to delete | ### Return type null (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | APIEmpty is an empty response | - | **422** | APIValidationError is error format response related to input validation | * message -
* url -
| # **repoDeleteFile** > FileDeleteResponse repoDeleteFile(owner, repo, filepath, body) Delete a file in a repository ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String filepath = "filepath_example"; // String | path of the file to delete DeleteFileOptions body = new DeleteFileOptions(); // DeleteFileOptions | try { FileDeleteResponse result = apiInstance.repoDeleteFile(owner, repo, filepath, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoDeleteFile"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **filepath** | **String**| path of the file to delete | **body** | [**DeleteFileOptions**](DeleteFileOptions.md)| | ### Return type [**FileDeleteResponse**](FileDeleteResponse.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | FileDeleteResponse | - | **400** | APIError is error format response | * message -
* url -
| **403** | APIError is error format response | * message -
* url -
| **404** | APIError is error format response | * message -
* url -
| # **repoDeleteGitHook** > repoDeleteGitHook(owner, repo, id) Delete a Git hook in a repository ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String id = "id_example"; // String | id of the hook to get try { apiInstance.repoDeleteGitHook(owner, repo, id); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoDeleteGitHook"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **id** | **String**| id of the hook to get | ### Return type null (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | APIEmpty is an empty response | - | **404** | APINotFound is a not found empty response | - | # **repoDeleteHook** > repoDeleteHook(owner, repo, id) Delete a hook in a repository ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Long id = 56L; // Long | id of the hook to delete try { apiInstance.repoDeleteHook(owner, repo, id); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoDeleteHook"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **id** | **Long**| id of the hook to delete | ### Return type null (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | APIEmpty is an empty response | - | **404** | APINotFound is a not found empty response | - | # **repoDeleteKey** > repoDeleteKey(owner, repo, id) Delete a key from a repository ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Long id = 56L; // Long | id of the key to delete try { apiInstance.repoDeleteKey(owner, repo, id); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoDeleteKey"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **id** | **Long**| id of the key to delete | ### Return type null (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | APIEmpty is an empty response | - | **403** | APIForbiddenError is a forbidden error response | * message -
* url -
| # **repoDeletePullReview** > repoDeletePullReview(owner, repo, index, id) Delete a specific review from a pull request ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Long index = 56L; // Long | index of the pull request Long id = 56L; // Long | id of the review try { apiInstance.repoDeletePullReview(owner, repo, index, id); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoDeletePullReview"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **index** | **Long**| index of the pull request | **id** | **Long**| id of the review | ### Return type null (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | APIEmpty is an empty response | - | **403** | APIForbiddenError is a forbidden error response | * message -
* url -
| **404** | APINotFound is a not found empty response | - | # **repoDeleteRelease** > repoDeleteRelease(owner, repo, id) Delete a release ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Long id = 56L; // Long | id of the release to delete try { apiInstance.repoDeleteRelease(owner, repo, id); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoDeleteRelease"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **id** | **Long**| id of the release to delete | ### Return type null (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | APIEmpty is an empty response | - | **404** | APINotFound is a not found empty response | - | # **repoDeleteReleaseAttachment** > repoDeleteReleaseAttachment(owner, repo, id, attachmentId) Delete a release attachment ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Long id = 56L; // Long | id of the release Long attachmentId = 56L; // Long | id of the attachment to delete try { apiInstance.repoDeleteReleaseAttachment(owner, repo, id, attachmentId); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoDeleteReleaseAttachment"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **id** | **Long**| id of the release | **attachmentId** | **Long**| id of the attachment to delete | ### Return type null (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | APIEmpty is an empty response | - | # **repoDeleteTopic** > repoDeleteTopic(owner, repo, topic) Delete a topic from a repository ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String topic = "topic_example"; // String | name of the topic to delete try { apiInstance.repoDeleteTopic(owner, repo, topic); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoDeleteTopic"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **topic** | **String**| name of the topic to delete | ### Return type null (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | APIEmpty is an empty response | - | **422** | APIInvalidTopicsError is error format response to invalid topics | * invalidTopics -
* message -
| # **repoDownloadPullDiff** > String repoDownloadPullDiff(owner, repo, index) Get a pull request diff ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Long index = 56L; // Long | index of the pull request to get try { String result = apiInstance.repoDownloadPullDiff(owner, repo, index); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoDownloadPullDiff"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **index** | **Long**| index of the pull request to get | ### Return type **String** ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: text/plain ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | APIString is a string response | - | **404** | APINotFound is a not found empty response | - | # **repoDownloadPullPatch** > String repoDownloadPullPatch(owner, repo, index) Get a pull request patch file ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Long index = 56L; // Long | index of the pull request to get try { String result = apiInstance.repoDownloadPullPatch(owner, repo, index); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoDownloadPullPatch"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **index** | **Long**| index of the pull request to get | ### Return type **String** ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: text/plain ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | APIString is a string response | - | **404** | APINotFound is a not found empty response | - | # **repoEdit** > Repository repoEdit(owner, repo, body) Edit a repository's properties. Only fields that are set will be changed. ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo to edit String repo = "repo_example"; // String | name of the repo to edit EditRepoOption body = new EditRepoOption(); // EditRepoOption | Properties of a repo that you can edit try { Repository result = apiInstance.repoEdit(owner, repo, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoEdit"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo to edit | **repo** | **String**| name of the repo to edit | **body** | [**EditRepoOption**](EditRepoOption.md)| Properties of a repo that you can edit | [optional] ### Return type [**Repository**](Repository.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Repository | - | **403** | APIForbiddenError is a forbidden error response | * message -
* url -
| **422** | APIValidationError is error format response related to input validation | * message -
* url -
| # **repoEditBranchProtection** > BranchProtection repoEditBranchProtection(owner, repo, name, body) Edit a branch protections for a repository. Only fields that are set will be changed ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String name = "name_example"; // String | name of protected branch EditBranchProtectionOption body = new EditBranchProtectionOption(); // EditBranchProtectionOption | try { BranchProtection result = apiInstance.repoEditBranchProtection(owner, repo, name, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoEditBranchProtection"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **name** | **String**| name of protected branch | **body** | [**EditBranchProtectionOption**](EditBranchProtectionOption.md)| | [optional] ### Return type [**BranchProtection**](BranchProtection.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | BranchProtection | - | **404** | APINotFound is a not found empty response | - | **422** | APIValidationError is error format response related to input validation | * message -
* url -
| # **repoEditGitHook** > GitHook repoEditGitHook(owner, repo, id, body) Edit a Git hook in a repository ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String id = "id_example"; // String | id of the hook to get EditGitHookOption body = new EditGitHookOption(); // EditGitHookOption | try { GitHook result = apiInstance.repoEditGitHook(owner, repo, id, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoEditGitHook"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **id** | **String**| id of the hook to get | **body** | [**EditGitHookOption**](EditGitHookOption.md)| | [optional] ### Return type [**GitHook**](GitHook.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | GitHook | - | **404** | APINotFound is a not found empty response | - | # **repoEditHook** > Hook repoEditHook(owner, repo, id, body) Edit a hook in a repository ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Long id = 56L; // Long | index of the hook EditHookOption body = new EditHookOption(); // EditHookOption | try { Hook result = apiInstance.repoEditHook(owner, repo, id, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoEditHook"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **id** | **Long**| index of the hook | **body** | [**EditHookOption**](EditHookOption.md)| | [optional] ### Return type [**Hook**](Hook.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Hook | - | # **repoEditPullRequest** > PullRequest repoEditPullRequest(owner, repo, index, body) Update a pull request. If using deadline only the date will be taken into account, and time of day ignored. ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Long index = 56L; // Long | index of the pull request to edit EditPullRequestOption body = new EditPullRequestOption(); // EditPullRequestOption | try { PullRequest result = apiInstance.repoEditPullRequest(owner, repo, index, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoEditPullRequest"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **index** | **Long**| index of the pull request to edit | **body** | [**EditPullRequestOption**](EditPullRequestOption.md)| | [optional] ### Return type [**PullRequest**](PullRequest.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | PullRequest | - | **403** | APIForbiddenError is a forbidden error response | * message -
* url -
| **409** | APIError is error format response | * message -
* url -
| **412** | APIError is error format response | * message -
* url -
| **422** | APIValidationError is error format response related to input validation | * message -
* url -
| # **repoEditRelease** > Release repoEditRelease(owner, repo, id, body) Update a release ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Long id = 56L; // Long | id of the release to edit EditReleaseOption body = new EditReleaseOption(); // EditReleaseOption | try { Release result = apiInstance.repoEditRelease(owner, repo, id, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoEditRelease"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **id** | **Long**| id of the release to edit | **body** | [**EditReleaseOption**](EditReleaseOption.md)| | [optional] ### Return type [**Release**](Release.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Release | - | **404** | APINotFound is a not found empty response | - | # **repoEditReleaseAttachment** > Attachment repoEditReleaseAttachment(owner, repo, id, attachmentId, body) Edit a release attachment ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Long id = 56L; // Long | id of the release Long attachmentId = 56L; // Long | id of the attachment to edit EditAttachmentOptions body = new EditAttachmentOptions(); // EditAttachmentOptions | try { Attachment result = apiInstance.repoEditReleaseAttachment(owner, repo, id, attachmentId, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoEditReleaseAttachment"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **id** | **Long**| id of the release | **attachmentId** | **Long**| id of the attachment to edit | **body** | [**EditAttachmentOptions**](EditAttachmentOptions.md)| | [optional] ### Return type [**Attachment**](Attachment.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Attachment | - | # **repoGet** > Repository repoGet(owner, repo) Get a repository ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo try { Repository result = apiInstance.repoGet(owner, repo); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoGet"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | ### Return type [**Repository**](Repository.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Repository | - | # **repoGetAllCommits** > List<Commit> repoGetAllCommits(owner, repo, sha, page, limit) Get a list of all commits from a repository ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String sha = "sha_example"; // String | SHA or branch to start listing commits from (usually 'master') Integer page = 56; // Integer | page number of results to return (1-based) Integer limit = 56; // Integer | page size of results try { List result = apiInstance.repoGetAllCommits(owner, repo, sha, page, limit); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoGetAllCommits"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **sha** | **String**| SHA or branch to start listing commits from (usually 'master') | [optional] **page** | **Integer**| page number of results to return (1-based) | [optional] **limit** | **Integer**| page size of results | [optional] ### Return type [**List<Commit>**](Commit.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | CommitList | * X-HasMore - True if there is another page
* X-PageCount - Total number of pages
* X-PerPage - Commits per page
* X-Total - Total commit count
* X-Page - The current page
| **404** | APINotFound is a not found empty response | - | **409** | EmptyRepository | - | # **repoGetArchive** > repoGetArchive(owner, repo, archive) Get an archive of a repository ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String archive = "archive_example"; // String | the git reference for download with attached archive format (e.g. master.zip) try { apiInstance.repoGetArchive(owner, repo, archive); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoGetArchive"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **archive** | **String**| the git reference for download with attached archive format (e.g. master.zip) | ### Return type null (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | success | - | **404** | APINotFound is a not found empty response | - | # **repoGetBranch** > Branch repoGetBranch(owner, repo, branch) Retrieve a specific branch from a repository, including its effective branch protection ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String branch = "branch_example"; // String | branch to get try { Branch result = apiInstance.repoGetBranch(owner, repo, branch); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoGetBranch"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **branch** | **String**| branch to get | ### Return type [**Branch**](Branch.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Branch | - | **404** | APINotFound is a not found empty response | - | # **repoGetBranchProtection** > BranchProtection repoGetBranchProtection(owner, repo, name) Get a specific branch protection for the repository ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String name = "name_example"; // String | name of protected branch try { BranchProtection result = apiInstance.repoGetBranchProtection(owner, repo, name); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoGetBranchProtection"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **name** | **String**| name of protected branch | ### Return type [**BranchProtection**](BranchProtection.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | BranchProtection | - | **404** | APINotFound is a not found empty response | - | # **repoGetByID** > Repository repoGetByID(id) Get a repository by id ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); Long id = 56L; // Long | id of the repo to get try { Repository result = apiInstance.repoGetByID(id); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoGetByID"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Long**| id of the repo to get | ### Return type [**Repository**](Repository.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Repository | - | # **repoGetCombinedStatusByRef** > CombinedStatus repoGetCombinedStatusByRef(owner, repo, ref, page) Get a commit's combined status, by branch/tag/commit reference ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String ref = "ref_example"; // String | name of branch/tag/commit Integer page = 56; // Integer | page number of results try { CombinedStatus result = apiInstance.repoGetCombinedStatusByRef(owner, repo, ref, page); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoGetCombinedStatusByRef"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **ref** | **String**| name of branch/tag/commit | **page** | **Integer**| page number of results | [optional] ### Return type [**CombinedStatus**](CombinedStatus.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | CombinedStatus | - | **400** | APIError is error format response | * message -
* url -
| # **repoGetContents** > ContentsResponse repoGetContents(owner, repo, filepath, ref) Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String filepath = "filepath_example"; // String | path of the dir, file, symlink or submodule in the repo String ref = "ref_example"; // String | The name of the commit/branch/tag. Default the repository’s default branch (usually master) try { ContentsResponse result = apiInstance.repoGetContents(owner, repo, filepath, ref); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoGetContents"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **filepath** | **String**| path of the dir, file, symlink or submodule in the repo | **ref** | **String**| The name of the commit/branch/tag. Default the repository’s default branch (usually master) | [optional] ### Return type [**ContentsResponse**](ContentsResponse.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | ContentsResponse | - | **404** | APINotFound is a not found empty response | - | # **repoGetContentsList** > List<ContentsResponse> repoGetContentsList(owner, repo, ref) Gets the metadata of all the entries of the root dir ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String ref = "ref_example"; // String | The name of the commit/branch/tag. Default the repository’s default branch (usually master) try { List result = apiInstance.repoGetContentsList(owner, repo, ref); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoGetContentsList"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **ref** | **String**| The name of the commit/branch/tag. Default the repository’s default branch (usually master) | [optional] ### Return type [**List<ContentsResponse>**](ContentsResponse.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | ContentsListResponse | - | **404** | APINotFound is a not found empty response | - | # **repoGetEditorConfig** > repoGetEditorConfig(owner, repo, filepath) Get the EditorConfig definitions of a file in a repository ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String filepath = "filepath_example"; // String | filepath of file to get try { apiInstance.repoGetEditorConfig(owner, repo, filepath); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoGetEditorConfig"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **filepath** | **String**| filepath of file to get | ### Return type null (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | success | - | **404** | APINotFound is a not found empty response | - | # **repoGetGitHook** > GitHook repoGetGitHook(owner, repo, id) Get a Git hook ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String id = "id_example"; // String | id of the hook to get try { GitHook result = apiInstance.repoGetGitHook(owner, repo, id); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoGetGitHook"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **id** | **String**| id of the hook to get | ### Return type [**GitHook**](GitHook.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | GitHook | - | **404** | APINotFound is a not found empty response | - | # **repoGetHook** > Hook repoGetHook(owner, repo, id) Get a hook ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Long id = 56L; // Long | id of the hook to get try { Hook result = apiInstance.repoGetHook(owner, repo, id); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoGetHook"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **id** | **Long**| id of the hook to get | ### Return type [**Hook**](Hook.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Hook | - | **404** | APINotFound is a not found empty response | - | # **repoGetIssueTemplates** > List<IssueTemplate> repoGetIssueTemplates(owner, repo) Get available issue templates for a repository ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo try { List result = apiInstance.repoGetIssueTemplates(owner, repo); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoGetIssueTemplates"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | ### Return type [**List<IssueTemplate>**](IssueTemplate.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | IssueTemplates | - | # **repoGetKey** > DeployKey repoGetKey(owner, repo, id) Get a repository's key by id ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Long id = 56L; // Long | id of the key to get try { DeployKey result = apiInstance.repoGetKey(owner, repo, id); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoGetKey"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **id** | **Long**| id of the key to get | ### Return type [**DeployKey**](DeployKey.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | DeployKey | - | # **repoGetLanguages** > Map<String, Long> repoGetLanguages(owner, repo) Get languages and number of bytes of code written ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo try { Map result = apiInstance.repoGetLanguages(owner, repo); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoGetLanguages"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | ### Return type **Map<String, Long>** ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | LanguageStatistics | - | **404** | APINotFound is a not found empty response | - | # **repoGetPullRequest** > PullRequest repoGetPullRequest(owner, repo, index) Get a pull request ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Long index = 56L; // Long | index of the pull request to get try { PullRequest result = apiInstance.repoGetPullRequest(owner, repo, index); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoGetPullRequest"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **index** | **Long**| index of the pull request to get | ### Return type [**PullRequest**](PullRequest.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | PullRequest | - | **404** | APINotFound is a not found empty response | - | # **repoGetPullReview** > PullReview repoGetPullReview(owner, repo, index, id) Get a specific review for a pull request ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Long index = 56L; // Long | index of the pull request Long id = 56L; // Long | id of the review try { PullReview result = apiInstance.repoGetPullReview(owner, repo, index, id); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoGetPullReview"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **index** | **Long**| index of the pull request | **id** | **Long**| id of the review | ### Return type [**PullReview**](PullReview.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | PullReview | - | **404** | APINotFound is a not found empty response | - | # **repoGetPullReviewComments** > List<PullReviewComment> repoGetPullReviewComments(owner, repo, index, id) Get a specific review for a pull request ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Long index = 56L; // Long | index of the pull request Long id = 56L; // Long | id of the review try { List result = apiInstance.repoGetPullReviewComments(owner, repo, index, id); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoGetPullReviewComments"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **index** | **Long**| index of the pull request | **id** | **Long**| id of the review | ### Return type [**List<PullReviewComment>**](PullReviewComment.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | PullCommentList | - | **404** | APINotFound is a not found empty response | - | # **repoGetRawFile** > repoGetRawFile(owner, repo, filepath) Get a file from a repository ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String filepath = "filepath_example"; // String | filepath of the file to get try { apiInstance.repoGetRawFile(owner, repo, filepath); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoGetRawFile"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **filepath** | **String**| filepath of the file to get | ### Return type null (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | success | - | **404** | APINotFound is a not found empty response | - | # **repoGetRelease** > Release repoGetRelease(owner, repo, id) Get a release ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Long id = 56L; // Long | id of the release to get try { Release result = apiInstance.repoGetRelease(owner, repo, id); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoGetRelease"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **id** | **Long**| id of the release to get | ### Return type [**Release**](Release.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Release | - | **404** | APINotFound is a not found empty response | - | # **repoGetReleaseAttachment** > Attachment repoGetReleaseAttachment(owner, repo, id, attachmentId) Get a release attachment ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Long id = 56L; // Long | id of the release Long attachmentId = 56L; // Long | id of the attachment to get try { Attachment result = apiInstance.repoGetReleaseAttachment(owner, repo, id, attachmentId); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoGetReleaseAttachment"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **id** | **Long**| id of the release | **attachmentId** | **Long**| id of the attachment to get | ### Return type [**Attachment**](Attachment.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Attachment | - | # **repoGetReleaseTag** > Release repoGetReleaseTag(owner, repo, tag) Get a release by tag name ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String tag = "tag_example"; // String | tagname of the release to get try { Release result = apiInstance.repoGetReleaseTag(owner, repo, tag); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoGetReleaseTag"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **tag** | **String**| tagname of the release to get | ### Return type [**Release**](Release.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Release | - | **404** | APINotFound is a not found empty response | - | # **repoGetSingleCommit** > Commit repoGetSingleCommit(owner, repo, sha) Get a single commit from a repository ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String sha = "sha_example"; // String | a git ref or commit sha try { Commit result = apiInstance.repoGetSingleCommit(owner, repo, sha); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoGetSingleCommit"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **sha** | **String**| a git ref or commit sha | ### Return type [**Commit**](Commit.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Commit | - | **404** | APINotFound is a not found empty response | - | **422** | APIValidationError is error format response related to input validation | * message -
* url -
| # **repoListAllGitRefs** > List<Reference> repoListAllGitRefs(owner, repo) Get specified ref or filtered repository's refs ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo try { List result = apiInstance.repoListAllGitRefs(owner, repo); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoListAllGitRefs"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | ### Return type [**List<Reference>**](Reference.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | ReferenceList | - | **404** | APINotFound is a not found empty response | - | # **repoListBranchProtection** > List<BranchProtection> repoListBranchProtection(owner, repo) List branch protections for a repository ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo try { List result = apiInstance.repoListBranchProtection(owner, repo); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoListBranchProtection"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | ### Return type [**List<BranchProtection>**](BranchProtection.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | BranchProtectionList | - | # **repoListBranches** > List<Branch> repoListBranches(owner, repo) List a repository's branches ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo try { List result = apiInstance.repoListBranches(owner, repo); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoListBranches"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | ### Return type [**List<Branch>**](Branch.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | BranchList | - | # **repoListCollaborators** > List<User> repoListCollaborators(owner, repo, page, limit) List a repository's collaborators ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Integer page = 56; // Integer | page number of results to return (1-based) Integer limit = 56; // Integer | page size of results try { List result = apiInstance.repoListCollaborators(owner, repo, page, limit); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoListCollaborators"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **page** | **Integer**| page number of results to return (1-based) | [optional] **limit** | **Integer**| page size of results | [optional] ### Return type [**List<User>**](User.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | UserList | - | # **repoListGitHooks** > List<GitHook> repoListGitHooks(owner, repo) List the Git hooks in a repository ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo try { List result = apiInstance.repoListGitHooks(owner, repo); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoListGitHooks"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | ### Return type [**List<GitHook>**](GitHook.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | GitHookList | - | # **repoListGitRefs** > List<Reference> repoListGitRefs(owner, repo, ref) Get specified ref or filtered repository's refs ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String ref = "ref_example"; // String | part or full name of the ref try { List result = apiInstance.repoListGitRefs(owner, repo, ref); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoListGitRefs"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **ref** | **String**| part or full name of the ref | ### Return type [**List<Reference>**](Reference.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | ReferenceList | - | **404** | APINotFound is a not found empty response | - | # **repoListHooks** > List<Hook> repoListHooks(owner, repo, page, limit) List the hooks in a repository ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Integer page = 56; // Integer | page number of results to return (1-based) Integer limit = 56; // Integer | page size of results try { List result = apiInstance.repoListHooks(owner, repo, page, limit); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoListHooks"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **page** | **Integer**| page number of results to return (1-based) | [optional] **limit** | **Integer**| page size of results | [optional] ### Return type [**List<Hook>**](Hook.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | HookList | - | # **repoListKeys** > List<DeployKey> repoListKeys(owner, repo, keyId, fingerprint, page, limit) List a repository's keys ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Integer keyId = 56; // Integer | the key_id to search for String fingerprint = "fingerprint_example"; // String | fingerprint of the key Integer page = 56; // Integer | page number of results to return (1-based) Integer limit = 56; // Integer | page size of results try { List result = apiInstance.repoListKeys(owner, repo, keyId, fingerprint, page, limit); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoListKeys"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **keyId** | **Integer**| the key_id to search for | [optional] **fingerprint** | **String**| fingerprint of the key | [optional] **page** | **Integer**| page number of results to return (1-based) | [optional] **limit** | **Integer**| page size of results | [optional] ### Return type [**List<DeployKey>**](DeployKey.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | DeployKeyList | - | # **repoListPullRequests** > List<PullRequest> repoListPullRequests(owner, repo, state, sort, milestone, labels, page, limit) List a repo's pull requests ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String state = "state_example"; // String | State of pull request: open or closed (optional) String sort = "sort_example"; // String | Type of sort Long milestone = 56L; // Long | ID of the milestone List labels = Arrays.asList(); // List | Label IDs Integer page = 56; // Integer | page number of results to return (1-based) Integer limit = 56; // Integer | page size of results try { List result = apiInstance.repoListPullRequests(owner, repo, state, sort, milestone, labels, page, limit); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoListPullRequests"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **state** | **String**| State of pull request: open or closed (optional) | [optional] [enum: closed, open, all] **sort** | **String**| Type of sort | [optional] [enum: oldest, recentupdate, leastupdate, mostcomment, leastcomment, priority] **milestone** | **Long**| ID of the milestone | [optional] **labels** | [**List<Long>**](Long.md)| Label IDs | [optional] **page** | **Integer**| page number of results to return (1-based) | [optional] **limit** | **Integer**| page size of results | [optional] ### Return type [**List<PullRequest>**](PullRequest.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | PullRequestList | - | # **repoListPullReviews** > List<PullReview> repoListPullReviews(owner, repo, index, page, limit) List all reviews for a pull request ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Long index = 56L; // Long | index of the pull request Integer page = 56; // Integer | page number of results to return (1-based) Integer limit = 56; // Integer | page size of results try { List result = apiInstance.repoListPullReviews(owner, repo, index, page, limit); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoListPullReviews"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **index** | **Long**| index of the pull request | **page** | **Integer**| page number of results to return (1-based) | [optional] **limit** | **Integer**| page size of results | [optional] ### Return type [**List<PullReview>**](PullReview.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | PullReviewList | - | **404** | APINotFound is a not found empty response | - | # **repoListReleaseAttachments** > List<Attachment> repoListReleaseAttachments(owner, repo, id) List release's attachments ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Long id = 56L; // Long | id of the release try { List result = apiInstance.repoListReleaseAttachments(owner, repo, id); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoListReleaseAttachments"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **id** | **Long**| id of the release | ### Return type [**List<Attachment>**](Attachment.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | AttachmentList | - | # **repoListReleases** > List<Release> repoListReleases(owner, repo, perPage, page, limit) List a repo's releases ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Integer perPage = 56; // Integer | page size of results, deprecated - use limit Integer page = 56; // Integer | page number of results to return (1-based) Integer limit = 56; // Integer | page size of results try { List result = apiInstance.repoListReleases(owner, repo, perPage, page, limit); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoListReleases"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **perPage** | **Integer**| page size of results, deprecated - use limit | [optional] **page** | **Integer**| page number of results to return (1-based) | [optional] **limit** | **Integer**| page size of results | [optional] ### Return type [**List<Release>**](Release.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | ReleaseList | - | # **repoListStargazers** > List<User> repoListStargazers(owner, repo, page, limit) List a repo's stargazers ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Integer page = 56; // Integer | page number of results to return (1-based) Integer limit = 56; // Integer | page size of results try { List result = apiInstance.repoListStargazers(owner, repo, page, limit); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoListStargazers"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **page** | **Integer**| page number of results to return (1-based) | [optional] **limit** | **Integer**| page size of results | [optional] ### Return type [**List<User>**](User.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | UserList | - | # **repoListStatuses** > List<Status> repoListStatuses(owner, repo, sha, sort, state, page, limit) Get a commit's statuses ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String sha = "sha_example"; // String | sha of the commit String sort = "sort_example"; // String | type of sort String state = "state_example"; // String | type of state Integer page = 56; // Integer | page number of results to return (1-based) Integer limit = 56; // Integer | page size of results try { List result = apiInstance.repoListStatuses(owner, repo, sha, sort, state, page, limit); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoListStatuses"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **sha** | **String**| sha of the commit | **sort** | **String**| type of sort | [optional] [enum: oldest, recentupdate, leastupdate, leastindex, highestindex] **state** | **String**| type of state | [optional] [enum: pending, success, error, failure, warning] **page** | **Integer**| page number of results to return (1-based) | [optional] **limit** | **Integer**| page size of results | [optional] ### Return type [**List<Status>**](Status.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | StatusList | - | **400** | APIError is error format response | * message -
* url -
| # **repoListStatusesByRef** > List<Status> repoListStatusesByRef(owner, repo, ref, sort, state, page, limit) Get a commit's statuses, by branch/tag/commit reference ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String ref = "ref_example"; // String | name of branch/tag/commit String sort = "sort_example"; // String | type of sort String state = "state_example"; // String | type of state Integer page = 56; // Integer | page number of results to return (1-based) Integer limit = 56; // Integer | page size of results try { List result = apiInstance.repoListStatusesByRef(owner, repo, ref, sort, state, page, limit); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoListStatusesByRef"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **ref** | **String**| name of branch/tag/commit | **sort** | **String**| type of sort | [optional] [enum: oldest, recentupdate, leastupdate, leastindex, highestindex] **state** | **String**| type of state | [optional] [enum: pending, success, error, failure, warning] **page** | **Integer**| page number of results to return (1-based) | [optional] **limit** | **Integer**| page size of results | [optional] ### Return type [**List<Status>**](Status.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | StatusList | - | **400** | APIError is error format response | * message -
* url -
| # **repoListSubscribers** > List<User> repoListSubscribers(owner, repo, page, limit) List a repo's watchers ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Integer page = 56; // Integer | page number of results to return (1-based) Integer limit = 56; // Integer | page size of results try { List result = apiInstance.repoListSubscribers(owner, repo, page, limit); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoListSubscribers"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **page** | **Integer**| page number of results to return (1-based) | [optional] **limit** | **Integer**| page size of results | [optional] ### Return type [**List<User>**](User.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | UserList | - | # **repoListTags** > List<Tag> repoListTags(owner, repo, page, limit) List a repository's tags ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Integer page = 56; // Integer | page number of results to return (1-based) Integer limit = 56; // Integer | page size of results, default maximum page size is 50 try { List result = apiInstance.repoListTags(owner, repo, page, limit); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoListTags"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **page** | **Integer**| page number of results to return (1-based) | [optional] **limit** | **Integer**| page size of results, default maximum page size is 50 | [optional] ### Return type [**List<Tag>**](Tag.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | TagList | - | # **repoListTopics** > TopicName repoListTopics(owner, repo, page, limit) Get list of topics that a repository has ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Integer page = 56; // Integer | page number of results to return (1-based) Integer limit = 56; // Integer | page size of results try { TopicName result = apiInstance.repoListTopics(owner, repo, page, limit); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoListTopics"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **page** | **Integer**| page number of results to return (1-based) | [optional] **limit** | **Integer**| page size of results | [optional] ### Return type [**TopicName**](TopicName.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | TopicNames | - | # **repoMergePullRequest** > repoMergePullRequest(owner, repo, index, body) Merge a pull request ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Long index = 56L; // Long | index of the pull request to merge MergePullRequestOption body = new MergePullRequestOption(); // MergePullRequestOption | try { apiInstance.repoMergePullRequest(owner, repo, index, body); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoMergePullRequest"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **index** | **Long**| index of the pull request to merge | **body** | [**MergePullRequestOption**](MergePullRequestOption.md)| | [optional] ### Return type null (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | APIEmpty is an empty response | - | **405** | APIEmpty is an empty response | - | **409** | APIError is error format response | * message -
* url -
| # **repoMigrate** > Repository repoMigrate(body) Migrate a remote git repository ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); MigrateRepoOptions body = new MigrateRepoOptions(); // MigrateRepoOptions | try { Repository result = apiInstance.repoMigrate(body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoMigrate"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**MigrateRepoOptions**](MigrateRepoOptions.md)| | [optional] ### Return type [**Repository**](Repository.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Repository | - | **403** | APIForbiddenError is a forbidden error response | * message -
* url -
| **422** | APIValidationError is error format response related to input validation | * message -
* url -
| # **repoMirrorSync** > repoMirrorSync(owner, repo) Sync a mirrored repository ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo to sync String repo = "repo_example"; // String | name of the repo to sync try { apiInstance.repoMirrorSync(owner, repo); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoMirrorSync"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo to sync | **repo** | **String**| name of the repo to sync | ### Return type null (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | APIEmpty is an empty response | - | **403** | APIForbiddenError is a forbidden error response | * message -
* url -
| # **repoPullRequestIsMerged** > repoPullRequestIsMerged(owner, repo, index) Check if a pull request has been merged ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Long index = 56L; // Long | index of the pull request try { apiInstance.repoPullRequestIsMerged(owner, repo, index); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoPullRequestIsMerged"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **index** | **Long**| index of the pull request | ### Return type null (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | pull request has been merged | - | **404** | pull request has not been merged | - | # **repoSearch** > SearchResults repoSearch(q, topic, includeDesc, uid, priorityOwnerId, starredBy, _private, isPrivate, template, archived, mode, exclusive, sort, order, page, limit) Search for repositories ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String q = "q_example"; // String | keyword Boolean topic = true; // Boolean | Limit search to repositories with keyword as topic Boolean includeDesc = true; // Boolean | include search of keyword within repository description Long uid = 56L; // Long | search only for repos that the user with the given id owns or contributes to Long priorityOwnerId = 56L; // Long | repo owner to prioritize in the results Long starredBy = 56L; // Long | search only for repos that the user with the given id has starred Boolean _private = true; // Boolean | include private repositories this user has access to (defaults to true) Boolean isPrivate = true; // Boolean | show only pubic, private or all repositories (defaults to all) Boolean template = true; // Boolean | include template repositories this user has access to (defaults to true) Boolean archived = true; // Boolean | show only archived, non-archived or all repositories (defaults to all) String mode = "mode_example"; // String | type of repository to search for. Supported values are \"fork\", \"source\", \"mirror\" and \"collaborative\" Boolean exclusive = true; // Boolean | if `uid` is given, search only for repos that the user owns String sort = "sort_example"; // String | sort repos by attribute. Supported values are \"alpha\", \"created\", \"updated\", \"size\", and \"id\". Default is \"alpha\" String order = "order_example"; // String | sort order, either \"asc\" (ascending) or \"desc\" (descending). Default is \"asc\", ignored if \"sort\" is not specified. Integer page = 56; // Integer | page number of results to return (1-based) Integer limit = 56; // Integer | page size of results try { SearchResults result = apiInstance.repoSearch(q, topic, includeDesc, uid, priorityOwnerId, starredBy, _private, isPrivate, template, archived, mode, exclusive, sort, order, page, limit); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoSearch"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **q** | **String**| keyword | [optional] **topic** | **Boolean**| Limit search to repositories with keyword as topic | [optional] **includeDesc** | **Boolean**| include search of keyword within repository description | [optional] **uid** | **Long**| search only for repos that the user with the given id owns or contributes to | [optional] **priorityOwnerId** | **Long**| repo owner to prioritize in the results | [optional] **starredBy** | **Long**| search only for repos that the user with the given id has starred | [optional] **_private** | **Boolean**| include private repositories this user has access to (defaults to true) | [optional] **isPrivate** | **Boolean**| show only pubic, private or all repositories (defaults to all) | [optional] **template** | **Boolean**| include template repositories this user has access to (defaults to true) | [optional] **archived** | **Boolean**| show only archived, non-archived or all repositories (defaults to all) | [optional] **mode** | **String**| type of repository to search for. Supported values are \"fork\", \"source\", \"mirror\" and \"collaborative\" | [optional] **exclusive** | **Boolean**| if `uid` is given, search only for repos that the user owns | [optional] **sort** | **String**| sort repos by attribute. Supported values are \"alpha\", \"created\", \"updated\", \"size\", and \"id\". Default is \"alpha\" | [optional] **order** | **String**| sort order, either \"asc\" (ascending) or \"desc\" (descending). Default is \"asc\", ignored if \"sort\" is not specified. | [optional] **page** | **Integer**| page number of results to return (1-based) | [optional] **limit** | **Integer**| page size of results | [optional] ### Return type [**SearchResults**](SearchResults.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | SearchResults | - | **422** | APIValidationError is error format response related to input validation | * message -
* url -
| # **repoSigningKey** > String repoSigningKey(owner, repo) Get signing-key.gpg for given repository ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo try { String result = apiInstance.repoSigningKey(owner, repo); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoSigningKey"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | ### Return type **String** ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: text/plain ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | GPG armored public key | - | # **repoSubmitPullReview** > PullReview repoSubmitPullReview(owner, repo, index, id, body) Submit a pending review to an pull request ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Long index = 56L; // Long | index of the pull request Long id = 56L; // Long | id of the review SubmitPullReviewOptions body = new SubmitPullReviewOptions(); // SubmitPullReviewOptions | try { PullReview result = apiInstance.repoSubmitPullReview(owner, repo, index, id, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoSubmitPullReview"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **index** | **Long**| index of the pull request | **id** | **Long**| id of the review | **body** | [**SubmitPullReviewOptions**](SubmitPullReviewOptions.md)| | ### Return type [**PullReview**](PullReview.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | PullReview | - | **404** | APINotFound is a not found empty response | - | **422** | APIValidationError is error format response related to input validation | * message -
* url -
| # **repoTestHook** > repoTestHook(owner, repo, id) Test a push webhook ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Long id = 56L; // Long | id of the hook to test try { apiInstance.repoTestHook(owner, repo, id); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoTestHook"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **id** | **Long**| id of the hook to test | ### Return type null (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | APIEmpty is an empty response | - | # **repoTrackedTimes** > List<TrackedTime> repoTrackedTimes(owner, repo, user, since, before, page, limit) List a repo's tracked times ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String user = "user_example"; // String | optional filter by user OffsetDateTime since = OffsetDateTime.now(); // OffsetDateTime | Only show times updated after the given time. This is a timestamp in RFC 3339 format OffsetDateTime before = OffsetDateTime.now(); // OffsetDateTime | Only show times updated before the given time. This is a timestamp in RFC 3339 format Integer page = 56; // Integer | page number of results to return (1-based) Integer limit = 56; // Integer | page size of results try { List result = apiInstance.repoTrackedTimes(owner, repo, user, since, before, page, limit); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoTrackedTimes"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **user** | **String**| optional filter by user | [optional] **since** | **OffsetDateTime**| Only show times updated after the given time. This is a timestamp in RFC 3339 format | [optional] **before** | **OffsetDateTime**| Only show times updated before the given time. This is a timestamp in RFC 3339 format | [optional] **page** | **Integer**| page number of results to return (1-based) | [optional] **limit** | **Integer**| page size of results | [optional] ### Return type [**List<TrackedTime>**](TrackedTime.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | TrackedTimeList | - | **400** | APIError is error format response | * message -
* url -
| **403** | APIForbiddenError is a forbidden error response | * message -
* url -
| # **repoTransfer** > Repository repoTransfer(owner, repo, body) Transfer a repo ownership ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo to transfer String repo = "repo_example"; // String | name of the repo to transfer TransferRepoOption body = new TransferRepoOption(); // TransferRepoOption | Transfer Options try { Repository result = apiInstance.repoTransfer(owner, repo, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoTransfer"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo to transfer | **repo** | **String**| name of the repo to transfer | **body** | [**TransferRepoOption**](TransferRepoOption.md)| Transfer Options | ### Return type [**Repository**](Repository.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **202** | Repository | - | **403** | APIForbiddenError is a forbidden error response | * message -
* url -
| **404** | APINotFound is a not found empty response | - | **422** | APIValidationError is error format response related to input validation | * message -
* url -
| # **repoUpdateFile** > FileResponse repoUpdateFile(owner, repo, filepath, body) Update a file in a repository ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String filepath = "filepath_example"; // String | path of the file to update UpdateFileOptions body = new UpdateFileOptions(); // UpdateFileOptions | try { FileResponse result = apiInstance.repoUpdateFile(owner, repo, filepath, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoUpdateFile"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **filepath** | **String**| path of the file to update | **body** | [**UpdateFileOptions**](UpdateFileOptions.md)| | ### Return type [**FileResponse**](FileResponse.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | FileResponse | - | **403** | APIError is error format response | * message -
* url -
| **404** | APINotFound is a not found empty response | - | **422** | APIError is error format response | * message -
* url -
| # **repoUpdatePullRequest** > repoUpdatePullRequest(owner, repo, index) Merge PR's baseBranch into headBranch ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo Long index = 56L; // Long | index of the pull request to get try { apiInstance.repoUpdatePullRequest(owner, repo, index); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoUpdatePullRequest"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **index** | **Long**| index of the pull request to get | ### Return type null (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | APIEmpty is an empty response | - | **403** | APIForbiddenError is a forbidden error response | * message -
* url -
| **404** | APINotFound is a not found empty response | - | **409** | APIError is error format response | * message -
* url -
| **422** | APIValidationError is error format response related to input validation | * message -
* url -
| # **repoUpdateTopics** > repoUpdateTopics(owner, repo, body) Replace list of topics for a repository ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo RepoTopicOptions body = new RepoTopicOptions(); // RepoTopicOptions | try { apiInstance.repoUpdateTopics(owner, repo, body); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoUpdateTopics"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **body** | [**RepoTopicOptions**](RepoTopicOptions.md)| | [optional] ### Return type null (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | APIEmpty is an empty response | - | **422** | APIInvalidTopicsError is error format response to invalid topics | * invalidTopics -
* message -
| # **topicSearch** > List<TopicResponse> topicSearch(q, page, limit) search topics via keyword ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String q = "q_example"; // String | keywords to search Integer page = 56; // Integer | page number of results to return (1-based) Integer limit = 56; // Integer | page size of results try { List result = apiInstance.topicSearch(q, page, limit); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#topicSearch"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **q** | **String**| keywords to search | **page** | **Integer**| page number of results to return (1-based) | [optional] **limit** | **Integer**| page size of results | [optional] ### Return type [**List<TopicResponse>**](TopicResponse.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | TopicListResponse | - | **403** | APIForbiddenError is a forbidden error response | * message -
* url -
| # **userCurrentCheckSubscription** > WatchInfo userCurrentCheckSubscription(owner, repo) Check if the current user is watching a repo ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo try { WatchInfo result = apiInstance.userCurrentCheckSubscription(owner, repo); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#userCurrentCheckSubscription"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | ### Return type [**WatchInfo**](WatchInfo.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json, text/html ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | WatchInfo | - | **404** | User is not watching this repo or repo do not exist | - | # **userCurrentDeleteSubscription** > userCurrentDeleteSubscription(owner, repo) Unwatch a repo ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo try { apiInstance.userCurrentDeleteSubscription(owner, repo); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#userCurrentDeleteSubscription"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | ### Return type null (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | APIEmpty is an empty response | - | # **userCurrentPutSubscription** > WatchInfo userCurrentPutSubscription(owner, repo) Watch a repo ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo try { WatchInfo result = apiInstance.userCurrentPutSubscription(owner, repo); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#userCurrentPutSubscription"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | ### Return type [**WatchInfo**](WatchInfo.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json, text/html ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | WatchInfo | - | # **userTrackedTimes** > List<TrackedTime> userTrackedTimes(owner, repo, user) List a user's tracked times in a repo ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.RepositoryApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); RepositoryApi apiInstance = new RepositoryApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String user = "user_example"; // String | username of user try { List result = apiInstance.userTrackedTimes(owner, repo, user); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#userTrackedTimes"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **user** | **String**| username of user | ### Return type [**List<TrackedTime>**](TrackedTime.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | TrackedTimeList | - | **400** | APIError is error format response | * message -
* url -
| **403** | APIForbiddenError is a forbidden error response | * message -
* url -
|