chore: small fixes to tsdocs (#6341)

Small fixes of the TSDocs for the upcoming release
This commit is contained in:
Shahed Nasser
2024-02-12 16:26:27 +00:00
committed by GitHub
parent d37ff8024d
commit 1593e0b192
4 changed files with 122 additions and 120 deletions
@@ -152,7 +152,7 @@ import { cleanResponseData } from "../../../../utils/clean-response-data"
* - (query) limit=50 {integer} Limit the number of orders returned.
* - (query) expand {string} Comma-separated relations that should be expanded in the returned order.
* - (query) fields {string} Comma-separated fields that should be included in the returned order.
* - (query) order {string} A order field to sort-order the retrieved orders by.
* - (query) order {string} Field to sort retrieved orders by.
* x-codegen:
* method: list
* queryParams: AdminGetOrdersParams
@@ -280,7 +280,8 @@ export class AdminGetOrdersParams extends AdminListOrdersSelector {
fields?: string
/**
* 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 `-`.
* The field to sort retrieved orders by. By default, the sort order is ascending.
* To change the order to descending, prefix the field name with `-`.
*/
@IsOptional()
@IsString()