@halo-dev/api-client 2.20.0 → 2.21.0

package/dist/src/models/halo-document.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.
  */
 /**
- *
+ * Document for search.
  * @export
  * @interface HaloDocument
  */
 export interface HaloDocument {
     /**
-     *
+     * Custom metadata. Make sure the map is serializable.
      * @type {{ [key: string]: string; }}
      * @memberof HaloDocument
      */
@@ -24,91 +24,91 @@ export interface HaloDocument {
         [key: string]: string;
     };
     /**
-     *
+     * Document categories. The item in the list is the category metadata name.
      * @type {Array<string>}
      * @memberof HaloDocument
      */
     'categories'?: Array<string>;
     /**
-     *
+     * Document content. Safety content, without HTML tag.
      * @type {string}
      * @memberof HaloDocument
      */
     'content': string;
     /**
-     *
+     * Document creation timestamp.
      * @type {string}
      * @memberof HaloDocument
      */
     'creationTimestamp'?: string;
     /**
-     *
+     * Document description.
      * @type {string}
      * @memberof HaloDocument
      */
     'description'?: string;
     /**
-     *
+     * Whether the document is exposed to the public.
      * @type {boolean}
      * @memberof HaloDocument
      */
     'exposed'?: boolean;
     /**
-     *
+     * Document ID. It should be unique globally.
      * @type {string}
      * @memberof HaloDocument
      */
     'id': string;
     /**
-     *
+     * Metadata name of the corresponding extension.
      * @type {string}
      * @memberof HaloDocument
      */
     'metadataName': string;
     /**
-     *
+     * Document owner metadata name.
      * @type {string}
      * @memberof HaloDocument
      */
     'ownerName': string;
     /**
-     *
+     * Document permalink.
      * @type {string}
      * @memberof HaloDocument
      */
     'permalink': string;
     /**
-     *
+     * Whether the document is published.
      * @type {boolean}
      * @memberof HaloDocument
      */
     'published'?: boolean;
     /**
-     *
+     * Whether the document is recycled.
      * @type {boolean}
      * @memberof HaloDocument
      */
     'recycled'?: boolean;
     /**
-     *
+     * Document tags. The item in the list is the tag metadata name.
      * @type {Array<string>}
      * @memberof HaloDocument
      */
     'tags'?: Array<string>;
     /**
-     *
+     * Document title.
      * @type {string}
      * @memberof HaloDocument
      */
     'title': string;
     /**
-     *
+     * Document type. e.g.: post.content.halo.run, singlepage.content.halo.run, moment.moment  .halo.run, doc.doc.halo.run.
      * @type {string}
      * @memberof HaloDocument
      */
     'type': string;
     /**
-     *
+     * Document update timestamp.
      * @type {string}
      * @memberof HaloDocument
      */

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

@@ -188,9 +188,6 @@ export * from './role-binding';
 export * from './role-binding-list';
 export * from './role-list';
 export * from './role-ref';
-export * from './search-engine';
-export * from './search-engine-list';
-export * from './search-engine-spec';
 export * from './search-option';
 export * from './search-result';
 export * from './secret';

package/dist/src/models/install-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.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/interest-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/license.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.
  */
 /**
- *
+ * Common data objects for license.
  * @export
  * @interface License
  */

package/dist/src/models/listed-auth-provider.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 listed value object for {@link run.halo.app.core.extension.AuthProvider run.halo.app.core.extension.AuthProvider}.
  * @export
  * @interface ListedAuthProvider
  */

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

@@ -6,7 +6,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 ListedPostVo
  */

package/dist/src/models/listed-snapshot-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/local-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.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).
@@ -16,13 +16,13 @@
  */
 export interface LocalThumbnailSpec {
     /**
-     *
+     * Consider the compatibility of the system and migration, use unix-style relative paths  here.
      * @type {string}
      * @memberof LocalThumbnailSpec
      */
     'filePath': string;
     /**
-     *
+     * A hash signature for the image uri.
      * @type {string}
      * @memberof LocalThumbnailSpec
      */
@@ -40,7 +40,7 @@ export interface LocalThumbnailSpec {
      */
     'size': LocalThumbnailSpecSizeEnum;
     /**
-     *
+     * A hash signature for the thumbnail uri.
      * @type {string}
      * @memberof LocalThumbnailSpec
      */

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

@@ -36,5 +36,5 @@ export interface LocalThumbnail {
      * @type {LocalThumbnailStatus}
      * @memberof LocalThumbnail
      */
-    'status'?: LocalThumbnailStatus;
+    'status': LocalThumbnailStatus;
 }

package/dist/src/models/login-history.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/mark-specified-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/menu-item-spec.d.ts

@@ -1,6 +1,6 @@
 import { Ref } from './ref';
 /**
- * The spec of menu item.
+ *
  * @export
  * @interface MenuItemSpec
  */

package/dist/src/models/menu-item-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).
@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 /**
- * The status of menu item.
+ *
  * @export
  * @interface MenuItemStatus
  */

package/dist/src/models/menu-item-vo.d.ts

@@ -2,13 +2,13 @@ import { MenuItemSpec } from './menu-item-spec';
 import { MenuItemStatus } from './menu-item-status';
 import { Metadata } from './metadata';
 /**
- *
+ * A value object for {@link MenuItem MenuItem}.
  * @export
  * @interface MenuItemVo
  */
 export interface MenuItemVo {
     /**
-     *
+     * Gets menu item\'s display name.
      * @type {string}
      * @memberof MenuItemVo
      */

package/dist/src/models/menu-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).
@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 /**
- * The spec of menu.
+ *
  * @export
  * @interface MenuSpec
  */
@@ -22,7 +22,7 @@ export interface MenuSpec {
      */
     'displayName': string;
     /**
-     * Names of menu children below this menu.
+     * Menu items of this menu.
      * @type {Array<string>}
      * @memberof MenuSpec
      */

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

@@ -2,7 +2,7 @@ import { MenuItemVo } from './menu-item-vo';
 import { MenuSpec } from './menu-spec';
 import { Metadata } from './metadata';
 /**
- *
+ * A value object for {@link Menu Menu}.
  * @export
  * @interface MenuVo
  */

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