chore: small fixes to tsdocs (#6341)

Small fixes of the TSDocs for the upcoming release
medusajs · Feb 12, 2024 · 1593e0b · 1593e0b
1 parent d37ff80
commit 1593e0b
Show file tree

Hide file tree

Showing 4 changed files with 122 additions and 120 deletions.
diff --git a/packages/generated/client-types/src/lib/models/AdminGetOrdersParams.ts b/packages/generated/client-types/src/lib/models/AdminGetOrdersParams.ts
@@ -156,7 +156,7 @@ export interface AdminGetOrdersParams {
    */
   fields?: string
   /**
-   * A order field to sort-order the retrieved orders by.
+   * Field to sort retrieved orders by.
    */
   order?: string
 }
diff --git a/packages/medusa-react/src/contexts/medusa.tsx b/packages/medusa-react/src/contexts/medusa.tsx
@@ -100,7 +100,8 @@ export interface MedusaProviderProps {
    */
   customHeaders?: Record<string, any>
   /**
-   * An instance of the Medusa JS Client. If you don't provide an instance, one will be created using the `baseUrl`, `apiKey`, `publishableApiKey`, `maxRetries`, and `customHeaders` props.
+   * An instance of the Medusa JS Client. If you don't provide an instance, one will be created using the `baseUrl`, `apiKey`, 
+   * `publishableApiKey`, `maxRetries`, and `customHeaders` props.
    */
   medusaClient: Medusa
 }

diff --git a/packages/medusa/src/api/routes/admin/orders/list-orders.ts b/packages/medusa/src/api/routes/admin/orders/list-orders.ts
@@ -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()