fix: updates documentation and fixes script blockers (#765)

packages/medusa/src/api/routes/admin/orders/cancel-claim.js

@@ -8,7 +8,7 @@ import { defaultRelations, defaultFields } from "."
  * description: "Cancels a Claim"
  * parameters:
  *   - (path) id=* {string} The id of the Order.
- *   . (path) claim_id=* {string} The id of the Claim.
+ *   - (path) claim_id=* {string} The id of the Claim.
  * tags:
  *   - Claim
  * responses:
@@ -19,7 +19,7 @@ import { defaultRelations, defaultFields } from "."
  *         schema:
  *           properties:
  *             order:
- *               $ref: "#/components/schemas/claim"
+ *               $ref: "#/components/schemas/claim_order"
  */
 export default async (req, res) => {
   const { id, claim_id } = req.params

packages/medusa/src/api/routes/admin/orders/cancel-fulfillment-claim.js

@@ -2,7 +2,7 @@ import { MedusaError } from "medusa-core-utils"
 import { defaultRelations, defaultFields } from "."
 
 /**
- * @oas [post] orders//{id}/claims/{claim_id}/fulfillments/{fulfillment_id}/cancel
+ * @oas [post] /orders/{id}/claims/{claim_id}/fulfillments/{fulfillment_id}/cancel
  * operationId: "PostOrdersClaimFulfillmentsCancel"
  * summary: "Cancels a fulfilmment related to a Claim"
  * description: "Registers a Fulfillment as canceled."

packages/medusa/src/api/routes/admin/orders/cancel-swap.js

@@ -8,7 +8,7 @@ import { defaultRelations, defaultFields } from "."
  * description: "Cancels a Swap"
  * parameters:
  *   - (path) id=* {string} The id of the Order.
- *   . (path) swap_id=* {string} The id of the Swap.
+ *   - (path) swap_id=* {string} The id of the Swap.
  * tags:
  *   - Swap
  * responses:

packages/medusa/src/api/routes/admin/orders/create-swap.js

@@ -45,7 +45,7 @@ import { defaultFields, defaultRelations } from "./"
  *                 quantity:
  *                   description: The quantity of the Product Variant to ship.
  *                   type: integer
- *          custom_shipping_options:
+ *           custom_shipping_options:
  *             description: The custom shipping options to potentially create a Shipping Method from.
  *             type: array
  *             items:

packages/medusa/src/api/routes/store/customers/get-payment-methods.js

@@ -3,8 +3,6 @@
  * operationId: GetCustomersCustomerPaymentMethods
  * summary: Retrieve saved payment methods
  * description: "Retrieves a list of a Customer's saved payment methods. Payment methods are saved with Payment Providers and it is their responsibility to fetch saved methods."
- * parameters:
- *   - (path) id=* {string} The id of the Customer.
  * tags:
  *   - Customer
  * responses:

packages/medusa/src/api/routes/store/customers/list-orders.js

@@ -10,8 +10,6 @@ import {
  * operationId: GetCustomersCustomerOrders
  * summary: Retrieve Customer Orders
  * description: "Retrieves a list of a Customer's Orders."
- * parameters:
- *   - (path) id=* {string} The id of the Customer.
  * tags:
  *   - Customer
  * responses:

packages/medusa/src/models/custom-shipping-option.ts

@@ -1,5 +1,6 @@
 import {
-  BeforeInsert, Column,
+  BeforeInsert,
+  Column,
   CreateDateColumn,
   DeleteDateColumn,
   Entity,
@@ -8,16 +9,15 @@ import {
   ManyToOne,
   PrimaryColumn,
   Unique,
-  UpdateDateColumn
-} from "typeorm";
-import { ulid } from "ulid";
-import { DbAwareColumn, resolveDbType } from "../utils/db-aware-column";
-import { Cart } from './cart';
-import { ShippingOption } from "./shipping-option";
-
+  UpdateDateColumn,
+} from "typeorm"
+import { ulid } from "ulid"
+import { DbAwareColumn, resolveDbType } from "../utils/db-aware-column"
+import { Cart } from "./cart"
+import { ShippingOption } from "./shipping-option"
 
 @Entity()
-@Unique(['shipping_option_id', 'cart_id'])
+@Unique(["shipping_option_id", "cart_id"])
 export class CustomShippingOption {
   @PrimaryColumn()
   id: string
@@ -27,8 +27,8 @@ export class CustomShippingOption {
 
   @Index()
   @Column()
-  shipping_option_id: string;
-  
+  shipping_option_id: string
+
   @ManyToOne(() => ShippingOption)
   @JoinColumn({ name: "shipping_option_id" })
   shipping_option: ShippingOption
@@ -62,7 +62,7 @@ export class CustomShippingOption {
 }
 
 /**
- * @schema Custom shipping_option
+ * @schema custom_shipping_option
  * title: "Custom Shipping Option"
  * description: "Custom Shipping Options are 'overriden' Shipping Options. Store managers can attach a Custom Shipping Option to a cart in order to set a custom price for a particular Shipping Option"
  * x-resourceId: custom_shipping_option

packages/medusa/src/models/note.ts

@@ -77,7 +77,8 @@ export class Note {
  *     type: string
  *   author:
  *     description: "The author of the note."
- *     type: User
+ *     anyOf:
+ *       - $ref: "#/components/schemas/user"
  *   created_at:
  *     description: "The date with timezone at which the resource was created."
  *     type: string