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:
5
.changeset/two-cups-crash.md
Normal file
5
.changeset/two-cups-crash.md
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@medusajs/medusa": patch
|
||||
---
|
||||
|
||||
feat(oas): pluralize OAS tags
|
||||
@@ -138,19 +138,20 @@ decorators:
|
||||
|
||||
# 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`
|
||||
theme.openapi:
|
||||
theme:
|
||||
colors:
|
||||
primary:
|
||||
dart: "#242526"
|
||||
sidebar:
|
||||
width: "250px"
|
||||
disableSearch: true
|
||||
expandResponses: "200,204"
|
||||
generatedPayloadSamplesMaxDepth: 4
|
||||
hideDownloadButton: true
|
||||
hideRequestPayloadSample: true
|
||||
nativeScrollbars: true
|
||||
requiredPropsFirst: true
|
||||
showObjectSchemaExamples: true
|
||||
sortTagsAlphabetically: true
|
||||
theme:
|
||||
openapi:
|
||||
theme:
|
||||
colors:
|
||||
primary:
|
||||
dart: "#242526"
|
||||
sidebar:
|
||||
width: "250px"
|
||||
disableSearch: true
|
||||
expandResponses: "200,204"
|
||||
generatedPayloadSamplesMaxDepth: 4
|
||||
hideDownloadButton: true
|
||||
hideRequestPayloadSample: true
|
||||
nativeScrollbars: true
|
||||
requiredPropsFirst: true
|
||||
showObjectSchemaExamples: true
|
||||
sortTagsAlphabetically: true
|
||||
|
||||
@@ -229,68 +229,63 @@ tags:
|
||||
- name: Auth
|
||||
description: Auth endpoints that allow authorization of admin Users and manages
|
||||
their sessions.
|
||||
- name: App
|
||||
- name: Apps
|
||||
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.
|
||||
- name: Claim
|
||||
description: Claim endpoints that allow handling claims in Medusa.
|
||||
- name: Collection
|
||||
- name: Collections
|
||||
description: Collection endpoints that allow handling collections in Medusa.
|
||||
- name: Customer
|
||||
- name: Customers
|
||||
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.
|
||||
- name: Discount
|
||||
- name: Discounts
|
||||
description: Discount endpoints that allow handling discounts in Medusa.
|
||||
- name: Discount Condition
|
||||
description: Discount Condition endpoints that allow handling discount conditions
|
||||
in Medusa.
|
||||
- name: Draft Order
|
||||
- name: Draft Orders
|
||||
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.
|
||||
- name: Invite
|
||||
- name: Invites
|
||||
description: Invite endpoints that allow handling invites in Medusa.
|
||||
- name: Note
|
||||
- name: Notes
|
||||
description: Note endpoints that allow handling notes in Medusa.
|
||||
- name: Notification
|
||||
- name: Notifications
|
||||
description: Notification endpoints that allow handling notifications in Medusa.
|
||||
- name: Order
|
||||
- name: Orders
|
||||
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.
|
||||
- name: Product
|
||||
- name: Products
|
||||
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.
|
||||
- name: Product Type
|
||||
- name: Product Types
|
||||
description: Product Types endpoints that allow handling product types in Medusa.
|
||||
- name: Product Variant
|
||||
description: Product Variant endpoints that allow handling product variants in Medusa.
|
||||
- name: Region
|
||||
- name: Regions
|
||||
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.
|
||||
- name: Return
|
||||
- name: Returns
|
||||
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.
|
||||
- name: Shipping Option
|
||||
- name: Shipping Options
|
||||
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
|
||||
Medusa.
|
||||
- name: Store
|
||||
description: Store endpoints that allow handling stores in Medusa.
|
||||
- name: Swap
|
||||
- name: Swaps
|
||||
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.
|
||||
- name: Upload
|
||||
- name: Uploads
|
||||
description: Upload endpoints that allow handling uploads in Medusa.
|
||||
- name: User
|
||||
- name: Users
|
||||
description: User endpoints that allow handling users in Medusa.
|
||||
- name: Variants
|
||||
description: Product Variant endpoints that allow handling product variants in Medusa.
|
||||
servers:
|
||||
- url: https://api.medusa-commerce.com
|
||||
paths: { }
|
||||
|
||||
@@ -212,29 +212,29 @@ tags:
|
||||
- name: Auth
|
||||
description: Auth endpoints that allow authorization of customers and manages their
|
||||
sessions.
|
||||
- name: Cart
|
||||
- name: Carts
|
||||
description: Cart endpoints that allow handling carts in Medusa.
|
||||
- name: Collection
|
||||
- name: Collections
|
||||
description: Collection endpoints that allow handling collections in Medusa.
|
||||
- name: Customer
|
||||
- name: Customers
|
||||
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.
|
||||
- name: Order
|
||||
- name: Orders
|
||||
description: Order endpoints that allow handling orders in Medusa.
|
||||
- name: Product
|
||||
- name: Products
|
||||
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.
|
||||
- name: Region
|
||||
- name: Regions
|
||||
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.
|
||||
- name: Return
|
||||
- name: Returns
|
||||
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.
|
||||
- name: Swap
|
||||
- name: Swaps
|
||||
description: Swap endpoints that allow handling swaps in Medusa.
|
||||
servers:
|
||||
- url: https://api.medusa-commerce.com
|
||||
|
||||
@@ -32,7 +32,7 @@ import { validator } from "../../../../utils/validator"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - App
|
||||
* - Apps
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
|
||||
@@ -18,7 +18,7 @@ import { OauthService } from "../../../../services"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - App
|
||||
* - Apps
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
|
||||
@@ -31,7 +31,7 @@ import { EntityManager } from "typeorm"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Batch Job
|
||||
* - Batch Jobs
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
|
||||
@@ -31,7 +31,7 @@ import { EntityManager } from "typeorm"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Batch Job
|
||||
* - Batch Jobs
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
|
||||
@@ -46,7 +46,7 @@ import { validator } from "../../../../utils/validator"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Batch Job
|
||||
* - Batch Jobs
|
||||
* responses:
|
||||
* 201:
|
||||
* description: OK
|
||||
|
||||
@@ -28,7 +28,7 @@
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Batch Job
|
||||
* - Batch Jobs
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
|
||||
@@ -233,7 +233,7 @@ import { isDefined } from "medusa-core-utils"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Batch Job
|
||||
* - Batch Jobs
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
|
||||
@@ -35,7 +35,7 @@ import ProductCollectionService from "../../../../services/product-collection"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Collection
|
||||
* - Collections
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
|
||||
@@ -42,7 +42,7 @@ import { EntityManager } from "typeorm"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Collection
|
||||
* - Collections
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
|
||||
@@ -33,7 +33,7 @@ import ProductCollectionService from "../../../../services/product-collection"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Collection
|
||||
* - Collections
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
|
||||
@@ -33,7 +33,7 @@ import { defaultAdminCollectionsRelations } from "."
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Collection
|
||||
* - Collections
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
|
||||
@@ -107,7 +107,7 @@ import { Type } from "class-transformer"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Collection
|
||||
* - Collections
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
|
||||
@@ -35,7 +35,7 @@ import ProductCollectionService from "../../../../services/product-collection"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Collection
|
||||
* - Collections
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
|
||||
@@ -44,7 +44,7 @@ import ProductCollectionService from "../../../../services/product-collection"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Collection
|
||||
* - Collections
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
|
||||
@@ -38,7 +38,7 @@ import { FeatureFlagDecorators } from "../../../../utils/feature-flag-decorators
|
||||
* curl --location --request POST 'https://medusa-url.com/admin/currencies' \
|
||||
* --header 'Authorization: Bearer {api_token}'
|
||||
* tags:
|
||||
* - Currency
|
||||
* - Currencies
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -44,7 +44,7 @@ import { EntityManager } from "typeorm"
|
||||
* "includes_tax": true
|
||||
* }'
|
||||
* tags:
|
||||
* - Currency
|
||||
* - Currencies
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
@@ -59,13 +59,11 @@ export default async (req: ExtendedRequest<Currency>, res) => {
|
||||
const currencyService: CurrencyService = req.scope.resolve("currencyService")
|
||||
const manager: EntityManager = req.scope.resolve("manager")
|
||||
|
||||
const currency = await manager.transaction(
|
||||
async (transactionManager) => {
|
||||
return await currencyService
|
||||
.withTransaction(transactionManager)
|
||||
.update(code, data)
|
||||
}
|
||||
)
|
||||
const currency = await manager.transaction(async (transactionManager) => {
|
||||
return await currencyService
|
||||
.withTransaction(transactionManager)
|
||||
.update(code, data)
|
||||
})
|
||||
|
||||
res.json({ currency })
|
||||
}
|
||||
|
||||
@@ -56,7 +56,7 @@ import { validator } from "../../../../utils/validator"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Customer Group
|
||||
* - Customer Groups
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -44,7 +44,7 @@ import { validator } from "../../../../utils/validator"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Customer Group
|
||||
* - Customer Groups
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -33,7 +33,7 @@ import { EntityManager } from "typeorm"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Customer Group
|
||||
* - Customer Groups
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -56,7 +56,7 @@ import { validator } from "../../../../utils/validator"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Customer Group
|
||||
* - Customer Groups
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -39,7 +39,7 @@ import { Type } from "class-transformer"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Customer Group
|
||||
* - Customer Groups
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -36,7 +36,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Customer Group
|
||||
* - Customer Groups
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -123,7 +123,7 @@ import { Type } from "class-transformer"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Customer Group
|
||||
* - Customer Groups
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -48,7 +48,7 @@ import { validator } from "../../../../utils/validator"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Customer Group
|
||||
* - Customer Groups
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -49,7 +49,7 @@ import { EntityManager } from "typeorm"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Customer
|
||||
* - Customers
|
||||
* responses:
|
||||
* 201:
|
||||
* description: OK
|
||||
|
||||
@@ -35,7 +35,7 @@ import { validator } from "../../../../utils/validator"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Customer
|
||||
* - Customers
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -39,7 +39,7 @@ import customerController from "../../../../controllers/customers"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Customer
|
||||
* - Customers
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -58,7 +58,7 @@ import { validator } from "../../../../utils/validator"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Customer
|
||||
* - Customers
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -35,7 +35,7 @@ import { EntityManager } from "typeorm"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Discount
|
||||
* - Discounts
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -54,7 +54,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Discount Condition
|
||||
* - Discounts
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -53,7 +53,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Discount Condition
|
||||
* - Discounts
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -83,7 +83,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Discount
|
||||
* - Discounts
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -53,7 +53,7 @@ import { EntityManager } from "typeorm"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Discount
|
||||
* - Discounts
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -38,7 +38,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Discount Condition
|
||||
* - Discounts
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -31,7 +31,7 @@ import { EntityManager } from "typeorm"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Discount
|
||||
* - Discounts
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -34,7 +34,7 @@ import { EntityManager } from "typeorm"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Discount
|
||||
* - Discounts
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -52,7 +52,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Discount Condition
|
||||
* - Discounts
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -36,7 +36,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Discount Condition
|
||||
* - Discounts
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -35,7 +35,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Discount
|
||||
* - Discounts
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -35,7 +35,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Discount
|
||||
* - Discounts
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -62,7 +62,7 @@ import { optionalBooleanMapper } from "../../../../utils/validators/is-boolean"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Discount
|
||||
* - Discounts
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -34,7 +34,7 @@ import { EntityManager } from "typeorm"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Discount
|
||||
* - Discounts
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -54,7 +54,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Discount
|
||||
* - Discounts
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -66,7 +66,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Discount
|
||||
* - Discounts
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -87,7 +87,7 @@ import { IsType } from "../../../../utils/validators/is-type"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Draft Order
|
||||
* - Draft Orders
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -55,7 +55,7 @@ import { validator } from "../../../../utils/validator"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Draft Order
|
||||
* - Draft Orders
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -31,7 +31,7 @@ import { EntityManager } from "typeorm"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Draft Order
|
||||
* - Draft Orders
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -40,7 +40,7 @@ import { MedusaError } from "medusa-core-utils"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Draft Order
|
||||
* - Draft Orders
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -38,7 +38,7 @@ import { DraftOrder } from "../../../.."
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Draft Order
|
||||
* - Draft Orders
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -44,7 +44,7 @@ import { validator } from "../../../../utils/validator"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Draft Order
|
||||
* - Draft Orders
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -44,7 +44,7 @@ import { MedusaError } from "medusa-core-utils"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Draft Order
|
||||
* - Draft Orders
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -61,7 +61,7 @@ import { IsType } from "../../../../utils/validators/is-type"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Draft Order
|
||||
* - Draft Orders
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -54,7 +54,7 @@ import { validator } from "../../../../utils/validator"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Draft Order
|
||||
* - Draft Orders
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -44,7 +44,7 @@ import { EntityManager } from "typeorm"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Gift Card
|
||||
* - Gift Cards
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -30,7 +30,7 @@ import { EntityManager } from "typeorm"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Gift Card
|
||||
* - Gift Cards
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -30,7 +30,7 @@ import { defaultAdminGiftCardFields, defaultAdminGiftCardRelations } from "./"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Gift Card
|
||||
* - Gift Cards
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -39,7 +39,7 @@ import { isDefined } from "medusa-core-utils"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Gift Card
|
||||
* - Gift Cards
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -47,7 +47,7 @@ import { EntityManager } from "typeorm"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Gift Card
|
||||
* - Gift Cards
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -31,7 +31,7 @@ import { ProductVariantInventoryService } from "../../../../services"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - InventoryItem
|
||||
* - Inventory Items
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -56,7 +56,7 @@ import { EntityManager } from "typeorm"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Invite
|
||||
* - Invites
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -49,7 +49,7 @@ import { EntityManager } from "typeorm"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Invite
|
||||
* - Invites
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -31,7 +31,7 @@ import InviteService from "../../../../services/invite"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Invite
|
||||
* - Invites
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -28,7 +28,7 @@ import InviteService from "../../../../services/invite"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Invite
|
||||
* - Invites
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -34,7 +34,7 @@ import { EntityManager } from "typeorm"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Invite
|
||||
* - Invites
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -47,7 +47,7 @@ import { EntityManager } from "typeorm"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Note
|
||||
* - Notes
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -31,7 +31,7 @@ import NoteService from "../../../../services/note"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Note
|
||||
* - Notes
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -30,7 +30,7 @@ import NoteService from "../../../../services/note"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Note
|
||||
* - Notes
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -38,7 +38,7 @@ import { validator } from "../../../../utils/validator"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Note
|
||||
* - Notes
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -44,7 +44,7 @@ import { EntityManager } from "typeorm"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Note
|
||||
* - Notes
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -50,7 +50,7 @@ import { validator } from "../../../../utils/validator"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Notification
|
||||
* - Notifications
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -44,7 +44,7 @@ import { validator } from "../../../../utils/validator"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Notification
|
||||
* - Notifications
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -48,7 +48,7 @@ import {
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - OrderEdit
|
||||
* - Order Edits
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -36,7 +36,7 @@ import {
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - OrderEdit
|
||||
* - Order Edits
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -36,7 +36,7 @@ import {
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - OrderEdit
|
||||
* - Order Edits
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -42,7 +42,7 @@ import {
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - OrderEdit
|
||||
* - Order Edits
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -37,7 +37,7 @@ import {
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - OrderEdit
|
||||
* - Order Edits
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -32,7 +32,7 @@ import { OrderEditService } from "../../../../services"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - OrderEdit
|
||||
* - Order Edits
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -31,7 +31,7 @@ import { OrderEditService } from "../../../../services"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - OrderEdit
|
||||
* - Order Edits
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -35,7 +35,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - OrderEdit
|
||||
* - Order Edits
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -39,7 +39,7 @@ import { IsOptional, IsString } from "class-validator"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - OrderEdit
|
||||
* - Order Edits
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -41,7 +41,7 @@ import {
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - OrderEdit
|
||||
* - Order Edits
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -47,7 +47,7 @@ import {
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - OrderEdit
|
||||
* - Order Edits
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -49,7 +49,7 @@ import {
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - OrderEdit
|
||||
* - Order Edits
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -56,7 +56,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Order
|
||||
* - Orders
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -35,7 +35,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Order
|
||||
* - Orders
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -38,7 +38,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Claim
|
||||
* - Orders
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -43,7 +43,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Fulfillment
|
||||
* - Orders
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -43,7 +43,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Fulfillment
|
||||
* - Orders
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -44,7 +44,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Fulfillment
|
||||
* - Orders
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -35,7 +35,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Order
|
||||
* - Orders
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -38,7 +38,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Swap
|
||||
* - Orders
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -35,7 +35,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Order
|
||||
* - Orders
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -35,7 +35,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Order
|
||||
* - Orders
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -48,7 +48,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Claim
|
||||
* - Orders
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -73,7 +73,7 @@ import { AddressPayload, FindParams } from "../../../../types/common"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Claim
|
||||
* - Orders
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
@@ -73,7 +73,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* tags:
|
||||
* - Fulfillment
|
||||
* - Orders
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user