chore: fix build errors in OAS (#9059)

Fix errors stopping OAS from building
This commit is contained in:
Shahed Nasser
2024-09-09 16:54:14 +03:00
committed by GitHub
parent 4ffcc41fe7
commit 2189ff2dc8
25 changed files with 36 additions and 48 deletions

View File

@@ -10,7 +10,8 @@
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X POST '{backend_url}/auth/token/refresh' \
* source: |-
* curl -X POST '{backend_url}/auth/token/refresh' \
* -H 'Authorization: Bearer {token}'
* tags:
* - Auth

View File

@@ -6,7 +6,7 @@
* description: Remove a line item from a cart.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items#remove-line-item-from-cart
* description: Storefront guide: How to remove line item from cart.
* description: "Storefront guide: How to remove line item from cart."
* x-authenticated: false
* parameters:
* - name: id

View File

@@ -7,7 +7,7 @@
* x-authenticated: true
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses#delete-customer-address
* description: Storefront guide: How to delete a customer's address.
* description: "Storefront guide: How to delete a customer's address."
* parameters:
* - name: address_id
* in: path

View File

@@ -6,7 +6,7 @@
* x-authenticated: false
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/storefront-development/products/collections/list
* description: Storefront guide: How to retrieve a list of collections.
* description: "Storefront guide: How to retrieve a list of collections."
* parameters:
* - name: expand
* in: query

View File

@@ -6,7 +6,7 @@
* x-authenticated: false
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/storefront-development/products/collections/retrieve
* description: Storefront guide: How to retrieve a collection.
* description: "Storefront guide: How to retrieve a collection."
* parameters:
* - name: id
* in: path

View File

@@ -7,7 +7,7 @@
* x-authenticated: true
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/storefront-development/customers/retrieve
* description: Storefront guide: How to retrieve the logged-in customer.
* description: "Storefront guide: How to retrieve the logged-in customer."
* parameters:
* - name: expand
* in: query

View File

@@ -7,7 +7,7 @@
* x-authenticated: true
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses#list-customer-addresses
* description: Storefront guide: How to retrieve the logged-in customer's addresses.
* description: "Storefront guide: How to retrieve the logged-in customer's addresses."
* parameters:
* - name: expand
* in: query

View File

@@ -6,7 +6,7 @@
* x-authenticated: false
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment
* description: Storefront guide: How to implement payment during checkout.
* description: "Storefront guide: How to implement payment during checkout."
* parameters:
* - name: expand
* in: query

View File

@@ -6,7 +6,7 @@
* x-authenticated: false
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/storefront-development/products/categories/list
* description: Storefront guide: How to retrieve a list of product categories.
* description: "Storefront guide: How to retrieve a list of product categories."
* parameters:
* - name: expand
* in: query

View File

@@ -6,7 +6,7 @@
* x-authenticated: false
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/storefront-development/products/categories/retrieve
* description: Storefront guide: How to retrieve a product category.
* description: "Storefront guide: How to retrieve a product category."
* parameters:
* - name: id
* in: path

View File

@@ -6,7 +6,7 @@
* x-authenticated: false
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/storefront-development/products/price
* description: Storefront guide: How to retrieve a product variants' prices.
* description: "Storefront guide: How to retrieve a product variants' prices."
* parameters:
* - name: expand
* in: query
@@ -134,11 +134,11 @@
* in: query
* description: Filter by a collection's ID to retrieve the products in it.
* required: false
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/storefront-development/products/collections/products
* description: Storefront guides: Retrieve a collection's products.
* schema:
* description: Filter by a collection's ID to retrieve the products in it.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/storefront-development/products/collections/products
* description: "Storefront guide: Retrieve a collection's products."
* items:
* type: string
* title: collection_id
@@ -870,13 +870,13 @@
* in: query
* description: The ID of the region the products are being viewed from. This is required if you're retrieving product variant prices with taxes.
* required: false
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/storefront-development/products/price/examples/tax-price
* description: Storefront guide: How to show product variants' prices with taxes.
* schema:
* type: string
* title: region_id
* description: The ID of the region the products are being viewed from. This is required if you're retrieving product variant prices with taxes.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/storefront-development/products/price/examples/tax-price
* description: "Storefront guide: How to show product variants' prices with taxes."
* - name: country_code
* in: query
* description: The country code the products are being viewed from. This is required if you're retrieving product variant prices with taxes.

View File

@@ -6,7 +6,7 @@
* x-authenticated: false
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/storefront-development/products/price
* description: Storefront guide: How to retrieve a product variants' prices.
* description: "Storefront guide: How to retrieve a product variants' prices."
* parameters:
* - name: id
* in: path
@@ -36,13 +36,13 @@
* in: query
* description: The ID of the region the product is being viewed from. This is required if you're retrieving product variant prices with taxes.
* required: false
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/storefront-development/products/price/examples/tax-price
* description: Storefront guide: How to show product variants' prices with taxes.
* schema:
* type: string
* title: region_id
* description: The ID of the region the product is being viewed from. This is required if you're retrieving product variant prices with taxes.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/storefront-development/products/price/examples/tax-price
* description: "Storefront guide: How to show product variants' prices with taxes."
* - name: country_code
* in: query
* description: The country code the product is being viewed from. This is required if you're retrieving product variant prices with taxes.

View File

@@ -6,7 +6,7 @@
* x-authenticated: false
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/storefront-development/regions/list
* description: Storefront guide: How to retrieve a list of regions.
* description: "Storefront guide: How to retrieve a list of regions."
* parameters:
* - name: expand
* in: query
@@ -120,20 +120,6 @@
* items:
* type: object
* title: $or
* - name: currency_code
* in: query
* required: false
* schema:
* oneOf:
* - type: string
* title: currency_code
* description: The region's currency code.
* - type: array
* description: The region's currency code.
* items:
* type: string
* title: currency_code
* description: The currency code's details.
* x-codeSamples:
* - lang: Shell
* label: cURL

View File

@@ -9,7 +9,7 @@
* The shipping options also be sorted or paginated.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping
* description: Storefront guide: How to implement shipping during checkout.
* description: "Storefront guide: How to implement shipping during checkout."
* x-authenticated: false
* parameters:
* - name: fields

View File

@@ -10,7 +10,8 @@
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X POST '{backend_url}/auth/token/refresh' \
* source: |-
* curl -X POST '{backend_url}/auth/token/refresh' \
* -H 'Authorization: Bearer {token}'
* tags:
* - Auth

View File

@@ -6,7 +6,7 @@
* x-authenticated: false
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/complete-cart
* description: Storefront guide: How to implement cart completion during checkout.
* description: "Storefront guide: How to implement cart completion during checkout."
* parameters:
* - name: id
* in: path

View File

@@ -6,7 +6,7 @@
* description: Add a product variant as a line item in the cart.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items#add-product-variant-to-cart
* description: Storefront guide: How to add a product variant to the cart.
* description: "Storefront guide: How to add a product variant to the cart."
* x-authenticated: false
* parameters:
* - name: id

View File

@@ -6,7 +6,7 @@
* description: Update a line item's details in the cart.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items#update-line-item-in-cart
* description: Storefront guide: How to update a cart's line item.
* description: "Storefront guide: How to update a cart's line item."
* x-authenticated: false
* parameters:
* - name: id

View File

@@ -6,7 +6,7 @@
* description: Add a shipping method to a cart. Use this API route when the customer chooses their preferred shipping option.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping
* description: Storefront guide: How to implement shipping during checkout.
* description: "Storefront guide: How to implement shipping during checkout."
* x-authenticated: false
* parameters:
* - name: id

View File

@@ -5,7 +5,7 @@
* description: Register a customer. Use the `/auth/customer/emailpass/register` API route first to retrieve the registration token and pass it in the header of the request.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/storefront-development/customers/register
* description: Storefront guide: How to register a customer.
* description: "Storefront guide: How to register a customer."
* x-authenticated: true
* parameters:
* - name: expand

View File

@@ -5,7 +5,7 @@
* description: Update the logged-in customer's details.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/storefront-development/customers/profile
* description: Storefront guide: How to edit a customer's profile.
* description: "Storefront guide: How to edit a customer's profile."
* x-authenticated: true
* parameters:
* - name: expand

View File

@@ -6,7 +6,7 @@
* description: Create an address for the logged-in customer.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses#add-customer-address
* description: Storefront guide: How to create an address for the logged-in customer.
* description: "Storefront guide: How to create an address for the logged-in customer."
* x-authenticated: true
* parameters:
* - name: expand

View File

@@ -6,7 +6,7 @@
* description: Update the logged-in customer's address.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses#edit-an-address
* description: Storefront guide: How to update an address of the logged-in customer.
* description: "Storefront guide: How to update an address of the logged-in customer."
* x-authenticated: true
* parameters:
* - name: address_id

View File

@@ -5,7 +5,7 @@
* description: Create a payment collection for a cart. This is used during checkout, where the payment collection holds the cart's payment sessions.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment
* description: Storefront guide: How to implement payment during checkout.
* description: "Storefront guide: How to implement payment during checkout."
* x-authenticated: false
* parameters:
* - name: expand

View File

@@ -6,7 +6,7 @@
* description: Initialize and add a payment session to a payment collection. This is used during checkout, where you create a payment collection for the cart, then initialize a payment session for the payment provider that the customer chooses.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment
* description: Storefront guide: How to implement payment during checkout.
* description: "Storefront guide: How to implement payment during checkout."
* x-authenticated: false
* parameters:
* - name: id