chore(oas): replace response with $ref class JSDoc (Store PRO-V) (#3044)
### Scope Store routes directories PRO to V. ### What Move inline OAS response schema declaration under their respective class declarations in order to expose them through `#/components/schemas`. Replace inline OAS response schema with a `$ref` reference pointing to the newly declared schema. ### Why Having response declared as its own "named" schema will allow OAS code generators to output typed entities/DTO that can be consumed without having to reference the route/operation. ### How Declare a new @schema JSDoc for each "Res" class used to parse and validate request body. Move the current inline requestBody to the new @schema. ### Test - Ran OAS validator. - Ran docs build script. Expect no visible changes to the documentation.
This commit is contained in:
@@ -211,7 +211,9 @@ export type AdminProductsDeleteRes = {
|
||||
* products:
|
||||
* type: array
|
||||
* items:
|
||||
* $ref: "#/components/schemas/Product"
|
||||
* oneOf:
|
||||
* - $ref: "#/components/schemas/Product"
|
||||
* - $ref: "#/components/schemas/PricedProduct"
|
||||
* count:
|
||||
* type: integer
|
||||
* description: The total number of items available
|
||||
|
||||
Reference in New Issue
Block a user