@halo-dev/api-client 2.20.21 → 2.21.0

package/dist/src/models/search-option.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.11-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -10,13 +10,13 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * Search option. It is used to control search behavior.
  * @export
  * @interface SearchOption
  */
 export interface SearchOption {
     /**
-     *
+     * Additional annotations for extending search option by other search engines.
      * @type {{ [key: string]: string; }}
      * @memberof SearchOption
      */
@@ -24,67 +24,67 @@ export interface SearchOption {
         [key: string]: string;
     };
     /**
-     *
+     * Whether to filter exposed content. If null, it will not filter.
      * @type {boolean}
      * @memberof SearchOption
      */
     'filterExposed'?: boolean;
     /**
-     *
+     * Whether to filter published content. If null, it will not filter.
      * @type {boolean}
      * @memberof SearchOption
      */
     'filterPublished'?: boolean;
     /**
-     *
+     * Whether to filter recycled content. If null, it will not filter.
      * @type {boolean}
      * @memberof SearchOption
      */
     'filterRecycled'?: boolean;
     /**
-     *
+     * Post HTML tag of highlighted fragment.
      * @type {string}
      * @memberof SearchOption
      */
     'highlightPostTag'?: string;
     /**
-     *
+     * Pre HTML tag of highlighted fragment.
      * @type {string}
      * @memberof SearchOption
      */
     'highlightPreTag'?: string;
     /**
-     *
+     * Category names to include(and). If null, it will include all categories.
      * @type {Array<string>}
      * @memberof SearchOption
      */
     'includeCategoryNames'?: Array<string>;
     /**
-     *
+     * Owner names to include(or). If null, it will include all owners.
      * @type {Array<string>}
      * @memberof SearchOption
      */
     'includeOwnerNames'?: Array<string>;
     /**
-     *
+     * Tag names to include(and). If null, it will include all tags.
      * @type {Array<string>}
      * @memberof SearchOption
      */
     'includeTagNames'?: Array<string>;
     /**
-     *
+     * Types to include(or). If null, it will include all types.
      * @type {Array<string>}
      * @memberof SearchOption
      */
     'includeTypes'?: Array<string>;
     /**
-     *
+     * Search keyword.
      * @type {string}
      * @memberof SearchOption
      */
     'keyword': string;
     /**
-     *
+     * Limit of result.
      * @type {number}
      * @memberof SearchOption
      */

package/dist/src/models/secret.d.ts

@@ -1,6 +1,6 @@
 import { Metadata } from './metadata';
 /**
- *
+ * Secret is a small piece of sensitive data which should be kept secret, such as a password,  a token, or a key.
  * @export
  * @interface Secret
  */
@@ -12,7 +12,7 @@ export interface Secret {
      */
     'apiVersion': string;
     /**
-     *
+     * <p>The total bytes of the values in  the Data field must be less than {@link run.halo.app.extension.Secret#MAX_SECRET_SIZE #MAX_SECRET_SIZE} bytes.</p>  <p><code>data</code> contains the secret data. Each key must consist of alphanumeric  characters, \'-\', \'_\' or \'.\'. The serialized form of the secret data is a  base64 encoded string, representing the arbitrary (possibly non-string)  data value here. Described in  <a href=\"https://tools.ietf.org/html/rfc4648#section-4\">rfc4648#section-4</a>  </p>
      * @type {{ [key: string]: string; }}
      * @memberof Secret
      */
@@ -32,7 +32,7 @@ export interface Secret {
      */
     'metadata': Metadata;
     /**
-     *
+     * <code>stringData</code> allows specifying non-binary secret data in string form.  It is provided as a write-only input field for convenience.  All keys and values are merged into the data field on write, overwriting any existing  values.  The stringData field is never output when reading from the API.
      * @type {{ [key: string]: string; }}
      * @memberof Secret
      */
@@ -40,7 +40,7 @@ export interface Secret {
         [key: string]: string;
     };
     /**
-     *
+     * Used to facilitate programmatic handling of secret data.  More info:  <a href=\"https://kubernetes.io/docs/concepts/configuration/secret/#secret-types\">secret-types</a>
      * @type {string}
      * @memberof Secret
      */

package/dist/src/models/setting-form.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.11-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/setting-ref.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.11-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/setting.d.ts

@@ -1,7 +1,7 @@
 import { Metadata } from './metadata';
 import { SettingSpec } from './setting-spec';
 /**
- *
+ * {@link Setting Setting} is a custom extension to generate forms based on configuration.
  * @export
  * @interface Setting
  */

package/dist/src/models/single-page-request.d.ts

@@ -1,7 +1,7 @@
 import { ContentUpdateParam } from './content-update-param';
 import { SinglePage } from './single-page';
 /**
- *
+ * A request parameter for {@link SinglePage SinglePage}.
  * @export
  * @interface SinglePageRequest
  */

package/dist/src/models/single-page-spec.d.ts

@@ -80,7 +80,7 @@ export interface SinglePageSpec {
      */
     'publishTime'?: string;
     /**
-     *
+     * 引用到的已发布的内容，用于主题端显示.
      * @type {string}
      * @memberof SinglePageSpec
      */

package/dist/src/models/single-page-status.d.ts

@@ -30,7 +30,7 @@ export interface SinglePageStatus {
      */
     'excerpt'?: string;
     /**
-     *
+     * see {@link Category.CategorySpec#isHideFromList Category.CategorySpec#isHideFromList()}.
      * @type {boolean}
      * @memberof SinglePageStatus
      */

package/dist/src/models/single-page-vo.d.ts

@@ -5,7 +5,7 @@ import { SinglePageSpec } from './single-page-spec';
 import { SinglePageStatus } from './single-page-status';
 import { StatsVo } from './stats-vo';
 /**
- *
+ * A value object for {@link SinglePage SinglePage}.
  * @export
  * @interface SinglePageVo
  */

package/dist/src/models/single-page.d.ts

@@ -2,7 +2,7 @@ import { Metadata } from './metadata';
 import { SinglePageSpec } from './single-page-spec';
 import { SinglePageStatus } from './single-page-status';
 /**
- *
+ * <p>Single page extension.</p>
  * @export
  * @interface SinglePage
  */

package/dist/src/models/site-stats-vo.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.11-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * A value object for site stats.
  * @export
  * @interface SiteStatsVo
  */

package/dist/src/models/snap-shot-spec.d.ts

@@ -42,7 +42,7 @@ export interface SnapShotSpec {
      */
     'rawPatch'?: string;
     /**
-     *
+     * such as: markdown | html | json | asciidoc | latex.
      * @type {string}
      * @memberof SnapShotSpec
      */

package/dist/src/models/stats-vo.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.11-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * Stats value object.
  * @export
  * @interface StatsVo
  */

package/dist/src/models/stats.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.11-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * Stats value object.
  * @export
  * @interface Stats
  */

package/dist/src/models/subject.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.11-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -16,19 +16,19 @@
  */
 export interface Subject {
     /**
-     *
+     * APIGroup holds the API group of the referenced subject.  Defaults to \"\" for ServiceAccount subjects.  Defaults to \"rbac.authorization.halo.run\" for User and Group subjects.
      * @type {string}
      * @memberof Subject
      */
     'apiGroup'?: string;
     /**
-     *
+     * Kind of object being referenced. Values defined by this API group are \"User\", \"Group\",  and \"ServiceAccount\".  If the Authorizer does not recognize the kind value, the Authorizer should report  an error.
      * @type {string}
      * @memberof Subject
      */
     'kind'?: string;
     /**
-     *
+     * Name of the object being referenced.
      * @type {string}
      * @memberof Subject
      */

package/dist/src/models/subscription-subscriber.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.11-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/subscription.d.ts

@@ -1,7 +1,7 @@
 import { Metadata } from './metadata';
 import { SubscriptionSpec } from './subscription-spec';
 /**
- *
+ * <p>{@link Subscription Subscription} is a custom extension that defines a subscriber to be notified when a  certain {@link Reason Reason} is triggered.</p>  <p>It holds a {@link Subscriber Subscriber} to the user to be notified, a {@link InterestReason InterestReason} to  subscribe to.</p>
  * @export
  * @interface Subscription
  */

package/dist/src/models/tag-spec.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.11-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -16,7 +16,7 @@
  */
 export interface TagSpec {
     /**
-     *
+     * Color regex explanation.  <pre>  ^                 # start of the line  #                 # start with a number sign `#`  (                 # start of (group 1)    [a-fA-F0-9]{6}  # support z-f, A-F and 0-9, with a length of 6    |               # or    [a-fA-F0-9]{3}  # support z-f, A-F and 0-9, with a length of 3  )                 # end of (group 1)  $                 # end of the line  </pre>
      * @type {string}
      * @memberof TagSpec
      */

package/dist/src/models/tag-status.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.11-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/tag-vo.d.ts

@@ -2,7 +2,7 @@ import { Metadata } from './metadata';
 import { TagSpec } from './tag-spec';
 import { TagStatus } from './tag-status';
 /**
- *
+ * A value object for {@link Tag Tag}.
  * @export
  * @interface TagVo
  */

package/dist/src/models/template-content.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.11-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/template-descriptor.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.11-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * Type used to describe custom template page.
  * @export
  * @interface TemplateDescriptor
  */

package/dist/src/models/test-operation.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.11-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/theme-spec.d.ts

@@ -67,13 +67,6 @@ export interface ThemeSpec {
      * @memberof ThemeSpec
      */
     'repo'?: string;
-    /**
-     * Deprecated, use `requires` instead.
-     * @type {string}
-     * @memberof ThemeSpec
-     * @deprecated
-     */
-    'require'?: string;
     /**
      *
      * @type {string}
@@ -91,12 +84,5 @@ export interface ThemeSpec {
      * @type {string}
      * @memberof ThemeSpec
      */
-    'version': string;
-    /**
-     *
-     * @type {string}
-     * @memberof ThemeSpec
-     * @deprecated
-     */
-    'website'?: string;
+    'version'?: string;
 }

package/dist/src/models/theme.d.ts

@@ -2,7 +2,7 @@ import { Metadata } from './metadata';
 import { ThemeSpec } from './theme-spec';
 import { ThemeStatus } from './theme-status';
 /**
- *
+ * <p>Theme extension.</p>
  * @export
  * @interface Theme
  */

package/dist/src/models/thumbnail-spec.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.11-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/totp-auth-link-response.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.11-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -16,7 +16,7 @@
  */
 export interface TotpAuthLinkResponse {
     /**
-     *
+     * QR Code with base64 encoded.
      * @type {string}
      * @memberof TotpAuthLinkResponse
      */

package/dist/src/models/totp-request.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.11-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/two-factor-auth-settings.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.11-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -16,7 +16,7 @@
  */
 export interface TwoFactorAuthSettings {
     /**
-     *
+     * Check if 2FA is available.
      * @type {boolean}
      * @memberof TwoFactorAuthSettings
      */

package/dist/src/models/uc-upload-request-form-data.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.11-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/upgrade-from-uri-request.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.11-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/upload-from-url-request.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.11-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/user-connection-spec.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.11-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -16,25 +16,25 @@
  */
 export interface UserConnectionSpec {
     /**
-     *
+     * The unique identifier for the user\'s connection to the OAuth provider.  for example, the user\'s GitHub id.
      * @type {string}
      * @memberof UserConnectionSpec
      */
     'providerUserId': string;
     /**
-     *
+     * The name of the OAuth provider (e.g. Google, Facebook, Twitter).
      * @type {string}
      * @memberof UserConnectionSpec
      */
     'registrationId': string;
     /**
-     *
+     * The time when the user connection was last updated.
      * @type {string}
      * @memberof UserConnectionSpec
      */
     'updatedAt'?: string;
     /**
-     *
+     * The {@link Metadata#getName Metadata#getName()} of the user associated with the OAuth connection.
      * @type {string}
      * @memberof UserConnectionSpec
      */

package/dist/src/models/user-connection.d.ts

@@ -1,7 +1,7 @@
 import { Metadata } from './metadata';
 import { UserConnectionSpec } from './user-connection-spec';
 /**
- *
+ * User connection extension.
  * @export
  * @interface UserConnection
  */

package/dist/src/models/user-spec.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.11-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/user.d.ts

@@ -2,7 +2,7 @@ import { Metadata } from './metadata';
 import { UserSpec } from './user-spec';
 import { UserStatus } from './user-status';
 /**
- *
+ * The extension represents user details of Halo.
  * @export
  * @interface User
  */

package/dist/src/models/verify-code-request.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.11-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/vote-request.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.11-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@halo-dev/api-client",
-  "version": "2.20.21",
+  "version": "2.21.0",
   "description": "API Client for Halo 2",
   "homepage": "https://github.com/halo-dev/halo/tree/main/ui/packages/api-client#readme",
   "bugs": {