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

chore(docs): Fix docblock-generator OAS tool's max-stack error (#7246)

Browse Source 
* regenerate oas to fix duplicate keys

* fix clean:oas script

* fix max-stack errors

* fix max-level condition
This commit is contained in:
Shahed Nasser
2024-05-06 13:41:59 +03:00
committed by GitHub
parent b39de05535
commit 7b2879d643
187 changed files with 7495 additions and 11011 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/utils/generated/oas-output/operations/store/get_store_collections.ts
+45 -3
View File
@@ -5,7 +5,47 @@
* description: Retrieve a list of collections. The collections can be filtered by
* fields such as `id`. The collections can also be sorted or paginated.
* x-authenticated: false
* parameters: []
* parameters:
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -13,8 +53,6 @@
* tags:
* - Collections
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -27,6 +65,10 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/
www/utils/generated/oas-output/operations/store/get_store_collections_[id].ts
+4 -2
View File
@@ -59,8 +59,6 @@
* tags:
* - Collections
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -73,6 +71,10 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/
www/utils/generated/oas-output/operations/store/get_store_product-categories.ts
+49 -1
View File
@@ -6,7 +6,47 @@
* be filtered by fields such as `id`. The product categories can also be sorted
* or paginated.
* x-authenticated: false
* parameters: []
* parameters:
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -16,6 +56,10 @@
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/StoreProductCategoryListResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -28,6 +72,10 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/
www/utils/generated/oas-output/operations/store/get_store_product-categories_[id].ts
+44
View File
@@ -12,6 +12,46 @@
* required: true
* schema:
* type: string
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* requestBody:
* content:
* application/json:
@@ -51,6 +91,10 @@
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/StoreProductCategoryResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/store/get_store_products.ts
+45 -3
View File
@@ -5,7 +5,47 @@
* description: Retrieve a list of products. The products can be filtered by fields
* such as `id`. The products can also be sorted or paginated.
* x-authenticated: false
* parameters: []
* parameters:
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -13,8 +53,6 @@
* tags:
* - Products
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -27,6 +65,10 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/
www/utils/generated/oas-output/operations/store/get_store_products_[id].ts
+44 -2
View File
@@ -12,6 +12,46 @@
* required: true
* schema:
* type: string
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -19,8 +59,6 @@
* tags:
* - Products
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -33,6 +71,10 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/
www/utils/generated/oas-output/operations/store/post_store_carts.ts
-4
View File
@@ -69,10 +69,6 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/
www/utils/generated/oas-output/operations/store/post_store_carts_[id].ts
-4
View File
@@ -75,10 +75,6 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/
www/utils/generated/oas-output/operations/store/post_store_carts_[id]_complete.ts
+93
View File
@@ -0,0 +1,93 @@
/**
* @oas [post] /store/carts/{id}/complete
* operationId: PostCartsIdComplete
* summary: Add Completes to Cart
* description: Add a list of completes to a cart.
* x-authenticated: false
* parameters:
* - name: id
* in: path
* description: The cart's ID.
* required: true
* schema:
* type: string
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - idempotency_key
* properties:
* idempotency_key:
* type: string
* title: idempotency_key
* description: The cart's idempotency key.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/store/carts/{id}/complete' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "idempotency_key": "{value}"
* }'
* tags:
* - Carts
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
www/utils/generated/oas-output/operations/store/post_store_carts_[id]_payment-collections.ts
+31 -24
View File
@@ -55,31 +55,8 @@
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/UpdateCartData"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X POST '{backend_url}/store/carts/{id}/payment-collections'
* tags:
* - Carts
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - region_id
* - email
@@ -241,6 +218,36 @@
* type: string
* title: promo_codes
* description: The promo code's promo codes.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/store/carts/{id}/payment-collections' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "region_id": "{value}",
* "email": "Greyson3@gmail.com",
* "sales_channel_id": "{value}",
* "metadata": {},
* "promo_codes": [
* "{value}"
* ]
* }'
* tags:
* - Carts
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
www/utils/generated/oas-output/operations/store/post_store_carts_[id]_shipping-methods.ts
+40 -2
View File
@@ -11,6 +11,46 @@
* required: true
* schema:
* type: string
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* requestBody:
* content:
* application/json:
@@ -42,8 +82,6 @@
* tags:
* - Carts
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/store/post_store_customers_me.ts
+41 -3
View File
@@ -4,7 +4,47 @@
* summary: Create Customer
* description: Create a customer.
* x-authenticated: false
* parameters: []
* parameters:
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* requestBody:
* content:
* application/json:
@@ -48,8 +88,6 @@
* tags:
* - Customers
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses.ts
+38 -29
View File
@@ -49,36 +49,8 @@
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/CreateCustomerAddress"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/store/customers/me/addresses' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "customer_id": "{value}"
* }'
* tags:
* - Customers
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - metadata
* - first_name
@@ -151,6 +123,43 @@
* type: boolean
* title: is_default_billing
* description: The customer's is default billing.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/store/customers/me/addresses' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "metadata": {},
* "first_name": "{value}",
* "last_name": "{value}",
* "phone": "{value}",
* "company": "{value}",
* "address_1": "{value}",
* "address_2": "{value}",
* "city": "{value}",
* "country_code": "{value}",
* "province": "{value}",
* "postal_code": "{value}",
* "address_name": "{value}",
* "is_default_shipping": false,
* "is_default_billing": true
* }'
* tags:
* - Customers
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts
+38 -24
View File
@@ -55,31 +55,8 @@
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/CustomerAddress"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X POST '{backend_url}/store/customers/me/addresses/{address_id}'
* tags:
* - Customers
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - metadata
* - first_name
@@ -152,6 +129,43 @@
* type: boolean
* title: is_default_billing
* description: The customer's is default billing.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/store/customers/me/addresses/{address_id}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "metadata": {},
* "first_name": "{value}",
* "last_name": "{value}",
* "phone": "{value}",
* "company": "{value}",
* "address_1": "{value}",
* "address_2": "{value}",
* "city": "{value}",
* "country_code": "{value}",
* "province": "{value}",
* "postal_code": "{value}",
* "address_name": "{value}",
* "is_default_shipping": true,
* "is_default_billing": false
* }'
* tags:
* - Customers
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/