chore(docs): Generated API Reference (#2218)

Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>

docs/api/admin/paths/currencies.yaml

@@ -0,0 +1,53 @@
+get:
+  operationId: GetCurrencies
+  summary: List Currency
+  description: Retrieves a list of Currency
+  x-authenticated: true
+  parameters:
+    - in: query
+      name: code
+      description: Code of the currency to search for.
+      schema:
+        type: string
+    - in: query
+      name: includes_tax
+      description: Search for tax inclusive currencies.
+      schema:
+        type: boolean
+    - in: query
+      name: order
+      description: to retrieve products in.
+      schema:
+        type: string
+    - in: query
+      name: offset
+      description: How many products to skip in the result.
+      schema:
+        type: string
+    - in: query
+      name: limit
+      description: Limit the number of products returned.
+      schema:
+        type: string
+  tags:
+    - Currency
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            properties:
+              count:
+                description: The number of Currency.
+                type: integer
+              offset:
+                description: The offset of the Currency query.
+                type: integer
+              limit:
+                description: The limit of the currency query.
+                type: integer
+              currencies:
+                type: array
+                items:
+                  $ref: ../components/schemas/currency.yaml

docs/api/admin/paths/currencies_{code}.yaml

@@ -0,0 +1,31 @@
+post:
+  operationId: PostCurrenciesCurrency
+  summary: Update a Currency
+  description: Update a Currency
+  x-authenticated: true
+  parameters:
+    - in: path
+      name: code
+      required: true
+      description: The code of the Currency.
+      schema:
+        type: string
+  requestBody:
+    content:
+      application/json:
+        schema:
+          properties:
+            includes_tax:
+              type: boolean
+              description: '[EXPERIMENTAL] Tax included in prices of currency.'
+  tags:
+    - Currency
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            properties:
+              currency:
+                $ref: ../components/schemas/currency.yaml

docs/api/admin/paths/price-lists.yaml

@@ -82,6 +82,9 @@ post:
                   id:
                     description: The ID of a customer group
                     type: string
+            includes_tax:
+              description: '[EXPERIMENTAL] Tax included in prices of price list'
+              type: boolean
   x-codeSamples:
     - lang: JavaScript
       label: JS Client

docs/api/admin/paths/price-lists_{id}.yaml

@@ -190,6 +190,9 @@ post:
                   id:
                     description: The ID of a customer group
                     type: string
+            includes_tax:
+              description: '[EXPERIMENTAL] Tax included in prices of price list'
+              type: boolean
   x-codeSamples:
     - lang: JavaScript
       label: JS Client

docs/api/admin/paths/regions.yaml

@@ -53,6 +53,9 @@ post:
               type: array
               items:
                 type: string
+            includes_tax:
+              description: '[EXPERIMENTAL] Tax included in prices of region'
+              type: boolean
   x-codeSamples:
     - lang: JavaScript
       label: JS Client

docs/api/admin/paths/regions_{id}.yaml

@@ -149,6 +149,9 @@ post:
             tax_rate:
               description: The tax rate to use on Orders in the Region.
               type: number
+            includes_tax:
+              description: '[EXPERIMENTAL] Tax included in prices of region'
+              type: boolean
             payment_providers:
               description: >-
                 A list of Payment Provider IDs that should be enabled for the

docs/api/admin/paths/shipping-options.yaml

@@ -74,6 +74,9 @@ post:
             metadata:
               description: An optional set of key-value pairs with additional information.
               type: object
+            includes_tax:
+              description: '[EXPERIMENTAL] Tax included in prices of shipping option'
+              type: boolean
   x-codeSamples:
     - lang: JavaScript
       label: JS Client

docs/api/admin/paths/shipping-options_{id}.yaml

@@ -154,6 +154,9 @@ post:
                   amount:
                     description: The amount to compare with.
                     type: integer
+            includes_tax:
+              description: '[EXPERIMENTAL] Tax included in prices of shipping option'
+              type: boolean
   x-codeSamples:
     - lang: JavaScript
       label: JS Client

docs/api/admin/paths/uploads.yaml

@@ -1,7 +1,9 @@
 post:
   operationId: PostUploads
-  summary: Upload a file
-  description: Uploads a file to the specific fileservice that is installed in Medusa.
+  summary: Upload files
+  description: >-
+    Uploads at least one file to the specific fileservice that is installed in
+    Medusa.
   x-authenticated: true
   requestBody:
     content:

docs/api/admin/paths/users_{id}.yaml

@@ -23,7 +23,7 @@ delete:
     - api_token: []
     - cookie_auth: []
   tags:
-    - Users
+    - User
   responses:
     '200':
       description: OK