docs: fixes to OAS comments (#2214)
* fixed tag name * added price selection query params * added more info to the currency_code query param * fix change in imports
This commit is contained in:
@@ -29,7 +29,7 @@ import UserService from "../../../../services/user"
|
|||||||
* - api_token: []
|
* - api_token: []
|
||||||
* - cookie_auth: []
|
* - cookie_auth: []
|
||||||
* tags:
|
* tags:
|
||||||
* - Users
|
* - User
|
||||||
* responses:
|
* responses:
|
||||||
* 200:
|
* 200:
|
||||||
* description: OK
|
* description: OK
|
||||||
|
|||||||
@@ -57,7 +57,16 @@ import { Type } from "class-transformer"
|
|||||||
* - (query) cart_id {string} to search for.
|
* - (query) cart_id {string} to search for.
|
||||||
* - (query) email {string} to search for.
|
* - (query) email {string} to search for.
|
||||||
* - (query) region_id {string} to search for.
|
* - (query) region_id {string} to search for.
|
||||||
* - (query) currency_code {string} to search for.
|
* - in: query
|
||||||
|
* name: currency_code
|
||||||
|
* style: form
|
||||||
|
* explode: false
|
||||||
|
* description: The 3 character ISO currency code to set prices based on.
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* externalDocs:
|
||||||
|
* url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
|
||||||
|
* description: See a list of codes.
|
||||||
* - (query) tax_rate {string} to search for.
|
* - (query) tax_rate {string} to search for.
|
||||||
* - in: query
|
* - in: query
|
||||||
* name: created_at
|
* name: created_at
|
||||||
|
|||||||
@@ -15,6 +15,18 @@ import { validator } from "../../../../utils/validator"
|
|||||||
* description: "Retrieves a Product."
|
* description: "Retrieves a Product."
|
||||||
* parameters:
|
* parameters:
|
||||||
* - (path) id=* {string} The id of the Product.
|
* - (path) id=* {string} The id of the Product.
|
||||||
|
* - (query) cart_id {string} The ID of the customer's cart.
|
||||||
|
* - (query) region_id {string} The ID of the region the customer is using. This is helpful to ensure correct prices are retrieved for a region.
|
||||||
|
* - in: query
|
||||||
|
* name: currency_code
|
||||||
|
* style: form
|
||||||
|
* explode: false
|
||||||
|
* description: The 3 character ISO currency code to set prices based on. This is helpful to ensure correct prices are retrieved for a currency.
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* externalDocs:
|
||||||
|
* url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
|
||||||
|
* description: See a list of codes.
|
||||||
* x-codeSamples:
|
* x-codeSamples:
|
||||||
* - lang: JavaScript
|
* - lang: JavaScript
|
||||||
* label: JS Client
|
* label: JS Client
|
||||||
|
|||||||
Reference in New Issue
Block a user