From c1b323db23c2e89161167de3ffb1b99183ea1c78 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Wed, 16 Oct 2024 09:58:01 +0300 Subject: [PATCH] fix order replaced in OAS response + framework tsdoc config --- .../src/classes/helpers/schema-factory.ts | 52 +++++-------------- .../packages/typedoc-config/framework.json | 8 +-- 2 files changed, 16 insertions(+), 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 index c5bcc3aee33f0..6be03bca6165a 100644 --- 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 index 63f3de15fe37e..269d62c131e19 100644 --- 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" ] } \ No newline at end of file