Synchronizing API and documentation updates

2026-06-29 13:58:26 +00:00 · 2023-04-27 00:15:07 +00:00
parent 634930e960
commit a207cf48d3
8 changed files with 546 additions and 0 deletions
@@ -0,0 +1,10 @@
+# LicenseTemplateInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**body** | **String** |  |  [optional]
+**implementation** | **String** |  |  [optional]
+**key** | **String** |  |  [optional]
+**name** | **String** |  |  [optional]
+**url** | **String** |  |  [optional]
@@ -0,0 +1,8 @@
+# LicensesTemplateListEntry
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** |  |  [optional]
+**name** | **String** |  |  [optional]
+**url** | **String** |  |  [optional]
@@ -4,13 +4,102 @@ All URIs are relative to *http://{{AppSubUrl | JSEscape | Safe}}/api/v1*

 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**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
 [**getVersion**](MiscellaneousApi.md#getVersion) | **GET** version | Returns the version of the Gitea application
+[**listLicenseTemplates**](MiscellaneousApi.md#listLicenseTemplates) | **GET** licenses | Returns a list of all license templates
 [**renderMarkdown**](MiscellaneousApi.md#renderMarkdown) | **POST** markdown | Render a markdown document as HTML
 [**renderMarkdownRaw**](MiscellaneousApi.md#renderMarkdownRaw) | **POST** markdown/raw | Render raw markdown as HTML
 [**renderMarkup**](MiscellaneousApi.md#renderMarkup) | **POST** markup | Render a markup document as HTML

+<a name="getLicenseTemplateInfo"></a>
+# **getLicenseTemplateInfo**
+> LicenseTemplateInfo getLicenseTemplateInfo(name)
+
+Returns information about a license template
+
+### 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();
+String name = "name_example"; // String | name of the license
+try {
+    LicenseTemplateInfo result = apiInstance.getLicenseTemplateInfo(name);
+    System.out.println(result);
+} catch (ApiException e) {
+    System.err.println("Exception when calling MiscellaneousApi#getLicenseTemplateInfo");
+    e.printStackTrace();
+}
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| name of the license |
+
+### Return type
+
+[**LicenseTemplateInfo**](LicenseTemplateInfo.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
+
 <a name="getNodeInfo"></a>
 # **getNodeInfo**
 > NodeInfo getNodeInfo()
@@ -255,6 +344,89 @@ This endpoint does not need any parameter.

 [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
+
+<a name="listLicenseTemplates"></a>
+# **listLicenseTemplates**
+> List&lt;LicensesTemplateListEntry&gt; listLicenseTemplates()
+
+Returns a list of all license templates
+
+### 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 {
+    List<LicensesTemplateListEntry> result = apiInstance.listLicenseTemplates();
+    System.out.println(result);
+} catch (ApiException e) {
+    System.err.println("Exception when calling MiscellaneousApi#listLicenseTemplates");
+    e.printStackTrace();
+}
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**List&lt;LicensesTemplateListEntry&gt;**](LicensesTemplateListEntry.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
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **allowRebaseUpdate** | **Boolean** |  |  [optional]
 **allowSquashMerge** | **Boolean** |  |  [optional]
 **archived** | **Boolean** |  |  [optional]
+**archivedAt** | [**Date**](Date.md) |  |  [optional]
 **avatarUrl** | **String** |  |  [optional]
 **cloneUrl** | **String** |  |  [optional]
 **createdAt** | [**Date**](Date.md) |  |  [optional]
@@ -1,6 +1,9 @@
 package org.gitnex.tea4j.v2.apis;

+import java.util.List;
 import org.gitnex.tea4j.v2.CollectionFormats.*;
+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;
@@ -9,6 +12,15 @@ import retrofit2.Call;
 import retrofit2.http.*;

 public interface MiscellaneousApi {
+  /**
+   * Returns information about a license template
+   *
+   * @param name name of the license (required)
+   * @return Call&lt;LicenseTemplateInfo&gt;
+   */
+  @GET("licenses/{name}")
+  Call<LicenseTemplateInfo> getLicenseTemplateInfo(@retrofit2.http.Path("name") String name);
+
  /**
   * Returns the nodeinfo of the Gitea application
   *
@@ -33,6 +45,14 @@ public interface MiscellaneousApi {
  @GET("version")
  Call<ServerVersion> getVersion();

+  /**
+   * Returns a list of all license templates
+   *
+   * @return Call&lt;List&lt;LicensesTemplateListEntry&gt;&gt;
+   */
+  @GET("licenses")
+  Call<List<LicensesTemplateListEntry>> listLicenseTemplates();
+
  /**
   * Render a markdown document as HTML
   *
@@ -0,0 +1,179 @@
+/*
+ * Gitea API.
+ * This documentation describes the Gitea API.
+ *
+ * OpenAPI spec version: {{AppVer | JSEscape | Safe}}
+ *
+ *
+ * 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;
+
+/** LicensesInfo contains information about a License */
+@Schema(description = "LicensesInfo contains information about a License")
+public class LicenseTemplateInfo implements Serializable {
+  private static final long serialVersionUID = 1L;
+
+  @SerializedName("body")
+  private String body = null;
+
+  @SerializedName("implementation")
+  private String implementation = null;
+
+  @SerializedName("key")
+  private String key = null;
+
+  @SerializedName("name")
+  private String name = null;
+
+  @SerializedName("url")
+  private String url = null;
+
+  public LicenseTemplateInfo body(String body) {
+    this.body = body;
+    return this;
+  }
+
+  /**
+   * Get body
+   *
+   * @return body
+   */
+  @Schema(description = "")
+  public String getBody() {
+    return body;
+  }
+
+  public void setBody(String body) {
+    this.body = body;
+  }
+
+  public LicenseTemplateInfo implementation(String implementation) {
+    this.implementation = implementation;
+    return this;
+  }
+
+  /**
+   * Get implementation
+   *
+   * @return implementation
+   */
+  @Schema(description = "")
+  public String getImplementation() {
+    return implementation;
+  }
+
+  public void setImplementation(String implementation) {
+    this.implementation = implementation;
+  }
+
+  public LicenseTemplateInfo key(String key) {
+    this.key = key;
+    return this;
+  }
+
+  /**
+   * Get key
+   *
+   * @return key
+   */
+  @Schema(description = "")
+  public String getKey() {
+    return key;
+  }
+
+  public void setKey(String key) {
+    this.key = key;
+  }
+
+  public LicenseTemplateInfo name(String name) {
+    this.name = name;
+    return this;
+  }
+
+  /**
+   * Get name
+   *
+   * @return name
+   */
+  @Schema(description = "")
+  public String getName() {
+    return name;
+  }
+
+  public void setName(String name) {
+    this.name = name;
+  }
+
+  public LicenseTemplateInfo url(String url) {
+    this.url = url;
+    return this;
+  }
+
+  /**
+   * Get url
+   *
+   * @return url
+   */
+  @Schema(description = "")
+  public String getUrl() {
+    return url;
+  }
+
+  public void setUrl(String url) {
+    this.url = url;
+  }
+
+  @Override
+  public boolean equals(java.lang.Object o) {
+    if (this == o) {
+      return true;
+    }
+    if (o == null || getClass() != o.getClass()) {
+      return false;
+    }
+    LicenseTemplateInfo licenseTemplateInfo = (LicenseTemplateInfo) o;
+    return Objects.equals(this.body, licenseTemplateInfo.body)
+        && Objects.equals(this.implementation, licenseTemplateInfo.implementation)
+        && Objects.equals(this.key, licenseTemplateInfo.key)
+        && Objects.equals(this.name, licenseTemplateInfo.name)
+        && Objects.equals(this.url, licenseTemplateInfo.url);
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(body, implementation, key, name, url);
+  }
+
+  @Override
+  public String toString() {
+    StringBuilder sb = new StringBuilder();
+    sb.append("class LicenseTemplateInfo {\n");
+
+    sb.append("    body: ").append(toIndentedString(body)).append("\n");
+    sb.append("    implementation: ").append(toIndentedString(implementation)).append("\n");
+    sb.append("    key: ").append(toIndentedString(key)).append("\n");
+    sb.append("    name: ").append(toIndentedString(name)).append("\n");
+    sb.append("    url: ").append(toIndentedString(url)).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    ");
+  }
+}
@@ -0,0 +1,131 @@
+/*
+ * Gitea API.
+ * This documentation describes the Gitea API.
+ *
+ * OpenAPI spec version: {{AppVer | JSEscape | Safe}}
+ *
+ *
+ * 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;
+
+/** LicensesListEntry is used for the API */
+@Schema(description = "LicensesListEntry is used for the API")
+public class LicensesTemplateListEntry implements Serializable {
+  private static final long serialVersionUID = 1L;
+
+  @SerializedName("key")
+  private String key = null;
+
+  @SerializedName("name")
+  private String name = null;
+
+  @SerializedName("url")
+  private String url = null;
+
+  public LicensesTemplateListEntry key(String key) {
+    this.key = key;
+    return this;
+  }
+
+  /**
+   * Get key
+   *
+   * @return key
+   */
+  @Schema(description = "")
+  public String getKey() {
+    return key;
+  }
+
+  public void setKey(String key) {
+    this.key = key;
+  }
+
+  public LicensesTemplateListEntry name(String name) {
+    this.name = name;
+    return this;
+  }
+
+  /**
+   * Get name
+   *
+   * @return name
+   */
+  @Schema(description = "")
+  public String getName() {
+    return name;
+  }
+
+  public void setName(String name) {
+    this.name = name;
+  }
+
+  public LicensesTemplateListEntry url(String url) {
+    this.url = url;
+    return this;
+  }
+
+  /**
+   * Get url
+   *
+   * @return url
+   */
+  @Schema(description = "")
+  public String getUrl() {
+    return url;
+  }
+
+  public void setUrl(String url) {
+    this.url = url;
+  }
+
+  @Override
+  public boolean equals(java.lang.Object o) {
+    if (this == o) {
+      return true;
+    }
+    if (o == null || getClass() != o.getClass()) {
+      return false;
+    }
+    LicensesTemplateListEntry licensesTemplateListEntry = (LicensesTemplateListEntry) o;
+    return Objects.equals(this.key, licensesTemplateListEntry.key)
+        && Objects.equals(this.name, licensesTemplateListEntry.name)
+        && Objects.equals(this.url, licensesTemplateListEntry.url);
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(key, name, url);
+  }
+
+  @Override
+  public String toString() {
+    StringBuilder sb = new StringBuilder();
+    sb.append("class LicensesTemplateListEntry {\n");
+
+    sb.append("    key: ").append(toIndentedString(key)).append("\n");
+    sb.append("    name: ").append(toIndentedString(name)).append("\n");
+    sb.append("    url: ").append(toIndentedString(url)).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    ");
+  }
+}
@@ -41,6 +41,9 @@ public class Repository implements Serializable {
  @SerializedName("archived")
  private Boolean archived = null;

+  @SerializedName("archived_at")
+  private Date archivedAt = null;
+
  @SerializedName("avatar_url")
  private String avatarUrl = null;

@@ -302,6 +305,25 @@ public class Repository implements Serializable {
    this.archived = archived;
  }

+  public Repository archivedAt(Date archivedAt) {
+    this.archivedAt = archivedAt;
+    return this;
+  }
+
+  /**
+   * Get archivedAt
+   *
+   * @return archivedAt
+   */
+  @Schema(description = "")
+  public Date getArchivedAt() {
+    return archivedAt;
+  }
+
+  public void setArchivedAt(Date archivedAt) {
+    this.archivedAt = archivedAt;
+  }
+
  public Repository avatarUrl(String avatarUrl) {
    this.avatarUrl = avatarUrl;
    return this;
@@ -1248,6 +1270,7 @@ public class Repository implements Serializable {
        && Objects.equals(this.allowRebaseUpdate, repository.allowRebaseUpdate)
        && Objects.equals(this.allowSquashMerge, repository.allowSquashMerge)
        && Objects.equals(this.archived, repository.archived)
+        && Objects.equals(this.archivedAt, repository.archivedAt)
        && Objects.equals(this.avatarUrl, repository.avatarUrl)
        && Objects.equals(this.cloneUrl, repository.cloneUrl)
        && Objects.equals(this.createdAt, repository.createdAt)
@@ -1309,6 +1332,7 @@ public class Repository implements Serializable {
        allowRebaseUpdate,
        allowSquashMerge,
        archived,
+        archivedAt,
        avatarUrl,
        cloneUrl,
        createdAt,
@@ -1373,6 +1397,7 @@ public class Repository implements Serializable {
    sb.append("    allowRebaseUpdate: ").append(toIndentedString(allowRebaseUpdate)).append("\n");
    sb.append("    allowSquashMerge: ").append(toIndentedString(allowSquashMerge)).append("\n");
    sb.append("    archived: ").append(toIndentedString(archived)).append("\n");
+    sb.append("    archivedAt: ").append(toIndentedString(archivedAt)).append("\n");
    sb.append("    avatarUrl: ").append(toIndentedString(avatarUrl)).append("\n");
    sb.append("    cloneUrl: ").append(toIndentedString(cloneUrl)).append("\n");
    sb.append("    createdAt: ").append(toIndentedString(createdAt)).append("\n");