UNPKG

@indexea/sdk

Version:

Indexea JavaScript SDK (indexea.com)

74 lines (73 loc) 2.9 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. */ import * as runtime from '../runtime'; export interface OptionsGetRequest { name: string; keys: string; } /** * */ export declare class GlobalApi extends runtime.BaseAPI { /** * 获取 OpenAPI 接口定义(JSON) * 接口定义(JSON) */ jsonRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>; /** * 获取 OpenAPI 接口定义(JSON) * 接口定义(JSON) */ json(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>; /** * 系统全局配置接口 */ optionsGetRaw(requestParameters: OptionsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>; /** * 系统全局配置接口 */ optionsGet(requestParameters: OptionsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>; /** * 数据库服务状态测试 */ statusDatabaseRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>; /** * 数据库服务状态测试 */ statusDatabase(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>; /** * 搜索引擎状态测试 */ statusEngineRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>; /** * 搜索引擎状态测试 */ statusEngine(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>; /** * 接口欢迎信息 */ welcomeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>; /** * 接口欢迎信息 */ welcome(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>; /** * 获取 OpenAPI 接口定义(YAML) * 接口定义(YAML) */ yamlRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>; /** * 获取 OpenAPI 接口定义(YAML) * 接口定义(YAML) */ yaml(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>; }