@halo-dev/api-client 2.20.21 → 2.21.0

package/dist/src/models/contributor.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.
  */
 /**
- *
+ * Contributor from user.
  * @export
  * @interface Contributor
  */

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

@@ -1,6 +1,6 @@
 import { Metadata } from './metadata';
 /**
- *
+ * A counter for number of requests by extension resource name.
  * @export
  * @interface Counter
  */

package/dist/src/models/create-user-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/dashboard-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).

package/dist/src/models/device-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/device-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/email-config-validation-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).
@@ -16,7 +16,7 @@
  */
 export interface EmailConfigValidationRequest {
     /**
-     *
+     * Gets email display name.
      * @type {string}
      * @memberof EmailConfigValidationRequest
      */
@@ -52,7 +52,7 @@ export interface EmailConfigValidationRequest {
      */
     'port'?: number;
     /**
-     *
+     * Gets email sender address.
      * @type {string}
      * @memberof EmailConfigValidationRequest
      */

package/dist/src/models/email-verify-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/excerpt.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/extension-definition.d.ts

@@ -1,7 +1,7 @@
 import { ExtensionSpec } from './extension-spec';
 import { Metadata } from './metadata';
 /**
- *
+ * Extension definition.  An {@link ExtensionDefinition ExtensionDefinition} is a type of metadata that provides additional information about  an extension. An extension is a way to add new functionality to an existing class, structure,  enumeration, or protocol type without needing to subclass it.
  * @export
  * @interface ExtensionDefinition
  */

package/dist/src/models/extension-point-definition.d.ts

@@ -1,7 +1,7 @@
 import { ExtensionPointSpec } from './extension-point-spec';
 import { Metadata } from './metadata';
 /**
- *
+ * Extension point definition.  An {@link ExtensionPointDefinition ExtensionPointDefinition} is a concept used in <code>Halo</code> to allow for the  dynamic extension of system. It defines a location within <code>Halo</code> where  additional functionality can be added through the use of plugins or extensions.
  * @export
  * @interface ExtensionPointDefinition
  */

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

@@ -1,6 +1,6 @@
 import { Metadata } from './metadata';
 /**
- *
+ * Extension is an interface which represents an Extension. It contains setters and getters of  GroupVersionKind and Metadata.
  * @export
  * @interface Extension
  */

package/dist/src/models/file-reverse-proxy-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.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/grant-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/group-kind.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,19 +10,19 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * GroupKind contains group and kind data only.
  * @export
  * @interface GroupKind
  */
 export interface GroupKind {
     /**
-     *
+     * is group name of Extension.
      * @type {string}
      * @memberof GroupKind
      */
     'group'?: string;
     /**
-     *
+     * is kind name of Extension.
      * @type {string}
      * @memberof GroupKind
      */

package/dist/src/models/group-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/group-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/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.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.
  */
 /**
- *
+ * 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.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/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.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/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.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.
  */
 /**
- *
+ * 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.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 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.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/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.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,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.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/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.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/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.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/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.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.
  */
 /**
- * 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.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.
  */
 /**
- * The spec of menu.
+ *
  * @export
  * @interface 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
  */