fix order replaced in OAS response + framework tsdoc config

medusajs · Oct 16, 2024 · c1b323d · c1b323d
1 parent 813efea
commit c1b323d
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 44 deletions.
diff --git a/www/utils/packages/docs-generator/src/classes/helpers/schema-factory.ts b/www/utils/packages/docs-generator/src/classes/helpers/schema-factory.ts
@@ -37,46 +37,6 @@ class SchemaFactory {
     BigNumberValue: {
       type: "number",
     },
-    expand: {
-      type: "string",
-      title: "expand",
-      description:
-        "Comma-separated relations that should be expanded in the returned data.",
-    },
-    fields: {
-      type: "string",
-      title: "fields",
-      description:
-        "Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields.",
-      externalDocs: {
-        url: "#select-fields-and-relations",
-      },
-    },
-    offset: {
-      type: "number",
-      title: "offset",
-      description: "The number of items to skip when retrieving a list.",
-      externalDocs: {
-        url: "#pagination",
-      },
-    },
-    limit: {
-      type: "number",
-      title: "limit",
-      description: "Limit the number of items returned in the list.",
-      externalDocs: {
-        url: "#pagination",
-      },
-    },
-    order: {
-      type: "string",
-      title: "order",
-      description:
-        "The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.",
-      externalDocs: {
-        url: "#pagination",
-      },
-    },
     File: {
       type: "object",
       description: "A File to upload.",
@@ -114,22 +74,34 @@ class SchemaFactory {
       title: "fields",
       description:
         "Comma-separated fields that should be included in the returned data. If a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. Without prefix it will replace the entire default fields.",
+      externalDocs: {
+        url: "#select-fields-and-relations",
+      },
     },
     offset: {
       type: "number",
       title: "offset",
       description: "The number of items to skip when retrieving a list.",
+      externalDocs: {
+        url: "#pagination",
+      },
     },
     limit: {
       type: "number",
       title: "limit",
       description: "Limit the number of items returned in the list.",
+      externalDocs: {
+        url: "#pagination",
+      },
     },
     order: {
       type: "string",
       title: "order",
       description:
         "The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.",
+      externalDocs: {
+        url: "#pagination",
+      },
     },
   }
 

diff --git a/www/utils/packages/typedoc-config/framework.json b/www/utils/packages/typedoc-config/framework.json
@@ -1,11 +1,11 @@
 {
   "$schema": "http://json.schemastore.org/tsconfig",
   "extends": [
-    "../../../../packages/framework/framework/tsconfig.json"
+    "../../../../packages/core/framework/tsconfig.json"
   ],
-  "include": ["../../../../packages/framework/framework/src"],
+  "include": ["../../../../packages/core/framework/src"],
   "exclude": [
-    "../../../../packages/framework/framework/dist", 
-    "../../../../packages/framework/framework/node_modules"
+    "../../../../packages/core/framework/dist", 
+    "../../../../packages/core/framework/node_modules"
   ]
 }