asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: fixed some types in oas comments (#2413)

Browse Source
This commit is contained in:
Shahed Nasser
2022-10-11 16:05:39 +03:00
committed by GitHub
parent 53e34d33d9
commit c4c83c9717
13 changed files with 210 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/medusa/src/api/routes/admin/customer-groups/list-customer-groups.ts
+1 -1
View File
@@ -108,7 +108,7 @@ import { Type } from "class-transformer"
* // must be previously logged in or use api token
* medusa.admin.customerGroups.list()
* .then(({ customer_groups, limit, offset, count }) => {
* console.log(customer_groups.id);
* console.log(customer_groups.length);
* });
* - lang: Shell
* label: cURL
packages/medusa/src/api/routes/admin/draft-orders/create-draft-order.ts
+2 -2
View File
@@ -49,10 +49,10 @@ import { validator } from "../../../../utils/validator"
* format: email
* billing_address:
* description: "The Address to be used for billing purposes."
* $ref: "#/components/schemas/address"
* $ref: "#/components/schemas/address_fields"
* shipping_address:
* description: "The Address to be used for shipping."
* $ref: "#/components/schemas/address"
* $ref: "#/components/schemas/address_fields"
* items:
* description: The Line Items that have been received.
* type: array
packages/medusa/src/api/routes/admin/draft-orders/update-draft-order.ts
+2 -2
View File
@@ -47,10 +47,10 @@ import { validator } from "../../../../utils/validator"
* format: email
* billing_address:
* description: "The Address to be used for billing purposes."
* $ref: "#/components/schemas/address"
* $ref: "#/components/schemas/address_fields"
* shipping_address:
* description: "The Address to be used for shipping."
* $ref: "#/components/schemas/address"
* $ref: "#/components/schemas/address_fields"
* discounts:
* description: "An array of Discount codes to add to the Draft Order."
* type: array
packages/medusa/src/api/routes/admin/orders/update-order.ts
+2 -2
View File
@@ -35,11 +35,11 @@ import { validator } from "../../../../utils/validator"
* billing_address:
* description: Billing address
* anyOf:
* - $ref: "#/components/schemas/address"
* - $ref: "#/components/schemas/address_fields"
* shipping_address:
* description: Shipping address
* anyOf:
* - $ref: "#/components/schemas/address"
* - $ref: "#/components/schemas/address_fields"
* items:
* description: The Line Items for the order
* type: array
packages/medusa/src/api/routes/store/customers/create-address.ts
+10 -2
View File
@@ -21,8 +21,16 @@ import { EntityManager } from "typeorm"
* properties:
* address:
* description: "The Address to add to the Customer."
* anyOf:
* - $ref: "#/components/schemas/address"
* allOf:
* - $ref: "#/components/schemas/address_fields"
* - type: object
* required:
* - first_name
* - last_name
* - address_1
* - city
* - country_code
* - postal_code
* x-codeSamples:
* - lang: JavaScript
* label: JS Client
packages/medusa/src/api/routes/store/customers/update-address.ts
+1 -1
View File
@@ -18,7 +18,7 @@ import { EntityManager } from "typeorm"
* application/json:
* schema:
* anyOf:
* - $ref: "#/components/schemas/address"
* - $ref: "#/components/schemas/address_fields"
* x-codeSamples:
* - lang: JavaScript
* label: JS Client
packages/medusa/src/api/routes/store/customers/update-customer.ts
+1 -1
View File
@@ -27,7 +27,7 @@ import { EntityManager } from "typeorm"
* billing_address:
* description: "The Address to be used for billing purposes."
* anyOf:
* - $ref: "#/components/schemas/address"
* - $ref: "#/components/schemas/address_fields"
* description: The full billing address object
* - type: string
* description: The ID of an existing billing address
packages/medusa/src/api/routes/store/products/get-product.ts
+10 -1
View File
@@ -51,7 +51,16 @@ import { validator } from "../../../../utils/validator"
* schema:
* properties:
* product:
* $ref: "#/components/schemas/product"
* allOf:
* - $ref: "#/components/schemas/product"
* - type: object
* properties:
* variants:
* type: array
* items:
* allOf:
* - $ref: "#/components/schemas/product_variant"
* - $ref: "#/components/schemas/product_variant_prices_fields"
* "400":
* $ref: "#/components/responses/400_error"
* "404":
packages/medusa/src/api/routes/store/products/list-products.ts
+10 -1
View File
@@ -141,7 +141,16 @@ import { IsType } from "../../../../utils/validators/is-type"
* products:
* type: array
* items:
* $ref: "#/components/schemas/product"
* allOf:
* - $ref: "#/components/schemas/product"
* - type: object
* properties:
* variants:
* type: array
* items:
* allOf:
* - $ref: "#/components/schemas/product_variant"
* - $ref: "#/components/schemas/product_variant_prices_fields"
* count:
* type: integer
* description: The total number of items available
packages/medusa/src/api/routes/store/variants/get-variant.ts
+3 -1
View File
@@ -43,7 +43,9 @@ import { validator } from "../../../../utils/validator"
* schema:
* properties:
* variant:
* $ref: "#/components/schemas/product_variant"
* allOf:
* - $ref: "#/components/schemas/product_variant"
* - $ref: "#/components/schemas/product_variant_prices_fields"
* "400":
* $ref: "#/components/responses/400_error"
* "404":
packages/medusa/src/api/routes/store/variants/list-variants.ts
+3 -1
View File
@@ -77,7 +77,9 @@ import { validator } from "../../../../utils/validator"
* variants:
* type: array
* items:
* $ref: "#/components/schemas/product_variant"
* allOf:
* - $ref: "#/components/schemas/product_variant"
* - $ref: "#/components/schemas/product_variant_prices_fields"
* "400":
* $ref: "#/components/responses/400_error"
* "404":