UNPKG

@indexea/sdk

Version:

Indexea JavaScript SDK (indexea.com)

52 lines (51 loc) 1.86 kB
/** * Indexea OpenAPI * 这是 Indexea 搜索服务平台的 OpenAPI,用于描述平台的所有接口信息,你可以通过这个页面来了解和在线验证平台的所有接口信息。 ### Errors 本 API 使用标准的 HTTP 状态码来指示操作成功或者失败,如果失败将会在 body 中以 JSON 格式提供详细的错误信息,如下所示: ``` { \"error\": 404, \"message\": \"page not found\" } ``` * * The version of the OpenAPI document: 1.0.0 * Contact: indexea.com@gmail.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * 可用于通过参数进行自定义排序的字段 * @export * @interface QuerySortField */ export interface QuerySortField { /** * 排序字段名 * @type {string} * @memberof QuerySortField */ field?: string; /** * 排序字段在前端显示的名称 * @type {string} * @memberof QuerySortField */ label?: string; /** * 默认排序方式 * @type {string} * @memberof QuerySortField */ order?: QuerySortFieldOrderEnum; } /** * @export */ export declare const QuerySortFieldOrderEnum: { readonly Asc: "asc"; readonly Desc: "desc"; }; export type QuerySortFieldOrderEnum = typeof QuerySortFieldOrderEnum[keyof typeof QuerySortFieldOrderEnum]; /** * Check if a given object implements the QuerySortField interface. */ export declare function instanceOfQuerySortField(value: object): boolean; export declare function QuerySortFieldFromJSON(json: any): QuerySortField; export declare function QuerySortFieldFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuerySortField; export declare function QuerySortFieldToJSON(value?: QuerySortField | null): any;