@halo-dev/api-client 2.20.0 → 2.21.0

package/dist/src/models/policy-rule.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.0-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,37 +10,37 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * PolicyRule holds information that describes a policy rule, but does not contain information  about whom the rule applies to or which namespace the rule applies to.
  * @export
  * @interface PolicyRule
  */
 export interface PolicyRule {
     /**
-     *
+     * APIGroups is the name of the APIGroup that contains the resources.  If multiple API groups are specified, any action requested against one of the enumerated  resources in any API group will be allowed.
      * @type {Array<string>}
      * @memberof PolicyRule
      */
     'apiGroups'?: Array<string>;
     /**
-     *
+     * NonResourceURLs is a set of partial urls that a user should have access to.  *s are allowed, but only as the full, final step in the path  If an action is not a resource API request, then the URL is split on \'/\' and is checked  against the NonResourceURLs to look for a match.  Since non-resource URLs are not namespaced, this field is only applicable for  ClusterRoles referenced from a ClusterRoleBinding.  Rules can either apply to API resources (such as \"pods\" or \"secrets\") or non-resource  URL paths (such as \"/api\"),  but not both.
      * @type {Array<string>}
      * @memberof PolicyRule
      */
     'nonResourceURLs'?: Array<string>;
     /**
-     *
+     * ResourceNames is an optional white list of names that the rule applies to.  An empty set  means that everything is allowed.
      * @type {Array<string>}
      * @memberof PolicyRule
      */
     'resourceNames'?: Array<string>;
     /**
-     *
+     * Resources is a list of resources this rule applies to.  \'*\' represents all resources in  the specified apiGroups.  \'*&#47;foo\' represents the subresource \'foo\' for all resources in the specified  apiGroups.
      * @type {Array<string>}
      * @memberof PolicyRule
      */
     'resources'?: Array<string>;
     /**
-     *
+     * about who the rule applies to or which namespace the rule applies to.
      * @type {Array<string>}
      * @memberof PolicyRule
      */

package/dist/src/models/policy-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.0-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/policy-template-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.0-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/post-request.d.ts

@@ -1,7 +1,7 @@
 import { ContentUpdateParam } from './content-update-param';
 import { Post } from './post';
 /**
- *
+ * Post and content data for creating and updating post.
  * @export
  * @interface PostRequest
  */

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

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

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

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

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

@@ -7,7 +7,7 @@ import { PostStatus } from './post-status';
 import { StatsVo } from './stats-vo';
 import { TagVo } from './tag-vo';
 /**
- *
+ * A value object for {@link Post Post}.
  * @export
  * @interface PostVo
  */

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

@@ -2,7 +2,7 @@ import { Metadata } from './metadata';
 import { PostSpec } from './post-spec';
 import { PostStatus } from './post-status';
 /**
- *
+ * <p>Post extension.</p>
  * @export
  * @interface Post
  */

package/dist/src/models/reason-attributes.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.0-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/reason-property.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.0-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/reason-selector.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.0-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/reason-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.0-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/reason-type-info.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.0-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/reason-type-notifier-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.0-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/reason-type.d.ts

@@ -1,7 +1,7 @@
 import { Metadata } from './metadata';
 import { ReasonTypeSpec } from './reason-type-spec';
 /**
- *
+ * <p>{@link ReasonType ReasonType} is a custom extension that defines a type of reason.</p>  <p>One {@link ReasonType ReasonType} can have multiple {@link Reason Reason}s to notify.</p>
  * @export
  * @interface ReasonType
  */

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

@@ -1,7 +1,7 @@
 import { Metadata } from './metadata';
 import { ReasonSpec } from './reason-spec';
 /**
- *
+ * <p>{@link Reason Reason} is a custom extension that defines a reason for a notification, It represents  an instance of a {@link ReasonType ReasonType}.</p>  <p>It can be understood as an event that triggers a notification.</p>
  * @export
  * @interface Reason
  */

package/dist/src/models/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.0-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/remember-me-token-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.0-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/remove-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.0-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/replace-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.0-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/reply-request.d.ts

@@ -1,6 +1,6 @@
 import { CommentEmailOwner } from './comment-email-owner';
 /**
- *
+ * A request parameter object for {@link Reply Reply}.
  * @export
  * @interface ReplyRequest
  */

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

@@ -36,7 +36,7 @@ export interface ReplySpec {
      */
     'content': string;
     /**
-     *
+     * The user-defined creation time default is <code>metadata.creationTimestamp</code>.
      * @type {string}
      * @memberof ReplySpec
      */

package/dist/src/models/reply-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.0-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/reverse-proxy.d.ts

@@ -1,7 +1,7 @@
 import { Metadata } from './metadata';
 import { ReverseProxyRule } from './reverse-proxy-rule';
 /**
- *
+ * <p>The reverse proxy custom resource is used to configure a path to proxy it to a directory or  file.</p>  <p>HTTP proxy may be added in the future.</p>
  * @export
  * @interface ReverseProxy
  */

package/dist/src/models/revert-snapshot-for-post-param.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.0-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/revert-snapshot-for-single-param.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.0-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/role-binding.d.ts

@@ -2,7 +2,7 @@ import { Metadata } from './metadata';
 import { RoleRef } from './role-ref';
 import { Subject } from './subject';
 /**
- *
+ * RoleBinding references a role, but does not contain it.  It can reference a Role in the global.  It adds who information via Subjects.
  * @export
  * @interface RoleBinding
  */
@@ -32,7 +32,7 @@ export interface RoleBinding {
      */
     'roleRef'?: RoleRef;
     /**
-     *
+     * Subjects holds references to the objects the role applies to.
      * @type {Array<Subject>}
      * @memberof RoleBinding
      */

package/dist/src/models/role-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.0-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,25 +10,25 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * RoleRef contains information that points to the role being used.
  * @export
  * @interface RoleRef
  */
 export interface RoleRef {
     /**
-     *
+     * APIGroup is the group for the resource being referenced.
      * @type {string}
      * @memberof RoleRef
      */
     'apiGroup'?: string;
     /**
-     *
+     * Kind is the type of resource being referenced.
      * @type {string}
      * @memberof RoleRef
      */
     'kind'?: string;
     /**
-     *
+     * Name is the name of resource being referenced.
      * @type {string}
      * @memberof RoleRef
      */

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.0-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.0-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.0-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.0-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.0-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.0-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
  */