@gct-paas/api 0.1.0-dev.5 → 0.1.0-dev.7

package/es/platform/service/apis/nav-page.service.d.ts

@@ -2,52 +2,80 @@ import type { AxiosRequestConfig } from 'axios';
 import type { NavPageRequest, NavPageResponse } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getPageListQuery {
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putUpdateDesignerJsonIdPathParams {
+  id: string;
+}
+export interface putIdPathParams {
+  id: string;
 }
 export interface NavPageService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: NavPageRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<NavPageResponse>>;
-  // 列表
-  getList(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<NavPageResponse[]>>;
-  // 分页列表
+  ): Promise<NavPageResponse>;
+  /**
+   * 列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<NavPageResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<NavPageResponse>>>;
-  // 修改页面设计Json
+  ): Promise<IPage<NavPageResponse>>;
+  /**
+   * 修改页面设计Json
+   */
   putUpdateDesignerJsonId(
+    path: putUpdateDesignerJsonIdPathParams,
     data: NavPageRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 修改
+  ): Promise<string>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: NavPageRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/es/platform/service/apis/openapi-group.service.d.ts

@@ -7,93 +7,179 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id唯一标识
+  /**
+   * id唯一标识
+   */
+  id: string;
 }
 export interface getInfoAssociationModelQuery {
-  appTag?: string; // 应用标识
-  env?: string; // 环境
-  name?: string; // 关联模型名称
+  /**
+   * 应用标识
+   */
+  appTag?: string;
+  /**
+   * 环境
+   */
+  env?: string;
+  /**
+   * 关联模型名称
+   */
+  name?: string;
 }
 export interface getInfoOpenapiInfoQuery {
-  appTag?: string; // 应用标识
-  env?: string; // 环境
-  id?: string; // 接口id
+  /**
+   * 应用标识
+   */
+  appTag?: string;
+  /**
+   * 环境
+   */
+  env?: string;
+  /**
+   * 接口id
+   */
+  id?: string;
 }
 export interface getInfoPageListQuery {
-  appTag?: string; // 应用标识
-  env?: string; // 环境
-  key?: string; // 接口标识
-  modelKey?: string; // 关联模型
-  name?: string; // 接口名称
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * 应用标识
+   */
+  appTag?: string;
+  /**
+   * 环境
+   */
+  env?: string;
+  /**
+   * 接口标识
+   */
+  key?: string;
+  /**
+   * 关联模型
+   */
+  modelKey?: string;
+  /**
+   * 接口名称
+   */
+  name?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
 }
 export interface getListDownloadQuery {
-  appTag?: string; // 应用标识
-  env?: string; // 环境
+  /**
+   * 应用标识
+   */
+  appTag?: string;
+  /**
+   * 环境
+   */
+  env?: string;
 }
 export interface getPageListQuery {
-  appId?: string; // 应用标识
-  env?: string; // 环境
-  name?: string; // 应用名称
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * 应用标识
+   */
+  appId?: string;
+  /**
+   * 环境
+   */
+  env?: string;
+  /**
+   * 应用名称
+   */
+  name?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface OpenapiGroupService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: OpenapiGroupRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 分组详情-基础信息
+  ): Promise<string>;
+  /**
+   * 分组详情-基础信息
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<OpenapiGroupResponse>>;
-  // 分组详情-关联模型列表
+  ): Promise<OpenapiGroupResponse>;
+  /**
+   * 分组详情-关联模型列表
+   */
   getInfoAssociationModel(
     query: getInfoAssociationModelQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IObject>>;
-  // 分组详情-api管理列表-单个接口详情
+  ): Promise<IObject>;
+  /**
+   * 分组详情-api管理列表-单个接口详情
+   */
   getInfoOpenapiInfo(
     query: getInfoOpenapiInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<ApiInfo>>;
-  // 分组详情-api管理列表
+  ): Promise<ApiInfo>;
+  /**
+   * 分组详情-api管理列表
+   */
   getInfoPageList(
     query: getInfoPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<OpenapiResponse>>>;
-  // 列表
+  ): Promise<IPage<OpenapiResponse>>;
+  /**
+   * 列表
+   */
   getList(
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<OpenapiGroupResponse[]>>;
-  // 分组PDF导出
+  ): Promise<OpenapiGroupResponse[]>;
+  /**
+   * 分组PDF导出
+   */
   getListDownload(
     query: getListDownloadQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<unknown>>;
-  // 分页列表
+  ): Promise<unknown>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<OpenapiGroupResponse>>>;
-  // 修改
+  ): Promise<IPage<OpenapiGroupResponse>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: OpenapiGroupRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/es/platform/service/apis/openapi-key-grant.service.d.ts

@@ -7,57 +7,91 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getOpenapiListQuery {
-  appTag?: string; // 应用标识
-  env?: string; // 环境
+  /**
+   * 应用标识
+   */
+  appTag?: string;
+  /**
+   * 环境
+   */
+  env?: string;
 }
 export interface getPageListQuery {
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface OpenapiKeyGrantService {
-  // 新建保存
-  post(config?: Partial<AxiosRequestConfig>): Promise<IHttpResponse<string>>;
-  // 删除
+  /**
+   * 新建保存
+   */
+  post(config?: Partial<AxiosRequestConfig>): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 授权信息详情
+  ): Promise<string>;
+  /**
+   * 授权信息详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<OpenapiKeyGrantResponse>>;
-  // 列表
+  ): Promise<OpenapiKeyGrantResponse>;
+  /**
+   * 列表
+   */
   getList(
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<OpenapiKeyGrantResponse[]>>;
-  // 已开放api列表
+  ): Promise<OpenapiKeyGrantResponse[]>;
+  /**
+   * 已开放api列表
+   */
   getOpenapiList(
     query: getOpenapiListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<OpenapiAggregateByModelTreeResponse[]>>;
-  // 已开放租户api列表
+  ): Promise<OpenapiAggregateByModelTreeResponse[]>;
+  /**
+   * 已开放租户api列表
+   */
   getOpenapiTenantList(
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<OpenapiAggregateResponse[]>>;
-  // 分页列表
+  ): Promise<OpenapiAggregateResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<OpenapiKeyGrantResponse>>>;
-  // 授权接口修改
+  ): Promise<IPage<OpenapiKeyGrantResponse>>;
+  /**
+   * 授权接口修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: OpenapiAuthorizationSetRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/es/platform/service/apis/org-user-picker.service.d.ts

@@ -2,37 +2,69 @@ import type { AxiosRequestConfig } from 'axios';
 import type { PickerUserDTO, PickerOrgDTO } from '../entities';
 
 export interface getManagementUserListByIdsQuery {
-  ids?: string; // ids
+  /**
+   * ids
+   */
+  ids?: string;
 }
 export interface getTenantManagementOrgUserPageListQuery {
-  keyword?: string; // 关键字
-  orgId?: string; // 部门id
-  pageNo?: number; // 页码
-  pageSize?: number; // 分页大小
-  sortField?: string; // 排序字段
-  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
+  /**
+   * 关键字
+   */
+  keyword?: string;
+  /**
+   * 部门id
+   */
+  orgId?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
 }
 export interface getTenantManagementUserListByIdsQuery {
-  ids?: string; // ids
+  /**
+   * ids
+   */
+  ids?: string;
 }
 export interface OrgUserPickerService {
-  // 后台查询指定id的用户
+  /**
+   * 后台查询指定id的用户
+   */
   getManagementUserListByIds(
     query: getManagementUserListByIdsQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PickerUserDTO[]>>;
-  // 租户后台查询所有组织
+  ): Promise<PickerUserDTO[]>;
+  /**
+   * 租户后台查询所有组织
+   */
   getTenantManagementOrgList(
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PickerOrgDTO[]>>;
-  // 租户后台分页查询指定部门下的用户
+  ): Promise<PickerOrgDTO[]>;
+  /**
+   * 租户后台分页查询指定部门下的用户
+   */
   getTenantManagementOrgUserPageList(
     query: getTenantManagementOrgUserPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<PickerUserDTO>>>;
-  // 租户后台查询指定id的用户
+  ): Promise<IPage<PickerUserDTO>>;
+  /**
+   * 租户后台查询指定id的用户
+   */
   getTenantManagementUserListByIds(
     query: getTenantManagementUserListByIdsQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PickerUserDTO[]>>;
+  ): Promise<PickerUserDTO[]>;
 }