chore: improve JS Client TSDoc comments (#5582)

* add oas schema to tsdoc parser

* add tsdoc (part 1)

* Finished tsdoc in js client

* general fixes

* added tsdoc in core medusa package

* parse schema tags in model files

* added maxlevel option

* added more tsdoc

* added tsdoc in core

* added TSDoc in core package

* generated client types

* support featureFlag and expandable tags

* added support for resource feature flag note

* fix api ignore plugin

* added eslint plugin

* support feature flag and expandable badges

* adjusted overview page + generated reference

* revert generated files

* added changeset

* add details about new typedoc options

* fix broken link

packages/types/src/common/common.ts

@@ -136,9 +136,21 @@ export type PaginatedResponse = {
   count: number
 }
 
+/**
+ * The fields returned in the response of a DELETE request.
+ */
 export type DeleteResponse = {
+  /**
+   * The ID of the item that was deleted.
+   */
   id: string
+  /**
+   * The type of the item that was deleted.
+   */
   object: string
+  /**
+   * Whether the item was deleted successfully.
+   */
   deleted: boolean
 }
 

packages/types/src/inventory/common.ts

@@ -9,6 +9,10 @@ import {
  * required:
  *   - sku
  * properties:
+ *   id:
+ *     description: The inventory item's ID.
+ *     type: string
+ *     example: "iitem_12334"
  *   sku:
  *     description: The Stock Keeping Unit (SKU) code of the Inventory Item.
  *     type: string

packages/types/src/stock-location/common.ts

@@ -144,6 +144,7 @@ export type StockLocationDTO = {
  *   - type: object
  *     properties:
  *       sales_channels:
+ *         description: "The associated sales channels."
  *         $ref: "#/components/schemas/SalesChannel"
  */
 export type StockLocationExpandedDTO = StockLocationDTO & {