fix: swagger json schema

teableio · Dec 20, 2024 · 42ae4bb · 42ae4bb
1 parent bcbb977
commit 42ae4bb
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 3 deletions.
diff --git a/packages/openapi/src/generate.schema.ts b/packages/openapi/src/generate.schema.ts
@@ -14,7 +14,8 @@ function registerAllRoute() {
       type: 'http',
       scheme: 'bearer',
     });
-    registry.registerPath({ ...routeObj, security: [{ [bearerAuth.name]: [] }] });
+    const path = routeObj.path.startsWith('/') ? routeObj.path : `/${routeObj.path}`;
+    registry.registerPath({ ...routeObj, path, security: [{ [bearerAuth.name]: [] }] });
   }
   return registry;
 }

diff --git a/packages/openapi/src/share/view-get.ts b/packages/openapi/src/share/view-get.ts
@@ -18,7 +18,7 @@ export const shareViewGetVoSchema = z.object({
   shareMeta: shareViewMetaSchema.optional(),
   view: viewVoSchema.optional(),
   fields: fieldVoSchema.array(),
-  records: recordSchema.array().openapi('first 50 records'),
+  records: recordSchema.array().openapi({ description: 'first 50 records' }),
   extra: z
     .object({
       groupPoints: groupPointsVoSchema.optional().openapi({

diff --git a/packages/openapi/src/share/view-link-records.ts b/packages/openapi/src/share/view-link-records.ts
@@ -18,7 +18,10 @@ export const shareViewLinkRecordsRoSchema = getRecordsRoSchema
   .extend({
     fieldId: z.string(),
     search: z.string().optional(),
-    type: z.nativeEnum(ShareViewLinkRecordsType).optional().openapi('Only used for plugin views'),
+    type: z
+      .nativeEnum(ShareViewLinkRecordsType)
+      .optional()
+      .openapi({ description: 'Only used for plugin views' }),
   });
 
 export type IShareViewLinkRecordsRo = z.infer<typeof shareViewLinkRecordsRoSchema>;