diff --git a/docs/MiscellaneousApi.md b/docs/MiscellaneousApi.md index 8898c3e..dc71970 100644 --- a/docs/MiscellaneousApi.md +++ b/docs/MiscellaneousApi.md @@ -7,7 +7,6 @@ Method | HTTP request | Description [**getGitignoreTemplateInfo**](MiscellaneousApi.md#getGitignoreTemplateInfo) | **GET** gitignore/templates/{name} | Returns information about a gitignore template [**getLabelTemplateInfo**](MiscellaneousApi.md#getLabelTemplateInfo) | **GET** label/templates/{name} | Returns all labels in a template [**getLicenseTemplateInfo**](MiscellaneousApi.md#getLicenseTemplateInfo) | **GET** licenses/{name} | Returns information about a license template -[**getNodeInfo**](MiscellaneousApi.md#getNodeInfo) | **GET** nodeinfo | Returns the nodeinfo of the Gitea application [**getSigningKey**](MiscellaneousApi.md#getSigningKey) | **GET** signing-key.gpg | Get default signing-key.gpg [**getSigningKeySSH**](MiscellaneousApi.md#getSigningKeySSH) | **GET** signing-key.pub | Get default signing-key.pub [**getVersion**](MiscellaneousApi.md#getVersion) | **GET** version | Returns the version of the Gitea application @@ -274,89 +273,6 @@ Name | Type | Description | Notes [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 - - -# **getNodeInfo** -> NodeInfo getNodeInfo() - -Returns the nodeinfo of the Gitea application - -### Example -```java -// Import classes: -//import org.gitnex.tea4j.v2.ApiClient; -//import org.gitnex.tea4j.v2.ApiException; -//import org.gitnex.tea4j.v2.Configuration; -//import org.gitnex.tea4j.v2.auth.*; -//import org.gitnex.tea4j.v2.apis.MiscellaneousApi; - -ApiClient defaultClient = Configuration.getDefaultApiClient(); - -// 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"); - -MiscellaneousApi apiInstance = new MiscellaneousApi(); -try { - NodeInfo result = apiInstance.getNodeInfo(); - System.out.println(result); -} catch (ApiException e) { - System.err.println("Exception when calling MiscellaneousApi#getNodeInfo"); - e.printStackTrace(); -} -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**NodeInfo**](NodeInfo.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 diff --git a/docs/RepositoryApi.md b/docs/RepositoryApi.md index 0c57e7e..42c92dc 100644 --- a/docs/RepositoryApi.md +++ b/docs/RepositoryApi.md @@ -381,7 +381,7 @@ Name | Type | Description | Notes # **actionsDispatchWorkflow** -> Void actionsDispatchWorkflow(owner, repo, workflowId, body) +> RunDetails actionsDispatchWorkflow(owner, repo, workflowId, body, returnRunDetails) Create a workflow dispatch event @@ -441,8 +441,9 @@ String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String workflowId = "workflowId_example"; // String | id of the workflow CreateActionWorkflowDispatch body = new CreateActionWorkflowDispatch(); // CreateActionWorkflowDispatch | +Boolean returnRunDetails = true; // Boolean | Whether the response should include the workflow run ID and URLs. try { - Void result = apiInstance.actionsDispatchWorkflow(owner, repo, workflowId, body); + RunDetails result = apiInstance.actionsDispatchWorkflow(owner, repo, workflowId, body, returnRunDetails); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#actionsDispatchWorkflow"); @@ -458,10 +459,11 @@ Name | Type | Description | Notes **repo** | **String**| name of the repo | **workflowId** | **String**| id of the workflow | **body** | [**CreateActionWorkflowDispatch**](CreateActionWorkflowDispatch.md)| | [optional] + **returnRunDetails** | **Boolean**| Whether the response should include the workflow run ID and URLs. | [optional] ### Return type -[**Void**](.md) +[**RunDetails**](RunDetails.md) ### Authorization @@ -470,7 +472,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: application/json, text/plain - - **Accept**: Not defined + - **Accept**: application/json # **actionsEnableWorkflow** diff --git a/docs/RunDetails.md b/docs/RunDetails.md new file mode 100644 index 0000000..6391f4c --- /dev/null +++ b/docs/RunDetails.md @@ -0,0 +1,8 @@ +# RunDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**htmlUrl** | **String** | | [optional] +**runUrl** | **String** | | [optional] +**workflowRunId** | **Long** | | [optional] diff --git a/src/main/java/org/gitnex/tea4j/v2/apis/MiscellaneousApi.java b/src/main/java/org/gitnex/tea4j/v2/apis/MiscellaneousApi.java index be26b4c..c5b5815 100644 --- a/src/main/java/org/gitnex/tea4j/v2/apis/MiscellaneousApi.java +++ b/src/main/java/org/gitnex/tea4j/v2/apis/MiscellaneousApi.java @@ -8,7 +8,6 @@ import org.gitnex.tea4j.v2.models.LicenseTemplateInfo; import org.gitnex.tea4j.v2.models.LicensesTemplateListEntry; import org.gitnex.tea4j.v2.models.MarkdownOption; import org.gitnex.tea4j.v2.models.MarkupOption; -import org.gitnex.tea4j.v2.models.NodeInfo; import org.gitnex.tea4j.v2.models.ServerVersion; import retrofit2.Call; import retrofit2.http.*; @@ -41,14 +40,6 @@ public interface MiscellaneousApi { @GET("licenses/{name}") Call getLicenseTemplateInfo(@retrofit2.http.Path("name") String name); - /** - * Returns the nodeinfo of the Gitea application - * - * @return Call<NodeInfo> - */ - @GET("nodeinfo") - Call getNodeInfo(); - /** * Get default signing-key.gpg * diff --git a/src/main/java/org/gitnex/tea4j/v2/apis/RepositoryApi.java b/src/main/java/org/gitnex/tea4j/v2/apis/RepositoryApi.java index d582ade..aa1281b 100644 --- a/src/main/java/org/gitnex/tea4j/v2/apis/RepositoryApi.java +++ b/src/main/java/org/gitnex/tea4j/v2/apis/RepositoryApi.java @@ -91,6 +91,7 @@ import org.gitnex.tea4j.v2.models.RenameBranchRepoOption; import org.gitnex.tea4j.v2.models.RepoCollaboratorPermission; import org.gitnex.tea4j.v2.models.RepoTopicOptions; import org.gitnex.tea4j.v2.models.Repository; +import org.gitnex.tea4j.v2.models.RunDetails; import org.gitnex.tea4j.v2.models.SearchResults; import org.gitnex.tea4j.v2.models.Secret; import org.gitnex.tea4j.v2.models.SubmitPullReviewOptions; @@ -147,15 +148,18 @@ public interface RepositoryApi { * @param repo name of the repo (required) * @param workflowId id of the workflow (required) * @param body (optional) - * @return Call<Void> + * @param returnRunDetails Whether the response should include the workflow run ID and URLs. + * (optional) + * @return Call<RunDetails> */ @Headers({"Content-Type:application/json"}) @POST("repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches") - Call actionsDispatchWorkflow( + Call actionsDispatchWorkflow( @retrofit2.http.Path("owner") String owner, @retrofit2.http.Path("repo") String repo, @retrofit2.http.Path("workflow_id") String workflowId, - @retrofit2.http.Body CreateActionWorkflowDispatch body); + @retrofit2.http.Body CreateActionWorkflowDispatch body, + @retrofit2.http.Query("return_run_details") Boolean returnRunDetails); /** * Enable a workflow diff --git a/src/main/java/org/gitnex/tea4j/v2/models/RunDetails.java b/src/main/java/org/gitnex/tea4j/v2/models/RunDetails.java new file mode 100644 index 0000000..19d9de1 --- /dev/null +++ b/src/main/java/org/gitnex/tea4j/v2/models/RunDetails.java @@ -0,0 +1,131 @@ +/* + * Gitea API + * This documentation describes the Gitea API. + * + * OpenAPI spec version: {{.SwaggerAppVer}} + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + +package org.gitnex.tea4j.v2.models; + +import com.google.gson.annotations.SerializedName; +import io.swagger.v3.oas.annotations.media.Schema; +import java.io.Serializable; +import java.util.Objects; + +/** RunDetails returns workflow_dispatch runid and url */ +@Schema(description = "RunDetails returns workflow_dispatch runid and url") +public class RunDetails implements Serializable { + private static final long serialVersionUID = 1L; + + @SerializedName("html_url") + private String htmlUrl = null; + + @SerializedName("run_url") + private String runUrl = null; + + @SerializedName("workflow_run_id") + private Long workflowRunId = null; + + public RunDetails htmlUrl(String htmlUrl) { + this.htmlUrl = htmlUrl; + return this; + } + + /** + * Get htmlUrl + * + * @return htmlUrl + */ + @Schema(description = "") + public String getHtmlUrl() { + return htmlUrl; + } + + public void setHtmlUrl(String htmlUrl) { + this.htmlUrl = htmlUrl; + } + + public RunDetails runUrl(String runUrl) { + this.runUrl = runUrl; + return this; + } + + /** + * Get runUrl + * + * @return runUrl + */ + @Schema(description = "") + public String getRunUrl() { + return runUrl; + } + + public void setRunUrl(String runUrl) { + this.runUrl = runUrl; + } + + public RunDetails workflowRunId(Long workflowRunId) { + this.workflowRunId = workflowRunId; + return this; + } + + /** + * Get workflowRunId + * + * @return workflowRunId + */ + @Schema(description = "") + public Long getWorkflowRunId() { + return workflowRunId; + } + + public void setWorkflowRunId(Long workflowRunId) { + this.workflowRunId = workflowRunId; + } + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + RunDetails runDetails = (RunDetails) o; + return Objects.equals(this.htmlUrl, runDetails.htmlUrl) + && Objects.equals(this.runUrl, runDetails.runUrl) + && Objects.equals(this.workflowRunId, runDetails.workflowRunId); + } + + @Override + public int hashCode() { + return Objects.hash(htmlUrl, runUrl, workflowRunId); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class RunDetails {\n"); + + sb.append(" htmlUrl: ").append(toIndentedString(htmlUrl)).append("\n"); + sb.append(" runUrl: ").append(toIndentedString(runUrl)).append("\n"); + sb.append(" workflowRunId: ").append(toIndentedString(workflowRunId)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +}