docs: oas (#197)

Adds OpenAPI specification of Storefront and Admin APIs.
Updates docs project.

docs/api/admin-spec3-base.json

@@ -0,0 +1,74 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "version": "1.0.0",
+    "title": "Medusa Admin API",
+    "license": {
+      "name": "MIT"
+    }
+  },
+  "tags": [
+    {
+      "name": "Auth",
+      "description": "Auth endpoints allows authorization of admin Users and manages their sessions."
+    },
+    {
+      "name": "Collection",
+      "x-resourceId": "product_collection"
+    },
+    {
+      "name": "Customer",
+      "x-resourceId": "customer"
+    },
+    {
+      "name": "Discount",
+      "x-resourceId": "discount"
+    },
+    {
+      "name": "Gift Card",
+      "x-resourceId": "gift_card"
+    },
+    {
+      "name": "Notification",
+      "x-resourceId": "notification"
+    },
+    {
+      "name": "Order",
+      "x-resourceId": "order"
+    },
+    {
+      "name": "Product",
+      "x-resourceId": "product"
+    },
+    {
+      "name": "Region",
+      "x-resourceId": "region"
+    },
+    {
+      "name": "Return",
+      "x-resourceId": "return"
+    },
+    {
+      "name": "Shipping Option",
+      "x-resourceId": "shipping_option"
+    },
+    {
+      "name": "Shipping Profile",
+      "x-resourceId": "shipping_profile"
+    },
+    {
+      "name": "Swap",
+      "x-resourceId": "swap"
+    },
+    {
+      "name": "Product Variant",
+      "x-resourceId": "product_variant"
+    }
+  ],
+  "servers": [
+    {
+      "url": "https://api.medusa-commerce.com/admin"
+    }
+  ],
+  "paths": {}
+}

docs/api/admin-spec3.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"version":"1.0.0","title":"Medusa Admin API","license":{"name":"MIT"}},"tags":[{"name":"Auth","description":"Auth endpoints allows authorization of admin Users and manages their sessions."},{"name":"Collection","x-resourceId":"product_collection"},{"name":"Customer","x-resourceId":"customer"},{"name":"Discount","x-resourceId":"discount"},{"name":"Gift Card","x-resourceId":"gift_card"},{"name":"Notification","x-resourceId":"notification"},{"name":"Order","x-resourceId":"order"},{"name":"Product","x-resourceId":"product"},{"name":"Region","x-resourceId":"region"},{"name":"Return","x-resourceId":"return"},{"name":"Shipping Option","x-resourceId":"shipping_option"},{"name":"Shipping Profile","x-resourceId":"shipping_profile"},{"name":"Swap","x-resourceId":"swap"},{"name":"Product Variant","x-resourceId":"product_variant"}],"servers":[{"url":"https://api.medusa-commerce.com/admin"}],"paths":{"/auth":{"post":{"operationId":"PostAuth","summary":"Authenticate a User","description":"Logs a User in and authorizes them to manage Store settings.","parameters":[],"tags":["Auth"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"properties":{"customer":{"title":"User","description":"Represents a User who can manage store settings.","x-resourceId":"user","properties":{"id":{"description":"The unique id of the User. This will be prefixed with `usr_`","type":"string"},"email":{"description":"The email of the User","type":"string"},"first_name":{"type":"string"},"last_name":{"description":"The Customer's billing address.","anyOf":[{"title":"Address","description":"An address.","x-resourceId":"address","properties":{"id":{"type":"string"},"customer_id":{"type":"string"},"company":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"address_1":{"type":"string"},"address_2":{"type":"string"},"city":{"type":"string"},"country_code":{"type":"string"},"country":{"title":"Country","description":"Country details","x-resourceId":"country","properties":{"id":{"description":"The database id of the country","type":"integer"},"iso_2":{"description":"The 2 character ISO code for the country.","type":"string"},"iso_3":{"description":"The 3 character ISO code for the country.","type":"string"},"num_code":{"description":"The numerical ISO code for the country.","type":"string"},"name":{"description":"The normalized country name; in upper case.","type":"string"},"display_name":{"description":"The country name appropriate for display.","type":"string"}}}}}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"deleted_at":{"type":"string","format":"date-time"},"metadata":{"type":"object"}}}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["email","password"],"properties":{"email":{"type":"string","description":"The User's email."},"password":{"type":"string","description":"The User's password."}}}}}}},"get":{"operationId":"GetAuth","summary":"Get Session","description":"Gets the currently logged in User.","tags":["Auth"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"properties":{"customer":{"title":"User","description":"Represents a User who can manage store settings.","x-resourceId":"user","properties":{"id":{"description":"The unique id of the User. This will be prefixed with `usr_`","type":"string"},"email":{"description":"The email of the User","type":"string"},"first_name":{"type":"string"},"last_name":{"description":"The Customer's billing address.","anyOf":[{"title":"Address","description":"An address.","x-resourceId":"address","properties":{"id":{"type":"string"},"customer_id":{"type":"string"},"company":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"address_1":{"type":"string"},"address_2":{"type":"string"},"city":{"type":"string"},"country_code":{"type":"string"},"country":{"title":"Country","description":"Country details","x-resourceId":"country","properties":{"id":{"description":"The database id of the country","type":"integer"},"iso_2":{"description":"The 2 character ISO code for the country.","type":"string"},"iso_3":{"description":"The 3 character ISO code for the country.","type":"string"},"num_code":{"description":"The numerical ISO code for the country.","type":"string"},"name":{"description":"The normalized country name; in upper case.","type":"string"},"display_name":{"description":"The country name appropriate for display.","type":"string"}}}}}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"deleted_at":{"type":"string","format":"date-time"},"metadata":{"type":"object"}}}}}}}}}}},"/customers":{"post":{"operationId":"PostCustomers","summary":"Create a Customer","description":"Creates a Customer.","parameters":[],"tags":["Customer"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"properties":Line truncated

docs/api/fixtures.json

@@ -0,0 +1,735 @@
+{
+  "resources": {
+    "customer": {
+      "id": "cus_01F0BGFY6ANPB473KJ5H8V889M",
+      "email": "test1@email.com",
+      "first_name": null,
+      "last_name": null,
+      "billing_address_id": null,
+      "password_hash": null,
+      "phone": null,
+      "has_account": false,
+      "orders": [],
+      "created_at": "2021-03-09T12:48:21.706Z",
+      "updated_at": "2021-03-09T12:48:21.706Z",
+      "deleted_at": null,
+      "metadata": null
+    },
+    "order": {
+      "id": "order_01F0BGFG2Z0X0ETETP0YS0HRCT",
+      "status": "pending",
+      "fulfillment_status": "not_fulfilled",
+      "payment_status": "not_paid",
+      "display_id": 1,
+      "cart_id": null,
+      "customer_id": "cus_01F0BGFG280DRD18VXM1F9GJXA",
+      "customer": {
+        "id": "cus_01F0BGFG280DRD18VXM1F9GJXA",
+        "email": "test@email.com",
+        "first_name": null,
+        "last_name": null,
+        "billing_address_id": null,
+        "password_hash": null,
+        "phone": null,
+        "has_account": false,
+        "created_at": "2021-03-09T12:48:07.240Z",
+        "updated_at": "2021-03-09T12:48:07.240Z",
+        "deleted_at": null,
+        "metadata": null
+      },
+      "email": "test@email.com",
+      "billing_address": {
+        "id": "addr_01F0BGFG30PG1NP6V0EDJDF6PW",
+        "customer_id": null,
+        "company": null,
+        "first_name": "lebron",
+        "last_name": null,
+        "address_1": null,
+        "address_2": null,
+        "city": null,
+        "country_code": null,
+        "province": null,
+        "postal_code": null,
+        "phone": null,
+        "created_at": "2021-03-09T12:48:07.263Z",
+        "updated_at": "2021-03-09T12:48:07.263Z",
+        "deleted_at": null,
+        "metadata": null
+      },
+      "shipping_address": {
+        "id": "addr_01F0BGFG30EBKX6C89N35YB2PX",
+        "customer_id": null,
+        "company": null,
+        "first_name": "lebron",
+        "last_name": null,
+        "address_1": null,
+        "address_2": null,
+        "city": null,
+        "country_code": "us",
+        "province": null,
+        "postal_code": null,
+        "phone": null,
+        "created_at": "2021-03-09T12:48:07.263Z",
+        "updated_at": "2021-03-09T12:48:07.263Z",
+        "deleted_at": null,
+        "metadata": null
+      },
+      "region_id": "reg_01F0BGFG21NC3VQ662FYNF3P4Z",
+      "region": {
+        "id": "reg_01F0BGFG21NC3VQ662FYNF3P4Z",
+        "name": "Test Region",
+        "currency_code": "usd",
+        "tax_rate": "0",
+        "tax_code": null,
+        "payment_providers": [],
+        "fulfillment_providers": [],
+        "created_at": "2021-03-09T12:48:07.233Z",
+        "updated_at": "2021-03-09T12:48:07.233Z",
+        "deleted_at": null,
+        "metadata": null
+      },
+      "currency_code": "usd",
+      "tax_rate": 0,
+      "discounts": [
+        {
+          "id": "test-discount",
+          "code": "TEST134",
+          "is_dynamic": false,
+          "rule_id": "dru_01F0BGFG30S3FSBE67PKDCTT0Y",
+          "rule": {
+            "id": "dru_01F0BGFG30S3FSBE67PKDCTT0Y",
+            "description": "Test Discount",
+            "type": "percentage",
+            "value": 10,
+            "allocation": "total",
+            "usage_limit": null,
+            "created_at": "2021-03-09T12:48:07.263Z",
+            "updated_at": "2021-03-09T12:48:07.263Z",
+            "deleted_at": null,
+            "metadata": null
+          },
+          "is_disabled": false,
+          "parent_discount_id": null,
+          "starts_at": "2021-03-09T12:48:07.263Z",
+          "ends_at": null,
+          "created_at": "2021-03-09T12:48:07.263Z",
+          "updated_at": "2021-03-09T12:48:07.263Z",
+          "deleted_at": null,
+          "metadata": null
+        }
+      ],
+      "gift_cards": [],
+      "shipping_methods": [
+        {
+          "id": "sm_01F0BGFG3SQZC01D8JP4REY0RF",
+          "shipping_option_id": "so_01F0BGFG2DV0GR6VD87AQ7XAB2",
+          "order_id": "order_01F0BGFG2Z0X0ETETP0YS0HRCT",
+          "claim_order_id": null,
+          "cart_id": null,
+          "swap_id": null,
+          "return_id": null,
+          "shipping_option": {
+            "id": "so_01F0BGFG2DV0GR6VD87AQ7XAB2",
+            "name": "test-option",
+            "region_id": "reg_01F0BGFG21NC3VQ662FYNF3P4Z",
+            "profile_id": "sp_01F0BGFG04GKTA9FTYWBT19NKJ",
+            "provider_id": "test-ful",
+            "price_type": "flat_rate",
+            "amount": 1000,
+            "is_return": false,
+            "data": {},
+            "created_at": "2021-03-09T12:48:07.245Z",
+            "updated_at": "2021-03-09T12:48:07.245Z",
+            "deleted_at": null,
+            "metadata": null
+          },
+          "price": 1000,
+          "data": {}
+        }
+      ],
+      "payments": [
+        {
+          "id": "test-payment",
+          "swap_id": null,
+          "cart_id": null,
+          "order_id": "order_01F0BGFG2Z0X0ETETP0YS0HRCT",
+          "amount": 10000,
+          "currency_code": "usd",
+          "amount_refunded": 0,
+          "provider_id": "test",
+          "data": {},
+          "captured_at": null,
+          "canceled_at": null,
+          "created_at": "2021-03-09T12:48:07.263Z",
+          "updated_at": "2021-03-09T12:48:07.263Z",
+          "metadata": null,
+          "idempotency_key": null
+        }
+      ],
+      "fulfillments": [],
+      "returns": [],
+      "claims": [],
+      "refunds": [],
+      "swaps": [],
+      "items": [
+        {
+          "id": "test-item",
+          "cart_id": null,
+          "order_id": "order_01F0BGFG2Z0X0ETETP0YS0HRCT",
+          "swap_id": null,
+          "claim_order_id": null,
+          "title": "Line Item",
+          "description": "Line Item Desc",
+          "thumbnail": "https://test.js/1234",
+          "is_giftcard": false,
+          "should_merge": true,
+          "allow_discounts": true,
+          "has_shipping": null,
+          "unit_price": 8000,
+          "variant_id": null,
+          "variant": null,
+          "quantity": 1,
+          "fulfilled_quantity": 1,
+          "returned_quantity": null,
+          "shipped_quantity": null,
+          "created_at": "2021-03-09T12:48:07.263Z",
+          "updated_at": "2021-03-09T12:48:07.263Z",
+          "metadata": null,
+          "refundable": 7200
+        }
+      ],
+      "gift_card_transactions": [],
+      "canceled_at": null,
+      "created_at": "2021-03-09T12:48:07.263Z",
+      "updated_at": "2021-03-09T12:48:07.263Z",
+      "metadata": null,
+      "shipping_total": 1000,
+      "gift_card_total": 0,
+      "discount_total": 800,
+      "tax_total": 0,
+      "subtotal": 8000,
+      "total": 8200,
+      "refunded_total": 0,
+      "refundable_amount": 8200
+    },
+    "product": {
+      "id": "prod_01F0BGG4MWSZH7YYJGHGZMQKHM",
+      "title": "Test product",
+      "subtitle": null,
+      "description": "test-product-description",
+      "handle": "test-product",
+      "is_giftcard": false,
+      "images": [],
+      "thumbnail": null,
+      "options": [
+        {
+          "id": "opt_01F0BGG4N2W8EZJP5KDV0W2250",
+          "title": "size",
+          "product_id": "prod_01F0BGG4MWSZH7YYJGHGZMQKHM",
+          "created_at": "2021-03-09T12:48:28.304Z",
+          "updated_at": "2021-03-09T12:48:28.304Z",
+          "deleted_at": null,
+          "metadata": null
+        },
+        {
+          "id": "opt_01F0BGG4N3Q09ME0BEZG6XZGFQ",
+          "title": "color",
+          "product_id": "prod_01F0BGG4MWSZH7YYJGHGZMQKHM",
+          "created_at": "2021-03-09T12:48:28.304Z",
+          "updated_at": "2021-03-09T12:48:28.304Z",
+          "deleted_at": null,
+          "metadata": null
+        }
+      ],
+      "variants": [
+        {
+          "id": "variant_01F0BGG4NYDVW4V6AHKB58DQWT",
+          "title": "Test variant",
+          "product_id": "prod_01F0BGG4MWSZH7YYJGHGZMQKHM",
+          "product": {
+            "id": "prod_01F0BGG4MWSZH7YYJGHGZMQKHM",
+            "title": "Test product",
+            "subtitle": null,
+            "description": "test-product-description",
+            "handle": "test-product",
+            "is_giftcard": false,
+            "thumbnail": null,
+            "profile_id": "sp_01F0BGG4J2RGH25WZVP8S6VNGW",
+            "weight": null,
+            "length": null,
+            "height": null,
+            "width": null,
+            "hs_code": null,
+            "origin_country": null,
+            "mid_code": null,
+            "material": null,
+            "collection_id": "test-collection",
+            "type_id": "test-type",
+            "created_at": "2021-03-09T12:48:28.304Z",
+            "updated_at": "2021-03-09T12:48:28.304Z",
+            "deleted_at": null,
+            "metadata": null
+          },
+          "prices": [
+            {
+              "id": "ma_01F0BGG4P5K0TCMD72MJFS0M65",
+              "currency_code": "usd",
+              "amount": 100,
+              "sale_amount": null,
+              "variant_id": "variant_01F0BGG4NYDVW4V6AHKB58DQWT",
+              "region_id": null,
+              "created_at": "2021-03-09T12:48:28.304Z",
+              "updated_at": "2021-03-09T12:48:28.304Z",
+              "deleted_at": null
+            }
+          ],
+          "sku": null,
+          "barcode": null,
+          "ean": null,
+          "upc": null,
+          "inventory_quantity": 10,
+          "allow_backorder": false,
+          "manage_inventory": true,
+          "hs_code": null,
+          "origin_country": null,
+          "mid_code": null,
+          "material": null,
+          "weight": null,
+          "length": null,
+          "height": null,
+          "width": null,
+          "options": [
+            {
+              "id": "optval_01F0BGG4NY1PRPV3FXQ3J66GQH",
+              "value": "large",
+              "option_id": "opt_01F0BGG4N2W8EZJP5KDV0W2250",
+              "variant_id": "variant_01F0BGG4NYDVW4V6AHKB58DQWT",
+              "created_at": "2021-03-09T12:48:28.304Z",
+              "updated_at": "2021-03-09T12:48:28.304Z",
+              "deleted_at": null,
+              "metadata": null
+            },
+            {
+              "id": "optval_01F0BGG4NYTMFH5EXJ4C7QAKSK",
+              "value": "green",
+              "option_id": "opt_01F0BGG4N3Q09ME0BEZG6XZGFQ",
+              "variant_id": "variant_01F0BGG4NYDVW4V6AHKB58DQWT",
+              "created_at": "2021-03-09T12:48:28.304Z",
+              "updated_at": "2021-03-09T12:48:28.304Z",
+              "deleted_at": null,
+              "metadata": null
+            }
+          ],
+          "created_at": "2021-03-09T12:48:28.304Z",
+          "updated_at": "2021-03-09T12:48:28.304Z",
+          "deleted_at": null,
+          "metadata": null
+        }
+      ],
+      "profile_id": "sp_01F0BGG4J2RGH25WZVP8S6VNGW",
+      "weight": null,
+      "length": null,
+      "height": null,
+      "width": null,
+      "hs_code": null,
+      "origin_country": null,
+      "mid_code": null,
+      "material": null,
+      "collection_id": "test-collection",
+      "collection": {
+        "id": "test-collection",
+        "title": "Test collection",
+        "handle": null,
+        "created_at": "2021-03-09T12:48:28.250Z",
+        "updated_at": "2021-03-09T12:48:28.250Z",
+        "deleted_at": null,
+        "metadata": null
+      },
+      "type_id": "test-type",
+      "type": {
+        "id": "test-type",
+        "value": "test-type",
+        "created_at": "2021-03-09T12:48:28.260Z",
+        "updated_at": "2021-03-09T12:48:28.260Z",
+        "deleted_at": null,
+        "metadata": null
+      },
+      "tags": [
+        {
+          "id": "tag1",
+          "value": "123",
+          "created_at": "2021-03-09T12:48:28.257Z",
+          "updated_at": "2021-03-09T12:48:28.257Z",
+          "deleted_at": null,
+          "metadata": null
+        },
+        {
+          "id": "ptag_01F0BGG4MRHZSMYN9Q1YQZHPWT",
+          "value": "456",
+          "created_at": "2021-03-09T12:48:28.304Z",
+          "updated_at": "2021-03-09T12:48:28.304Z",
+          "deleted_at": null,
+          "metadata": null
+        }
+      ],
+      "created_at": "2021-03-09T12:48:28.304Z",
+      "updated_at": "2021-03-09T12:48:28.304Z",
+      "metadata": null
+    },
+    "cart": {
+      "id": "cart_01F0BGFQA6ETNHS7QGEZD9VTF2",
+      "email": null,
+      "billing_address_id": null,
+      "billing_address": null,
+      "shipping_address_id": "addr_01F0BGFQA6YF81V6CREDHNCZMZ",
+      "shipping_address": {
+        "id": "addr_01F0BGFQA6YF81V6CREDHNCZMZ",
+        "customer_id": null,
+        "company": null,
+        "first_name": null,
+        "last_name": null,
+        "address_1": null,
+        "address_2": null,
+        "city": null,
+        "country_code": "us",
+        "province": null,
+        "postal_code": null,
+        "phone": null,
+        "created_at": "2021-03-09T12:48:14.638Z",
+        "updated_at": "2021-03-09T12:48:14.638Z",
+        "deleted_at": null,
+        "metadata": null
+      },
+      "items": [],
+      "region_id": "region",
+      "region": {
+        "id": "region",
+        "name": "Test Region",
+        "currency_code": "usd",
+        "tax_rate": "0",
+        "tax_code": null,
+        "countries": [
+          {
+            "id": 236,
+            "iso_2": "us",
+            "iso_3": "usa",
+            "num_code": 840,
+            "name": "UNITED STATES",
+            "display_name": "United States",
+            "region_id": "region"
+          }
+        ],
+        "payment_providers": [],
+        "fulfillment_providers": [],
+        "created_at": "2021-03-09T12:48:14.601Z",
+        "updated_at": "2021-03-09T12:48:14.601Z",
+        "deleted_at": null,
+        "metadata": null
+      },
+      "discounts": [],
+      "gift_cards": [],
+      "customer_id": null,
+      "payment_sessions": [],
+      "payment_id": null,
+      "payment": null,
+      "shipping_methods": [],
+      "type": "default",
+      "completed_at": null,
+      "created_at": "2021-03-09T12:48:14.638Z",
+      "updated_at": "2021-03-09T12:48:14.777Z",
+      "deleted_at": null,
+      "metadata": null,
+      "idempotency_key": null,
+      "shipping_total": 0,
+      "discount_total": 0,
+      "tax_total": 0,
+      "gift_card_total": 0,
+      "subtotal": 0,
+      "total": 0
+    },
+    "product_collection": {
+      "id": "pcol_01F0BGG81W0FERCAHMR79J72G8",
+      "title": "Summer Collection",
+      "handle": "summer-collection",
+      "created_at": "2021-03-09T12:48:31.804Z",
+      "updated_at": "2021-03-09T12:48:31.804Z",
+      "deleted_at": null,
+      "metadata": null
+    },
+    "discount": {
+      "id": "disc_01F0BGG1BJH91HJ7J9Q0NR0BR6",
+      "code": "10DISC",
+      "is_dynamic": false,
+      "rule_id": "dru_01F0BGG1B3BCZ292BSRRK72JGS",
+      "rule": {
+        "id": "dru_01F0BGG1B3BCZ292BSRRK72JGS",
+        "description": "10 Percent",
+        "type": "percentage",
+        "value": 10,
+        "allocation": "total",
+        "usage_limit": null,
+        "created_at": "2021-03-09T12:48:24.921Z",
+        "updated_at": "2021-03-09T12:48:24.921Z",
+        "deleted_at": null,
+        "metadata": null
+      },
+      "is_disabled": false,
+      "parent_discount_id": null,
+      "starts_at": "2021-03-09T12:48:24.921Z",
+      "ends_at": null,
+      "created_at": "2021-03-09T12:48:24.921Z",
+      "updated_at": "2021-03-09T12:48:24.921Z",
+      "deleted_at": null,
+      "metadata": null
+    },
+    "product_variant": {
+      "id": "variant_01F0BGG4NYDVW4V6AHKB58DQWT",
+      "title": "Test variant",
+      "product_id": "prod_01F0BGG4MWSZH7YYJGHGZMQKHM",
+      "product": {
+        "id": "prod_01F0BGG4MWSZH7YYJGHGZMQKHM",
+        "title": "Test product",
+        "subtitle": null,
+        "description": "test-product-description",
+        "handle": "test-product",
+        "is_giftcard": false,
+        "thumbnail": null,
+        "profile_id": "sp_01F0BGG4J2RGH25WZVP8S6VNGW",
+        "weight": null,
+        "length": null,
+        "height": null,
+        "width": null,
+        "hs_code": null,
+        "origin_country": null,
+        "mid_code": null,
+        "material": null,
+        "collection_id": "test-collection",
+        "type_id": "test-type",
+        "created_at": "2021-03-09T12:48:28.304Z",
+        "updated_at": "2021-03-09T12:48:28.304Z",
+        "deleted_at": null,
+        "metadata": null
+      },
+      "prices": [
+        {
+          "id": "ma_01F0BGG4P5K0TCMD72MJFS0M65",
+          "currency_code": "usd",
+          "amount": 100,
+          "sale_amount": null,
+          "variant_id": "variant_01F0BGG4NYDVW4V6AHKB58DQWT",
+          "region_id": null,
+          "created_at": "2021-03-09T12:48:28.304Z",
+          "updated_at": "2021-03-09T12:48:28.304Z",
+          "deleted_at": null
+        }
+      ],
+      "sku": null,
+      "barcode": null,
+      "ean": null,
+      "upc": null,
+      "inventory_quantity": 10,
+      "allow_backorder": false,
+      "manage_inventory": true,
+      "hs_code": null,
+      "origin_country": null,
+      "mid_code": null,
+      "material": null,
+      "weight": null,
+      "length": null,
+      "height": null,
+      "width": null,
+      "options": [
+        {
+          "id": "optval_01F0BGG4NY1PRPV3FXQ3J66GQH",
+          "value": "large",
+          "option_id": "opt_01F0BGG4N2W8EZJP5KDV0W2250",
+          "variant_id": "variant_01F0BGG4NYDVW4V6AHKB58DQWT",
+          "created_at": "2021-03-09T12:48:28.304Z",
+          "updated_at": "2021-03-09T12:48:28.304Z",
+          "deleted_at": null,
+          "metadata": null
+        },
+        {
+          "id": "optval_01F0BGG4NYTMFH5EXJ4C7QAKSK",
+          "value": "green",
+          "option_id": "opt_01F0BGG4N3Q09ME0BEZG6XZGFQ",
+          "variant_id": "variant_01F0BGG4NYDVW4V6AHKB58DQWT",
+          "created_at": "2021-03-09T12:48:28.304Z",
+          "updated_at": "2021-03-09T12:48:28.304Z",
+          "deleted_at": null,
+          "metadata": null
+        }
+      ],
+      "created_at": "2021-03-09T12:48:28.304Z",
+      "updated_at": "2021-03-09T12:48:28.304Z",
+      "deleted_at": null,
+      "metadata": null
+    },
+    "product_option": {
+      "id": "opt_01F0BGG4N2W8EZJP5KDV0W2250",
+      "title": "size",
+      "product_id": "prod_01F0BGG4MWSZH7YYJGHGZMQKHM",
+      "created_at": "2021-03-09T12:48:28.304Z",
+      "updated_at": "2021-03-09T12:48:28.304Z",
+      "deleted_at": null,
+      "metadata": null
+    },
+    "product_option_value": {
+      "id": "optval_01F0BGG4NY1PRPV3FXQ3J66GQH",
+      "value": "large",
+      "option_id": "opt_01F0BGG4N2W8EZJP5KDV0W2250",
+      "variant_id": "variant_01F0BGG4NYDVW4V6AHKB58DQWT",
+      "created_at": "2021-03-09T12:48:28.304Z",
+      "updated_at": "2021-03-09T12:48:28.304Z",
+      "deleted_at": null,
+      "metadata": null
+    },
+    "money_amount": {
+      "id": "ma_01F0BGG4P5K0TCMD72MJFS0M65",
+      "currency_code": "usd",
+      "amount": 100,
+      "sale_amount": null,
+      "variant_id": "variant_01F0BGG4NYDVW4V6AHKB58DQWT",
+      "region_id": null,
+      "created_at": "2021-03-09T12:48:28.304Z",
+      "updated_at": "2021-03-09T12:48:28.304Z",
+      "deleted_at": null
+    },
+    "gift_card": {
+      "id": "gift_01F0BF6H3XHRT2SF4Y05AM95B9",
+      "code": "HRYB-SMX4-XXQN-2SRL",
+      "value": 1000,
+      "balance": 1000,
+      "region_id": "reg_01F0BF6H2MZ06R2G2ZGZCAX3NS",
+      "region": {
+        "id": "reg_01F0BF6H2MZ06R2G2ZGZCAX3NS",
+        "name": "Test Region",
+        "currency_code": "usd",
+        "tax_rate": "0",
+        "tax_code": null,
+        "payment_providers": [],
+        "fulfillment_providers": [],
+        "created_at": "2021-03-09T12:25:44.788Z",
+        "updated_at": "2021-03-09T12:25:44.788Z",
+        "deleted_at": null,
+        "metadata": null
+      },
+      "is_disabled": false,
+      "ends_at": null,
+      "created_at": "2021-03-09T12:25:44.818Z",
+      "updated_at": "2021-03-09T12:25:44.818Z",
+      "deleted_at": null,
+      "metadata": null
+    },
+    "shipping_option": {
+      "id": "so_01F0BGFTXZ6V3GAJHBKHNTR54H",
+      "name": "Free Shipping",
+      "region_id": "reg_01F0BGFTW7J0DGWKJJP3X7AWP9",
+      "region": {
+        "id": "reg_01F0BGFTW7J0DGWKJJP3X7AWP9",
+        "name": "Test Region",
+        "currency_code": "usd",
+        "tax_rate": "0",
+        "tax_code": null,
+        "payment_providers": [],
+        "fulfillment_providers": [
+          {
+            "id": "test-ful",
+            "is_installed": true
+          }
+        ],
+        "created_at": "2021-03-09T12:48:18.311Z",
+        "updated_at": "2021-03-09T12:48:18.311Z",
+        "deleted_at": null,
+        "metadata": null
+      },
+      "profile_id": "sp_01F0BGFTVGXRBATSDBZN5SK2JP",
+      "profile": {
+        "id": "sp_01F0BGFTVGXRBATSDBZN5SK2JP",
+        "name": "Default Shipping Profile",
+        "type": "default",
+        "created_at": "2021-03-09T12:48:18.240Z",
+        "updated_at": "2021-03-09T12:48:18.240Z",
+        "deleted_at": null,
+        "metadata": null
+      },
+      "provider_id": "test-ful",
+      "price_type": "flat_rate",
+      "amount": 100,
+      "is_return": false,
+      "requirements": [],
+      "data": {},
+      "created_at": "2021-03-09T12:48:18.354Z",
+      "updated_at": "2021-03-09T12:48:18.354Z",
+      "deleted_at": null,
+      "metadata": null
+    },
+    "region": {
+      "id": "reg_01F0BGFTW7J0DGWKJJP3X7AWP9",
+      "name": "Test Region",
+      "currency_code": "usd",
+      "tax_rate": "0",
+      "tax_code": null,
+      "payment_providers": [],
+      "fulfillment_providers": [
+        {
+          "id": "test-ful",
+          "is_installed": true
+        }
+      ],
+      "created_at": "2021-03-09T12:48:18.311Z",
+      "updated_at": "2021-03-09T12:48:18.311Z",
+      "deleted_at": null,
+      "metadata": null
+    },
+    "return": {
+      "id": "ret_01F0BGFGGVWNV93E789K1DB2QK",
+      "status": "requested",
+      "items": [
+        {
+          "return_id": "ret_01F0BGFGGVWNV93E789K1DB2QK",
+          "item_id": "test-item",
+          "quantity": 1,
+          "is_requested": true,
+          "requested_quantity": 1,
+          "received_quantity": null,
+          "metadata": null
+        }
+      ],
+      "swap_id": null,
+      "claim_order_id": null,
+      "order_id": "order_01F0BGFGBMCTXE6CD7KCTZG5D1",
+      "shipping_method": null,
+      "shipping_data": null,
+      "refund_amount": 7200,
+      "received_at": null,
+      "created_at": "2021-03-09T12:48:07.680Z",
+      "updated_at": "2021-03-09T12:48:07.680Z",
+      "metadata": null,
+      "idempotency_key": "abb55222-1d22-4852-9714-9b63baec3633"
+    },
+    "notification": {
+      "id": "noti_01F0BGFKZ7P3NC5V1PG10S75N0",
+      "resource_type": "order",
+      "resource_id": "order_01F0BF66ZBXNJ98WDQ9SCWH8Y7",
+      "event_name": "order.placed",
+      "to": "test@email.com",
+      "provider_id": "test-not",
+      "created_at": "2021-03-09T12:48:11.238Z",
+      "updated_at": "2021-03-09T12:48:11.238Z",
+      "resends": []
+    },
+    "discount_rule": {
+      "id": "dru_01F0BGG1B3BCZ292BSRRK72JGS",
+      "description": "10 Percent",
+      "type": "percentage",
+      "value": 10,
+      "allocation": "total",
+      "usage_limit": null,
+      "created_at": "2021-03-09T12:48:24.921Z",
+      "updated_at": "2021-03-09T12:48:24.921Z",
+      "deleted_at": null,
+      "metadata": null
+    }
+  }
+}

docs/api/store-spec3-base.json

@@ -0,0 +1,78 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "version": "1.0.0",
+    "title": "Medusa Storefront API",
+    "license": {
+      "name": "MIT"
+    }
+  },
+  "tags": [
+    {
+      "name": "Auth",
+      "description": "Auth endpoints allows authorization of admin Users and manages their sessions."
+    },
+    {
+      "name": "Cart",
+      "x-resourceId": "cart"
+    },
+    {
+      "name": "Collection",
+      "x-resourceId": "product_collection"
+    },
+    {
+      "name": "Customer",
+      "x-resourceId": "customer"
+    },
+    {
+      "name": "Discount",
+      "x-resourceId": "discount"
+    },
+    {
+      "name": "Gift Card",
+      "x-resourceId": "gift_card"
+    },
+    {
+      "name": "Notification",
+      "x-resourceId": "notification"
+    },
+    {
+      "name": "Order",
+      "x-resourceId": "order"
+    },
+    {
+      "name": "Product",
+      "x-resourceId": "product"
+    },
+    {
+      "name": "Region",
+      "x-resourceId": "region"
+    },
+    {
+      "name": "Return",
+      "x-resourceId": "return"
+    },
+    {
+      "name": "Shipping Option",
+      "x-resourceId": "shipping_option"
+    },
+    {
+      "name": "Shipping Profile",
+      "x-resourceId": "shipping_profile"
+    },
+    {
+      "name": "Swap",
+      "x-resourceId": "swap"
+    },
+    {
+      "name": "Product Variant",
+      "x-resourceId": "product_variant"
+    }
+  ],
+  "servers": [
+    {
+      "url": "https://api.medusa-commerce.com/store"
+    }
+  ],
+  "paths": {}
+}

docs/api/store-spec3.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"version":"1.0.0","title":"Medusa Storefront API","license":{"name":"MIT"}},"tags":[{"name":"Auth","description":"Auth endpoints allows authorization of admin Users and manages their sessions."},{"name":"Cart","x-resourceId":"cart"},{"name":"Collection","x-resourceId":"product_collection"},{"name":"Customer","x-resourceId":"customer"},{"name":"Discount","x-resourceId":"discount"},{"name":"Gift Card","x-resourceId":"gift_card"},{"name":"Notification","x-resourceId":"notification"},{"name":"Order","x-resourceId":"order"},{"name":"Product","x-resourceId":"product"},{"name":"Region","x-resourceId":"region"},{"name":"Return","x-resourceId":"return"},{"name":"Shipping Option","x-resourceId":"shipping_option"},{"name":"Shipping Profile","x-resourceId":"shipping_profile"},{"name":"Swap","x-resourceId":"swap"},{"name":"Product Variant","x-resourceId":"product_variant"}],"servers":[{"url":"https://api.medusa-commerce.com/store"}],"paths":{"/auth":{"post":{"operationId":"PostAuth","summary":"Authenticate Customer","description":"Logs a Customer in and authorizes them to view their details. Successful authentication will set a session cookie in the Customer's browser.","parameters":[],"tags":["Auth"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"properties":{"customer":{"title":"Customer","description":"Represents a customer","x-resourceId":"customer","properties":{"id":{"type":"string"},"email":{"type":"string"},"billing_address_id":{"type":"string"},"billing_address":{"description":"The Customer's billing address.","anyOf":[{"title":"Address","description":"An address.","x-resourceId":"address","properties":{"id":{"type":"string"},"customer_id":{"type":"string"},"company":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"address_1":{"type":"string"},"address_2":{"type":"string"},"city":{"type":"string"},"country_code":{"type":"string"},"country":{"title":"Country","description":"Country details","x-resourceId":"country","properties":{"id":{"description":"The database id of the country","type":"integer"},"iso_2":{"description":"The 2 character ISO code for the country.","type":"string"},"iso_3":{"description":"The 3 character ISO code for the country.","type":"string"},"num_code":{"description":"The numerical ISO code for the country.","type":"string"},"name":{"description":"The normalized country name; in upper case.","type":"string"},"display_name":{"description":"The country name appropriate for display.","type":"string"}}}}}]},"shipping_addresses":{"type":"array","items":{"title":"Address","description":"An address.","x-resourceId":"address","properties":{"id":{"type":"string"},"customer_id":{"type":"string"},"company":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"address_1":{"type":"string"},"address_2":{"type":"string"},"city":{"type":"string"},"country_code":{"type":"string"},"country":{"title":"Country","description":"Country details","x-resourceId":"country","properties":{"id":{"description":"The database id of the country","type":"integer"},"iso_2":{"description":"The 2 character ISO code for the country.","type":"string"},"iso_3":{"description":"The 3 character ISO code for the country.","type":"string"},"num_code":{"description":"The numerical ISO code for the country.","type":"string"},"name":{"description":"The normalized country name; in upper case.","type":"string"},"display_name":{"description":"The country name appropriate for display.","type":"string"}}}}}},"first_name":{"type":"string"},"last_name":{"type":"string"},"phone":{"type":"string"},"has_account":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"deleted_at":{"type":"string","format":"date-time"},"metadata":{"type":"object"}}}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["email","password"],"properties":{"email":{"type":"string","description":"The Customer's email."},"password":{"type":"string","description":"The Customer's password."}}}}}}},"delete":{"operationId":"DeleteAuth","summary":"Log out","description":"Destroys a Customer's authenticated session.","tags":["Auth"],"responses":{"200":{"description":"OK"}}},"get":{"operationId":"GetAuth","summary":"Get Session","description":"Gets the currently logged in Customer.","tags":["Auth"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"properties":{"customer":{"title":"Customer","description":"Represents a customer","x-resourceId":"customer","properties":{"id":{"type":"string"},"email":{"type":"string"},"billing_address_id":{"type":"string"},"billing_address":{"description":"The Customer's billing address.","anyOf":[{"title":"Address","description":"An address.","x-resourceId":"address","properties":{"id":{"type":"string"},"customer_id":{"type":"string"},"company":{"type":"string"},"first_name":{"type":"string"},"lastLine truncated