@halo-dev/api-client 2.20.21 → 2.21.0

package/dist/src/models/metadata.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.
  */
 /**
- *
+ * Metadata of Extension.
  * @export
  * @interface Metadata
  */
 export interface Metadata {
     /**
-     *
+     * Annotations are like key-value format.
      * @type {{ [key: string]: string; }}
      * @memberof Metadata
      */
@@ -24,13 +24,13 @@ export interface Metadata {
         [key: string]: string;
     };
     /**
-     *
+     * Creation timestamp of the Extension.
      * @type {string}
      * @memberof Metadata
      */
     'creationTimestamp'?: string | null;
     /**
-     *
+     * Deletion timestamp of the Extension.
      * @type {string}
      * @memberof Metadata
      */
@@ -48,7 +48,7 @@ export interface Metadata {
      */
     'generateName'?: string;
     /**
-     *
+     * Labels are like key-value format.
      * @type {{ [key: string]: string; }}
      * @memberof Metadata
      */
@@ -62,7 +62,7 @@ export interface Metadata {
      */
     'name': string;
     /**
-     *
+     * Current version of the Extension. It will be bumped up every update.
      * @type {number}
      * @memberof Metadata
      */

package/dist/src/models/move-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/navigation-post-vo.d.ts

@@ -1,6 +1,6 @@
 import { PostVo } from './post-vo';
 /**
- *
+ * Post navigation vo to hold previous and next item.
  * @export
  * @interface NavigationPostVo
  */

package/dist/src/models/notification-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/notification-template.d.ts

@@ -1,7 +1,7 @@
 import { Metadata } from './metadata';
 import { NotificationTemplateSpec } from './notification-template-spec';
 /**
- *
+ * <p>{@link NotificationTemplate NotificationTemplate} is a custom extension that defines a notification template.</p>  <p>It describes the notification template\'s name, description, and the template content.</p>  <p>{@link Spec#getReasonSelector Spec#getReasonSelector()} is used to select the template by reasonType and language,  if multiple templates are matched, the best match will be selected. This is useful when you  want to override the default template.</p>
  * @export
  * @interface NotificationTemplate
  */

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

@@ -1,7 +1,7 @@
 import { Metadata } from './metadata';
 import { NotificationSpec } from './notification-spec';
 /**
- *
+ * <p>{@link Notification Notification} is a custom extension that used to store notification information for  inner use, it\'s on-site notification.</p>   <p>Supports the following operations:</p>  <ul>     <li>Marked as read: {@link NotificationSpec#setUnread(boolean) NotificationSpec#setUnread(boolean)}</li>     <li>Get the last read time: {@link NotificationSpec#getLastReadAt NotificationSpec#getLastReadAt()}</li>     <li>Filter by recipient: {@link NotificationSpec#getRecipient NotificationSpec#getRecipient()}</li>  </ul>
  * @export
  * @interface Notification
  */

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

@@ -1,7 +1,7 @@
 import { Metadata } from './metadata';
 import { NotifierDescriptorSpec } from './notifier-descriptor-spec';
 /**
- *
+ * <p>{@link NotifierDescriptor NotifierDescriptor} is a custom extension that defines a notifier.</p>  <p>It describes the notifier\'s name, description, and the extension name of the notifier to  let the user know what the notifier is and what it can do in the UI and also let the  <code>NotificationCenter</code> know how to load the notifier and prepare the notifier\'s settings.</p>
  * @export
  * @interface NotifierDescriptor
  */

package/dist/src/models/notifier-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.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/notifier-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/owner-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.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.
  */
 /**
- *
+ * Comment owner info.
  * @export
  * @interface OwnerInfo
  */

package/dist/src/models/password-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/pat-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/plugin-author.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/plugin-running-state-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/plugin-spec.d.ts

@@ -60,13 +60,6 @@ export interface PluginSpec {
      * @memberof PluginSpec
      */
     'logo'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof PluginSpec
-     * @deprecated
-     */
-    'pluginClass'?: string;
     /**
      *
      * @type {{ [key: string]: string; }}
@@ -82,7 +75,7 @@ export interface PluginSpec {
      */
     'repo'?: string;
     /**
-     *
+     * SemVer format.
      * @type {string}
      * @memberof PluginSpec
      */
@@ -94,7 +87,7 @@ export interface PluginSpec {
      */
     'settingName'?: string;
     /**
-     *
+     * plugin version.
      * @type {string}
      * @memberof PluginSpec
      */

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

@@ -2,7 +2,7 @@ import { Metadata } from './metadata';
 import { PluginSpec } from './plugin-spec';
 import { PluginStatus } from './plugin-status';
 /**
- *
+ * A custom resource for Plugin.
  * @export
  * @interface Plugin
  */

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