feat(oas): pluralize OAS tags (#3315)

## What

Pluralize OAS tags

## Why

OAS tags are commonly used by code generator to group routes under a name space based on a tag. 

Our JS client convention is to use plural, e.g: client.products, client.customers. In order to minimize friction when migrating to a client generated from OAS, tags should be plural as well.

## How

Match tag naming with JS client resource naming.

## Test

* Run `yarn build`
* Run `yarn openapi:generate`
* Run `yarn redocly preview-docs docs/api/admin/openapi.yaml --config=./docs-util/redocly/config.yaml`
* Expect side menu items to be plural.
* Run `yarn redocly preview-docs docs/api/store/openapi.yaml --config=./docs-util/redocly/config.yaml`
* Expect side menu items to be plural.
This commit is contained in:
Patrick
2023-02-23 13:31:51 +00:00
committed by GitHub
parent e1b92e9b04
commit f3bf351d21
299 changed files with 362 additions and 369 deletions
+5
View File
@@ -0,0 +1,5 @@
---
"@medusajs/medusa": patch
---
feat(oas): pluralize OAS tags
+2 -1
View File
@@ -138,7 +138,8 @@ decorators:
# Similar config to /www/docs/docusaurus.config.js > redocusaurus # Similar config to /www/docs/docusaurus.config.js > redocusaurus
# Allows to emulate rendering of API public documentation when using `yarn redocly preview-docs openapi.yaml` # Allows to emulate rendering of API public documentation when using `yarn redocly preview-docs openapi.yaml`
theme.openapi: theme:
openapi:
theme: theme:
colors: colors:
primary: primary:
+28 -33
View File
@@ -229,68 +229,63 @@ tags:
- name: Auth - name: Auth
description: Auth endpoints that allow authorization of admin Users and manages description: Auth endpoints that allow authorization of admin Users and manages
their sessions. their sessions.
- name: App - name: Apps
description: App endpoints that allow handling apps in Medusa. description: App endpoints that allow handling apps in Medusa.
- name: Batch Job - name: Batch Jobs
description: Batch Job endpoints that allow handling batch jobs in Medusa. description: Batch Job endpoints that allow handling batch jobs in Medusa.
- name: Claim - name: Collections
description: Claim endpoints that allow handling claims in Medusa.
- name: Collection
description: Collection endpoints that allow handling collections in Medusa. description: Collection endpoints that allow handling collections in Medusa.
- name: Customer - name: Customers
description: Customer endpoints that allow handling customers in Medusa. description: Customer endpoints that allow handling customers in Medusa.
- name: Customer Group - name: Customer Groups
description: Customer Group endpoints that allow handling customer groups in Medusa. description: Customer Group endpoints that allow handling customer groups in Medusa.
- name: Discount - name: Discounts
description: Discount endpoints that allow handling discounts in Medusa. description: Discount endpoints that allow handling discounts in Medusa.
- name: Discount Condition - name: Draft Orders
description: Discount Condition endpoints that allow handling discount conditions
in Medusa.
- name: Draft Order
description: Draft Order endpoints that allow handling draft orders in Medusa. description: Draft Order endpoints that allow handling draft orders in Medusa.
- name: Gift Card - name: Gift Cards
description: Gift Card endpoints that allow handling gift cards in Medusa. description: Gift Card endpoints that allow handling gift cards in Medusa.
- name: Invite - name: Invites
description: Invite endpoints that allow handling invites in Medusa. description: Invite endpoints that allow handling invites in Medusa.
- name: Note - name: Notes
description: Note endpoints that allow handling notes in Medusa. description: Note endpoints that allow handling notes in Medusa.
- name: Notification - name: Notifications
description: Notification endpoints that allow handling notifications in Medusa. description: Notification endpoints that allow handling notifications in Medusa.
- name: Order - name: Orders
description: Order endpoints that allow handling orders in Medusa. description: Order endpoints that allow handling orders in Medusa.
- name: Price List - name: Price Lists
description: Price List endpoints that allow handling price lists in Medusa. description: Price List endpoints that allow handling price lists in Medusa.
- name: Product - name: Products
description: Product endpoints that allow handling products in Medusa. description: Product endpoints that allow handling products in Medusa.
- name: Product Tag - name: Product Tags
description: Product Tag endpoints that allow handling product tags in Medusa. description: Product Tag endpoints that allow handling product tags in Medusa.
- name: Product Type - name: Product Types
description: Product Types endpoints that allow handling product types in Medusa. description: Product Types endpoints that allow handling product types in Medusa.
- name: Product Variant - name: Regions
description: Product Variant endpoints that allow handling product variants in Medusa.
- name: Region
description: Region endpoints that allow handling regions in Medusa. description: Region endpoints that allow handling regions in Medusa.
- name: Return Reason - name: Return Reasons
description: Return Reason endpoints that allow handling return reasons in Medusa. description: Return Reason endpoints that allow handling return reasons in Medusa.
- name: Return - name: Returns
description: Return endpoints that allow handling returns in Medusa. description: Return endpoints that allow handling returns in Medusa.
- name: Sales Channel - name: Sales Channels
description: Sales Channel endpoints that allow handling sales channels in Medusa. description: Sales Channel endpoints that allow handling sales channels in Medusa.
- name: Shipping Option - name: Shipping Options
description: Shipping Option endpoints that allow handling shipping options in Medusa. description: Shipping Option endpoints that allow handling shipping options in Medusa.
- name: Shipping Profile - name: Shipping Profiles
description: Shipping Profile endpoints that allow handling shipping profiles in description: Shipping Profile endpoints that allow handling shipping profiles in
Medusa. Medusa.
- name: Store - name: Store
description: Store endpoints that allow handling stores in Medusa. description: Store endpoints that allow handling stores in Medusa.
- name: Swap - name: Swaps
description: Swap endpoints that allow handling swaps in Medusa. description: Swap endpoints that allow handling swaps in Medusa.
- name: Tax Rate - name: Tax Rates
description: Tax Rate endpoints that allow handling tax rates in Medusa. description: Tax Rate endpoints that allow handling tax rates in Medusa.
- name: Upload - name: Uploads
description: Upload endpoints that allow handling uploads in Medusa. description: Upload endpoints that allow handling uploads in Medusa.
- name: User - name: Users
description: User endpoints that allow handling users in Medusa. description: User endpoints that allow handling users in Medusa.
- name: Variants
description: Product Variant endpoints that allow handling product variants in Medusa.
servers: servers:
- url: https://api.medusa-commerce.com - url: https://api.medusa-commerce.com
paths: { } paths: { }
+12 -12
View File
@@ -212,29 +212,29 @@ tags:
- name: Auth - name: Auth
description: Auth endpoints that allow authorization of customers and manages their description: Auth endpoints that allow authorization of customers and manages their
sessions. sessions.
- name: Cart - name: Carts
description: Cart endpoints that allow handling carts in Medusa. description: Cart endpoints that allow handling carts in Medusa.
- name: Collection - name: Collections
description: Collection endpoints that allow handling collections in Medusa. description: Collection endpoints that allow handling collections in Medusa.
- name: Customer - name: Customers
description: Customer endpoints that allow handling customers in Medusa. description: Customer endpoints that allow handling customers in Medusa.
- name: Gift Card - name: Gift Cards
description: Gift Card endpoints that allow handling gift cards in Medusa. description: Gift Card endpoints that allow handling gift cards in Medusa.
- name: Order - name: Orders
description: Order endpoints that allow handling orders in Medusa. description: Order endpoints that allow handling orders in Medusa.
- name: Product - name: Products
description: Product endpoints that allow handling products in Medusa. description: Product endpoints that allow handling products in Medusa.
- name: Product Variant - name: Product Variants
description: Product Variant endpoints that allow handling product variants in Medusa. description: Product Variant endpoints that allow handling product variants in Medusa.
- name: Region - name: Regions
description: Region endpoints that allow handling regions in Medusa. description: Region endpoints that allow handling regions in Medusa.
- name: Return Reason - name: Return Reasons
description: Return Reason endpoints that allow handling return reasons in Medusa. description: Return Reason endpoints that allow handling return reasons in Medusa.
- name: Return - name: Returns
description: Return endpoints that allow handling returns in Medusa. description: Return endpoints that allow handling returns in Medusa.
- name: Shipping Option - name: Shipping Options
description: Shipping Option endpoints that allow handling shipping options in Medusa. description: Shipping Option endpoints that allow handling shipping options in Medusa.
- name: Swap - name: Swaps
description: Swap endpoints that allow handling swaps in Medusa. description: Swap endpoints that allow handling swaps in Medusa.
servers: servers:
- url: https://api.medusa-commerce.com - url: https://api.medusa-commerce.com
@@ -32,7 +32,7 @@ import { validator } from "../../../../utils/validator"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - App * - Apps
* responses: * responses:
* "200": * "200":
* description: OK * description: OK
@@ -18,7 +18,7 @@ import { OauthService } from "../../../../services"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - App * - Apps
* responses: * responses:
* "200": * "200":
* description: OK * description: OK
@@ -31,7 +31,7 @@ import { EntityManager } from "typeorm"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Batch Job * - Batch Jobs
* responses: * responses:
* "200": * "200":
* description: OK * description: OK
@@ -31,7 +31,7 @@ import { EntityManager } from "typeorm"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Batch Job * - Batch Jobs
* responses: * responses:
* "200": * "200":
* description: OK * description: OK
@@ -46,7 +46,7 @@ import { validator } from "../../../../utils/validator"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Batch Job * - Batch Jobs
* responses: * responses:
* 201: * 201:
* description: OK * description: OK
@@ -28,7 +28,7 @@
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Batch Job * - Batch Jobs
* responses: * responses:
* "200": * "200":
* description: OK * description: OK
@@ -233,7 +233,7 @@ import { isDefined } from "medusa-core-utils"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Batch Job * - Batch Jobs
* responses: * responses:
* "200": * "200":
* description: OK * description: OK
@@ -35,7 +35,7 @@ import ProductCollectionService from "../../../../services/product-collection"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Collection * - Collections
* responses: * responses:
* "200": * "200":
* description: OK * description: OK
@@ -42,7 +42,7 @@ import { EntityManager } from "typeorm"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Collection * - Collections
* responses: * responses:
* "200": * "200":
* description: OK * description: OK
@@ -33,7 +33,7 @@ import ProductCollectionService from "../../../../services/product-collection"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Collection * - Collections
* responses: * responses:
* "200": * "200":
* description: OK * description: OK
@@ -33,7 +33,7 @@ import { defaultAdminCollectionsRelations } from "."
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Collection * - Collections
* responses: * responses:
* "200": * "200":
* description: OK * description: OK
@@ -107,7 +107,7 @@ import { Type } from "class-transformer"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Collection * - Collections
* responses: * responses:
* "200": * "200":
* description: OK * description: OK
@@ -35,7 +35,7 @@ import ProductCollectionService from "../../../../services/product-collection"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Collection * - Collections
* responses: * responses:
* "200": * "200":
* description: OK * description: OK
@@ -44,7 +44,7 @@ import ProductCollectionService from "../../../../services/product-collection"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Collection * - Collections
* responses: * responses:
* "200": * "200":
* description: OK * description: OK
@@ -38,7 +38,7 @@ import { FeatureFlagDecorators } from "../../../../utils/feature-flag-decorators
* curl --location --request POST 'https://medusa-url.com/admin/currencies' \ * curl --location --request POST 'https://medusa-url.com/admin/currencies' \
* --header 'Authorization: Bearer {api_token}' * --header 'Authorization: Bearer {api_token}'
* tags: * tags:
* - Currency * - Currencies
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -44,7 +44,7 @@ import { EntityManager } from "typeorm"
* "includes_tax": true * "includes_tax": true
* }' * }'
* tags: * tags:
* - Currency * - Currencies
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -59,13 +59,11 @@ export default async (req: ExtendedRequest<Currency>, res) => {
const currencyService: CurrencyService = req.scope.resolve("currencyService") const currencyService: CurrencyService = req.scope.resolve("currencyService")
const manager: EntityManager = req.scope.resolve("manager") const manager: EntityManager = req.scope.resolve("manager")
const currency = await manager.transaction( const currency = await manager.transaction(async (transactionManager) => {
async (transactionManager) => {
return await currencyService return await currencyService
.withTransaction(transactionManager) .withTransaction(transactionManager)
.update(code, data) .update(code, data)
} })
)
res.json({ currency }) res.json({ currency })
} }
@@ -56,7 +56,7 @@ import { validator } from "../../../../utils/validator"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Customer Group * - Customer Groups
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -44,7 +44,7 @@ import { validator } from "../../../../utils/validator"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Customer Group * - Customer Groups
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -33,7 +33,7 @@ import { EntityManager } from "typeorm"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Customer Group * - Customer Groups
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -56,7 +56,7 @@ import { validator } from "../../../../utils/validator"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Customer Group * - Customer Groups
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -39,7 +39,7 @@ import { Type } from "class-transformer"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Customer Group * - Customer Groups
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -36,7 +36,7 @@ import { FindParams } from "../../../../types/common"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Customer Group * - Customer Groups
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -123,7 +123,7 @@ import { Type } from "class-transformer"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Customer Group * - Customer Groups
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -48,7 +48,7 @@ import { validator } from "../../../../utils/validator"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Customer Group * - Customer Groups
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -49,7 +49,7 @@ import { EntityManager } from "typeorm"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Customer * - Customers
* responses: * responses:
* 201: * 201:
* description: OK * description: OK
@@ -35,7 +35,7 @@ import { validator } from "../../../../utils/validator"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Customer * - Customers
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -39,7 +39,7 @@ import customerController from "../../../../controllers/customers"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Customer * - Customers
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -58,7 +58,7 @@ import { validator } from "../../../../utils/validator"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Customer * - Customers
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -35,7 +35,7 @@ import { EntityManager } from "typeorm"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Discount * - Discounts
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -54,7 +54,7 @@ import { FindParams } from "../../../../types/common"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Discount Condition * - Discounts
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -53,7 +53,7 @@ import { FindParams } from "../../../../types/common"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Discount Condition * - Discounts
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -83,7 +83,7 @@ import { FindParams } from "../../../../types/common"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Discount * - Discounts
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -53,7 +53,7 @@ import { EntityManager } from "typeorm"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Discount * - Discounts
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -38,7 +38,7 @@ import { FindParams } from "../../../../types/common"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Discount Condition * - Discounts
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -31,7 +31,7 @@ import { EntityManager } from "typeorm"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Discount * - Discounts
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -34,7 +34,7 @@ import { EntityManager } from "typeorm"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Discount * - Discounts
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -52,7 +52,7 @@ import { FindParams } from "../../../../types/common"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Discount Condition * - Discounts
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -36,7 +36,7 @@ import { FindParams } from "../../../../types/common"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Discount Condition * - Discounts
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -35,7 +35,7 @@ import { FindParams } from "../../../../types/common"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Discount * - Discounts
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -35,7 +35,7 @@ import { FindParams } from "../../../../types/common"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Discount * - Discounts
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -62,7 +62,7 @@ import { optionalBooleanMapper } from "../../../../utils/validators/is-boolean"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Discount * - Discounts
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -34,7 +34,7 @@ import { EntityManager } from "typeorm"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Discount * - Discounts
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -54,7 +54,7 @@ import { FindParams } from "../../../../types/common"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Discount * - Discounts
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -66,7 +66,7 @@ import { FindParams } from "../../../../types/common"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Discount * - Discounts
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -87,7 +87,7 @@ import { IsType } from "../../../../utils/validators/is-type"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Draft Order * - Draft Orders
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -55,7 +55,7 @@ import { validator } from "../../../../utils/validator"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Draft Order * - Draft Orders
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -31,7 +31,7 @@ import { EntityManager } from "typeorm"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Draft Order * - Draft Orders
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -40,7 +40,7 @@ import { MedusaError } from "medusa-core-utils"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Draft Order * - Draft Orders
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -38,7 +38,7 @@ import { DraftOrder } from "../../../.."
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Draft Order * - Draft Orders
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -44,7 +44,7 @@ import { validator } from "../../../../utils/validator"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Draft Order * - Draft Orders
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -44,7 +44,7 @@ import { MedusaError } from "medusa-core-utils"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Draft Order * - Draft Orders
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -61,7 +61,7 @@ import { IsType } from "../../../../utils/validators/is-type"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Draft Order * - Draft Orders
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -54,7 +54,7 @@ import { validator } from "../../../../utils/validator"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Draft Order * - Draft Orders
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -44,7 +44,7 @@ import { EntityManager } from "typeorm"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Gift Card * - Gift Cards
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -30,7 +30,7 @@ import { EntityManager } from "typeorm"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Gift Card * - Gift Cards
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -30,7 +30,7 @@ import { defaultAdminGiftCardFields, defaultAdminGiftCardRelations } from "./"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Gift Card * - Gift Cards
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -39,7 +39,7 @@ import { isDefined } from "medusa-core-utils"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Gift Card * - Gift Cards
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -47,7 +47,7 @@ import { EntityManager } from "typeorm"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Gift Card * - Gift Cards
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -31,7 +31,7 @@ import { ProductVariantInventoryService } from "../../../../services"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - InventoryItem * - Inventory Items
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -56,7 +56,7 @@ import { EntityManager } from "typeorm"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Invite * - Invites
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -49,7 +49,7 @@ import { EntityManager } from "typeorm"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Invite * - Invites
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -31,7 +31,7 @@ import InviteService from "../../../../services/invite"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Invite * - Invites
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -28,7 +28,7 @@ import InviteService from "../../../../services/invite"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Invite * - Invites
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -34,7 +34,7 @@ import { EntityManager } from "typeorm"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Invite * - Invites
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -47,7 +47,7 @@ import { EntityManager } from "typeorm"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Note * - Notes
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -31,7 +31,7 @@ import NoteService from "../../../../services/note"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Note * - Notes
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -30,7 +30,7 @@ import NoteService from "../../../../services/note"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Note * - Notes
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -38,7 +38,7 @@ import { validator } from "../../../../utils/validator"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Note * - Notes
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -44,7 +44,7 @@ import { EntityManager } from "typeorm"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Note * - Notes
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -50,7 +50,7 @@ import { validator } from "../../../../utils/validator"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Notification * - Notifications
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -44,7 +44,7 @@ import { validator } from "../../../../utils/validator"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Notification * - Notifications
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -48,7 +48,7 @@ import {
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - OrderEdit * - Order Edits
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -36,7 +36,7 @@ import {
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - OrderEdit * - Order Edits
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -36,7 +36,7 @@ import {
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - OrderEdit * - Order Edits
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -42,7 +42,7 @@ import {
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - OrderEdit * - Order Edits
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -37,7 +37,7 @@ import {
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - OrderEdit * - Order Edits
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -32,7 +32,7 @@ import { OrderEditService } from "../../../../services"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - OrderEdit * - Order Edits
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -31,7 +31,7 @@ import { OrderEditService } from "../../../../services"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - OrderEdit * - Order Edits
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -35,7 +35,7 @@ import { FindParams } from "../../../../types/common"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - OrderEdit * - Order Edits
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -39,7 +39,7 @@ import { IsOptional, IsString } from "class-validator"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - OrderEdit * - Order Edits
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -41,7 +41,7 @@ import {
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - OrderEdit * - Order Edits
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -47,7 +47,7 @@ import {
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - OrderEdit * - Order Edits
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -49,7 +49,7 @@ import {
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - OrderEdit * - Order Edits
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -56,7 +56,7 @@ import { FindParams } from "../../../../types/common"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Order * - Orders
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -35,7 +35,7 @@ import { FindParams } from "../../../../types/common"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Order * - Orders
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -38,7 +38,7 @@ import { FindParams } from "../../../../types/common"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Claim * - Orders
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -43,7 +43,7 @@ import { FindParams } from "../../../../types/common"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Fulfillment * - Orders
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -43,7 +43,7 @@ import { FindParams } from "../../../../types/common"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Fulfillment * - Orders
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -44,7 +44,7 @@ import { FindParams } from "../../../../types/common"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Fulfillment * - Orders
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -35,7 +35,7 @@ import { FindParams } from "../../../../types/common"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Order * - Orders
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -38,7 +38,7 @@ import { FindParams } from "../../../../types/common"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Swap * - Orders
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -35,7 +35,7 @@ import { FindParams } from "../../../../types/common"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Order * - Orders
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -35,7 +35,7 @@ import { FindParams } from "../../../../types/common"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Order * - Orders
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -48,7 +48,7 @@ import { FindParams } from "../../../../types/common"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Claim * - Orders
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -73,7 +73,7 @@ import { AddressPayload, FindParams } from "../../../../types/common"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Claim * - Orders
* responses: * responses:
* 200: * 200:
* description: OK * description: OK
@@ -73,7 +73,7 @@ import { FindParams } from "../../../../types/common"
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
* tags: * tags:
* - Fulfillment * - Orders
* responses: * responses:
* 200: * 200:
* description: OK * description: OK

Some files were not shown because too many files have changed in this diff Show More