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:
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user