docs: fix bugs in API reference (#10557)

This commit is contained in:
Shahed Nasser authored and GitHub committed 2024-12-11 18:32:58 +02:00
1 parent 0264294ab5
commit cccce65ef9
26 files changed
+91 -76

No files matched your search

@@ -1,6 +1,6 @@
curl -X POST '{backend_url}/store/carts/{id}/line-items' \ curl -X POST '{backend_url}/store/carts/{id}/line-items' \
-H 'Content-Type: application/json' \ \ -H 'Content-Type: application/json' \
-H 'x-publishable-api-key: {your_publishable_api_key}' -H 'x-publishable-api-key: {your_publishable_api_key}' \
--data-raw '{ --data-raw '{
"variant_id": "{value}", "variant_id": "{value}",
"quantity": 3360689747918848, "quantity": 3360689747918848,
@@ -1,6 +1,6 @@
curl -X POST '{backend_url}/store/carts/{id}/line-items/{line_id}' \ curl -X POST '{backend_url}/store/carts/{id}/line-items/{line_id}' \
-H 'Content-Type: application/json' \ \ -H 'Content-Type: application/json' \
-H 'x-publishable-api-key: {your_publishable_api_key}' -H 'x-publishable-api-key: {your_publishable_api_key}' \
--data-raw '{ --data-raw '{
"quantity": 8980402259623936, "quantity": 8980402259623936,
"metadata": {} "metadata": {}
@@ -1,6 +1,6 @@
curl -X POST '{backend_url}/store/carts/{id}/promotions' \ curl -X POST '{backend_url}/store/carts/{id}/promotions' \
-H 'Content-Type: application/json' \ \ -H 'Content-Type: application/json' \
-H 'x-publishable-api-key: {your_publishable_api_key}' -H 'x-publishable-api-key: {your_publishable_api_key}' \
--data-raw '{ --data-raw '{
"promo_codes": [ "promo_codes": [
"{value}" "{value}"
@@ -1,6 +1,6 @@
curl -X POST '{backend_url}/store/carts/{id}/shipping-methods' \ curl -X POST '{backend_url}/store/carts/{id}/shipping-methods' \
-H 'Content-Type: application/json' \ \ -H 'Content-Type: application/json' \
-H 'x-publishable-api-key: {your_publishable_api_key}' -H 'x-publishable-api-key: {your_publishable_api_key}' \
--data-raw '{ --data-raw '{
"option_id": "{value}" "option_id": "{value}"
}' }'
@@ -1,7 +1,7 @@
curl -X POST '{backend_url}/store/customers' \ curl -X POST '{backend_url}/store/customers' \
-H 'Authorization: Bearer {token}' \ -H 'Authorization: Bearer {token}' \
-H 'Content-Type: application/json' \ \ -H 'Content-Type: application/json' \
-H 'x-publishable-api-key: {your_publishable_api_key}' -H 'x-publishable-api-key: {your_publishable_api_key}' \
--data-raw '{ --data-raw '{
"email": "Monserrate.Leannon88@yahoo.com", "email": "Monserrate.Leannon88@yahoo.com",
"company_name": "{value}", "company_name": "{value}",
@@ -1,7 +1,7 @@
curl -X POST '{backend_url}/store/customers/me' \ curl -X POST '{backend_url}/store/customers/me' \
-H 'Authorization: Bearer {access_token}' \ -H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \ \ -H 'Content-Type: application/json' \
-H 'x-publishable-api-key: {your_publishable_api_key}' -H 'x-publishable-api-key: {your_publishable_api_key}' \
--data-raw '{ --data-raw '{
"company_name": "{value}", "company_name": "{value}",
"first_name": "{value}", "first_name": "{value}",
@@ -1,7 +1,7 @@
curl -X POST '{backend_url}/store/customers/me/addresses' \ curl -X POST '{backend_url}/store/customers/me/addresses' \
-H 'Authorization: Bearer {access_token}' \ -H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \ \ -H 'Content-Type: application/json' \
-H 'x-publishable-api-key: {your_publishable_api_key}' -H 'x-publishable-api-key: {your_publishable_api_key}' \
--data-raw '{ --data-raw '{
"metadata": {}, "metadata": {},
"first_name": "{value}", "first_name": "{value}",
@@ -1,3 +1,3 @@
curl -X DELETE '{backend_url}/store/customers/me/addresses/{address_id}' \ \ curl -X DELETE '{backend_url}/store/customers/me/addresses/{address_id}' \
-H 'x-publishable-api-key: {your_publishable_api_key}' -H 'x-publishable-api-key: {your_publishable_api_key}' \
-H 'Authorization: Bearer {access_token}' -H 'Authorization: Bearer {access_token}'
@@ -1,7 +1,7 @@
curl -X POST '{backend_url}/store/customers/me/addresses/{address_id}' \ curl -X POST '{backend_url}/store/customers/me/addresses/{address_id}' \
-H 'Authorization: Bearer {access_token}' \ -H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \ \ -H 'Content-Type: application/json' \
-H 'x-publishable-api-key: {your_publishable_api_key}' -H 'x-publishable-api-key: {your_publishable_api_key}' \
--data-raw '{ --data-raw '{
"first_name": "{value}", "first_name": "{value}",
}' }'
@@ -1,6 +1,6 @@
curl -X POST '{backend_url}/store/payment-collections' \ curl -X POST '{backend_url}/store/payment-collections' \
-H 'Content-Type: application/json' \ \ -H 'Content-Type: application/json' \
-H 'x-publishable-api-key: {your_publishable_api_key}' -H 'x-publishable-api-key: {your_publishable_api_key}' \
--data-raw '{ --data-raw '{
"cart_id": "{value}" "cart_id": "{value}"
}' }'
@@ -1,6 +1,6 @@
curl -X POST '{backend_url}/store/payment-collections/{id}/payment-sessions' \ curl -X POST '{backend_url}/store/payment-collections/{id}/payment-sessions' \
-H 'Content-Type: application/json' \ \ -H 'Content-Type: application/json' \
-H 'x-publishable-api-key: {your_publishable_api_key}' -H 'x-publishable-api-key: {your_publishable_api_key}' \
--data-raw '{ --data-raw '{
"provider_id": "{value}" "provider_id": "{value}"
}' }'
@@ -1,6 +1,6 @@
curl -X POST '{backend_url}/store/return' \ curl -X POST '{backend_url}/store/return' \
-H 'Content-Type: application/json' \ \ -H 'Content-Type: application/json' \
-H 'x-publishable-api-key: {your_publishable_api_key}' -H 'x-publishable-api-key: {your_publishable_api_key}' \
--data-raw '{ --data-raw '{
"order_id": "{value}", "order_id": "{value}",
"items": [ "items": [
@@ -935,8 +935,8 @@ paths:
label: cURL label: cURL
source: |- source: |-
curl -X POST '{backend_url}/store/carts/{id}/line-items' \ curl -X POST '{backend_url}/store/carts/{id}/line-items' \
-H 'Content-Type: application/json' \ \ -H 'Content-Type: application/json' \
-H 'x-publishable-api-key: {your_publishable_api_key}' -H 'x-publishable-api-key: {your_publishable_api_key}' \
--data-raw '{ --data-raw '{
"variant_id": "{value}", "variant_id": "{value}",
"quantity": 3360689747918848, "quantity": 3360689747918848,
@@ -1007,8 +1007,8 @@ paths:
label: cURL label: cURL
source: |- source: |-
curl -X POST '{backend_url}/store/carts/{id}/line-items/{line_id}' \ curl -X POST '{backend_url}/store/carts/{id}/line-items/{line_id}' \
-H 'Content-Type: application/json' \ \ -H 'Content-Type: application/json' \
-H 'x-publishable-api-key: {your_publishable_api_key}' -H 'x-publishable-api-key: {your_publishable_api_key}' \
--data-raw '{ --data-raw '{
"quantity": 8980402259623936, "quantity": 8980402259623936,
"metadata": {} "metadata": {}
@@ -1167,8 +1167,8 @@ paths:
label: cURL label: cURL
source: |- source: |-
curl -X POST '{backend_url}/store/carts/{id}/promotions' \ curl -X POST '{backend_url}/store/carts/{id}/promotions' \
-H 'Content-Type: application/json' \ \ -H 'Content-Type: application/json' \
-H 'x-publishable-api-key: {your_publishable_api_key}' -H 'x-publishable-api-key: {your_publishable_api_key}' \
--data-raw '{ --data-raw '{
"promo_codes": [ "promo_codes": [
"{value}" "{value}"
@@ -1303,8 +1303,8 @@ paths:
label: cURL label: cURL
source: |- source: |-
curl -X POST '{backend_url}/store/carts/{id}/shipping-methods' \ curl -X POST '{backend_url}/store/carts/{id}/shipping-methods' \
-H 'Content-Type: application/json' \ \ -H 'Content-Type: application/json' \
-H 'x-publishable-api-key: {your_publishable_api_key}' -H 'x-publishable-api-key: {your_publishable_api_key}' \
--data-raw '{ --data-raw '{
"option_id": "{value}" "option_id": "{value}"
}' }'
@@ -2252,8 +2252,8 @@ paths:
source: |- source: |-
curl -X POST '{backend_url}/store/customers' \ curl -X POST '{backend_url}/store/customers' \
-H 'Authorization: Bearer {token}' \ -H 'Authorization: Bearer {token}' \
-H 'Content-Type: application/json' \ \ -H 'Content-Type: application/json' \
-H 'x-publishable-api-key: {your_publishable_api_key}' -H 'x-publishable-api-key: {your_publishable_api_key}' \
--data-raw '{ --data-raw '{
"email": "Monserrate.Leannon88@yahoo.com", "email": "Monserrate.Leannon88@yahoo.com",
"company_name": "{value}", "company_name": "{value}",
@@ -2371,8 +2371,8 @@ paths:
source: |- source: |-
curl -X POST '{backend_url}/store/customers/me' \ curl -X POST '{backend_url}/store/customers/me' \
-H 'Authorization: Bearer {access_token}' \ -H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \ \ -H 'Content-Type: application/json' \
-H 'x-publishable-api-key: {your_publishable_api_key}' -H 'x-publishable-api-key: {your_publishable_api_key}' \
--data-raw '{ --data-raw '{
"company_name": "{value}", "company_name": "{value}",
"first_name": "{value}", "first_name": "{value}",
@@ -2625,8 +2625,8 @@ paths:
source: |- source: |-
curl -X POST '{backend_url}/store/customers/me/addresses' \ curl -X POST '{backend_url}/store/customers/me/addresses' \
-H 'Authorization: Bearer {access_token}' \ -H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \ \ -H 'Content-Type: application/json' \
-H 'x-publishable-api-key: {your_publishable_api_key}' -H 'x-publishable-api-key: {your_publishable_api_key}' \
--data-raw '{ --data-raw '{
"metadata": {}, "metadata": {},
"first_name": "{value}", "first_name": "{value}",
@@ -2815,8 +2815,8 @@ paths:
source: |- source: |-
curl -X POST '{backend_url}/store/customers/me/addresses/{address_id}' \ curl -X POST '{backend_url}/store/customers/me/addresses/{address_id}' \
-H 'Authorization: Bearer {access_token}' \ -H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \ \ -H 'Content-Type: application/json' \
-H 'x-publishable-api-key: {your_publishable_api_key}' -H 'x-publishable-api-key: {your_publishable_api_key}' \
--data-raw '{ --data-raw '{
"first_name": "{value}", "first_name": "{value}",
}' }'
@@ -2875,8 +2875,8 @@ paths:
- lang: Shell - lang: Shell
label: cURL label: cURL
source: |- source: |-
curl -X DELETE '{backend_url}/store/customers/me/addresses/{address_id}' \ \ curl -X DELETE '{backend_url}/store/customers/me/addresses/{address_id}' \
-H 'x-publishable-api-key: {your_publishable_api_key}' -H 'x-publishable-api-key: {your_publishable_api_key}' \
-H 'Authorization: Bearer {access_token}' -H 'Authorization: Bearer {access_token}'
tags: tags:
- Customers - Customers
@@ -3430,8 +3430,8 @@ paths:
label: cURL label: cURL
source: |- source: |-
curl -X POST '{backend_url}/store/payment-collections' \ curl -X POST '{backend_url}/store/payment-collections' \
-H 'Content-Type: application/json' \ \ -H 'Content-Type: application/json' \
-H 'x-publishable-api-key: {your_publishable_api_key}' -H 'x-publishable-api-key: {your_publishable_api_key}' \
--data-raw '{ --data-raw '{
"cart_id": "{value}" "cart_id": "{value}"
}' }'
@@ -3494,8 +3494,8 @@ paths:
label: cURL label: cURL
source: |- source: |-
curl -X POST '{backend_url}/store/payment-collections/{id}/payment-sessions' \ curl -X POST '{backend_url}/store/payment-collections/{id}/payment-sessions' \
-H 'Content-Type: application/json' \ \ -H 'Content-Type: application/json' \
-H 'x-publishable-api-key: {your_publishable_api_key}' -H 'x-publishable-api-key: {your_publishable_api_key}' \
--data-raw '{ --data-raw '{
"provider_id": "{value}" "provider_id": "{value}"
}' }'
@@ -5451,8 +5451,8 @@ paths:
label: cURL label: cURL
source: |- source: |-
curl -X POST '{backend_url}/store/return' \ curl -X POST '{backend_url}/store/return' \
-H 'Content-Type: application/json' \ \ -H 'Content-Type: application/json' \
-H 'x-publishable-api-key: {your_publishable_api_key}' -H 'x-publishable-api-key: {your_publishable_api_key}' \
--data-raw '{ --data-raw '{
"order_id": "{value}", "order_id": "{value}",
"items": [ "items": [
@@ -107,15 +107,30 @@ export const CodeTabs = ({
return return
} }
const codeBlockProps = codeBlock.props as CodeBlockProps let codeBlockProps = codeBlock.props as CodeBlockProps
const commonProps = {
badgeLabel: undefined,
hasTabs: true,
className: clsx("!my-0", codeBlockProps.className),
}
if (
typeof codeBlock.type !== "string" &&
"name" in codeBlock.type &&
codeBlock.type.name === "CodeBlock"
) {
codeBlockProps = {
...codeBlockProps,
...commonProps,
}
}
const modifiedProps: CodeBlockProps = { const modifiedProps: CodeBlockProps = {
...(getCodeBlockProps(codeBlock) || { ...(getCodeBlockProps(codeBlock) || {
source: "", source: "",
}), }),
badgeLabel: undefined, ...commonProps,
hasTabs: true,
className: clsx("!my-0", codeBlockProps.className),
} }
tempTabs.push({ tempTabs.push({
@@ -34,8 +34,8 @@
* - lang: Shell * - lang: Shell
* label: cURL * label: cURL
* source: |- * source: |-
* curl -X DELETE '{backend_url}/store/customers/me/addresses/{address_id}' \ \ * curl -X DELETE '{backend_url}/store/customers/me/addresses/{address_id}' \
* -H 'x-publishable-api-key: {your_publishable_api_key}' * -H 'x-publishable-api-key: {your_publishable_api_key}' \
* -H 'Authorization: Bearer {access_token}' * -H 'Authorization: Bearer {access_token}'
* tags: * tags:
* - Customers * - Customers
@@ -37,8 +37,8 @@
* label: cURL * label: cURL
* source: |- * source: |-
* curl -X POST '{backend_url}/store/carts/{id}/line-items' \ * curl -X POST '{backend_url}/store/carts/{id}/line-items' \
* -H 'Content-Type: application/json' \ \ * -H 'Content-Type: application/json' \
* -H 'x-publishable-api-key: {your_publishable_api_key}' * -H 'x-publishable-api-key: {your_publishable_api_key}' \
* --data-raw '{ * --data-raw '{
* "variant_id": "{value}", * "variant_id": "{value}",
* "quantity": 3360689747918848, * "quantity": 3360689747918848,
@@ -43,8 +43,8 @@
* label: cURL * label: cURL
* source: |- * source: |-
* curl -X POST '{backend_url}/store/carts/{id}/line-items/{line_id}' \ * curl -X POST '{backend_url}/store/carts/{id}/line-items/{line_id}' \
* -H 'Content-Type: application/json' \ \ * -H 'Content-Type: application/json' \
* -H 'x-publishable-api-key: {your_publishable_api_key}' * -H 'x-publishable-api-key: {your_publishable_api_key}' \
* --data-raw '{ * --data-raw '{
* "quantity": 8980402259623936, * "quantity": 8980402259623936,
* "metadata": {} * "metadata": {}
@@ -45,8 +45,8 @@
* label: cURL * label: cURL
* source: |- * source: |-
* curl -X POST '{backend_url}/store/carts/{id}/promotions' \ * curl -X POST '{backend_url}/store/carts/{id}/promotions' \
* -H 'Content-Type: application/json' \ \ * -H 'Content-Type: application/json' \
* -H 'x-publishable-api-key: {your_publishable_api_key}' * -H 'x-publishable-api-key: {your_publishable_api_key}' \
* --data-raw '{ * --data-raw '{
* "promo_codes": [ * "promo_codes": [
* "{value}" * "{value}"
@@ -51,8 +51,8 @@
* label: cURL * label: cURL
* source: |- * source: |-
* curl -X POST '{backend_url}/store/carts/{id}/shipping-methods' \ * curl -X POST '{backend_url}/store/carts/{id}/shipping-methods' \
* -H 'Content-Type: application/json' \ \ * -H 'Content-Type: application/json' \
* -H 'x-publishable-api-key: {your_publishable_api_key}' * -H 'x-publishable-api-key: {your_publishable_api_key}' \
* --data-raw '{ * --data-raw '{
* "option_id": "{value}" * "option_id": "{value}"
* }' * }'
@@ -31,8 +31,8 @@
* source: |- * source: |-
* curl -X POST '{backend_url}/store/customers' \ * curl -X POST '{backend_url}/store/customers' \
* -H 'Authorization: Bearer {token}' \ * -H 'Authorization: Bearer {token}' \
* -H 'Content-Type: application/json' \ \ * -H 'Content-Type: application/json' \
* -H 'x-publishable-api-key: {your_publishable_api_key}' * -H 'x-publishable-api-key: {your_publishable_api_key}' \
* --data-raw '{ * --data-raw '{
* "email": "Monserrate.Leannon88@yahoo.com", * "email": "Monserrate.Leannon88@yahoo.com",
* "company_name": "{value}", * "company_name": "{value}",
@@ -34,8 +34,8 @@
* source: |- * source: |-
* curl -X POST '{backend_url}/store/customers/me' \ * curl -X POST '{backend_url}/store/customers/me' \
* -H 'Authorization: Bearer {access_token}' \ * -H 'Authorization: Bearer {access_token}' \
* -H 'Content-Type: application/json' \ \ * -H 'Content-Type: application/json' \
* -H 'x-publishable-api-key: {your_publishable_api_key}' * -H 'x-publishable-api-key: {your_publishable_api_key}' \
* --data-raw '{ * --data-raw '{
* "company_name": "{value}", * "company_name": "{value}",
* "first_name": "{value}", * "first_name": "{value}",
@@ -92,8 +92,8 @@
* source: |- * source: |-
* curl -X POST '{backend_url}/store/customers/me/addresses' \ * curl -X POST '{backend_url}/store/customers/me/addresses' \
* -H 'Authorization: Bearer {access_token}' \ * -H 'Authorization: Bearer {access_token}' \
* -H 'Content-Type: application/json' \ \ * -H 'Content-Type: application/json' \
* -H 'x-publishable-api-key: {your_publishable_api_key}' * -H 'x-publishable-api-key: {your_publishable_api_key}' \
* --data-raw '{ * --data-raw '{
* "metadata": {}, * "metadata": {},
* "first_name": "{value}", * "first_name": "{value}",
@@ -98,8 +98,8 @@
* source: |- * source: |-
* curl -X POST '{backend_url}/store/customers/me/addresses/{address_id}' \ * curl -X POST '{backend_url}/store/customers/me/addresses/{address_id}' \
* -H 'Authorization: Bearer {access_token}' \ * -H 'Authorization: Bearer {access_token}' \
* -H 'Content-Type: application/json' \ \ * -H 'Content-Type: application/json' \
* -H 'x-publishable-api-key: {your_publishable_api_key}' * -H 'x-publishable-api-key: {your_publishable_api_key}' \
* --data-raw '{ * --data-raw '{
* "first_name": "{value}", * "first_name": "{value}",
* }' * }'
@@ -30,8 +30,8 @@
* label: cURL * label: cURL
* source: |- * source: |-
* curl -X POST '{backend_url}/store/payment-collections' \ * curl -X POST '{backend_url}/store/payment-collections' \
* -H 'Content-Type: application/json' \ \ * -H 'Content-Type: application/json' \
* -H 'x-publishable-api-key: {your_publishable_api_key}' * -H 'x-publishable-api-key: {your_publishable_api_key}' \
* --data-raw '{ * --data-raw '{
* "cart_id": "{value}" * "cart_id": "{value}"
* }' * }'
@@ -38,8 +38,8 @@
* label: cURL * label: cURL
* source: |- * source: |-
* curl -X POST '{backend_url}/store/payment-collections/{id}/payment-sessions' \ * curl -X POST '{backend_url}/store/payment-collections/{id}/payment-sessions' \
* -H 'Content-Type: application/json' \ \ * -H 'Content-Type: application/json' \
* -H 'x-publishable-api-key: {your_publishable_api_key}' * -H 'x-publishable-api-key: {your_publishable_api_key}' \
* --data-raw '{ * --data-raw '{
* "provider_id": "{value}" * "provider_id": "{value}"
* }' * }'
@@ -14,8 +14,8 @@
* label: cURL * label: cURL
* source: |- * source: |-
* curl -X POST '{backend_url}/store/return' \ * curl -X POST '{backend_url}/store/return' \
* -H 'Content-Type: application/json' \ \ * -H 'Content-Type: application/json' \
* -H 'x-publishable-api-key: {your_publishable_api_key}' * -H 'x-publishable-api-key: {your_publishable_api_key}' \
* --data-raw '{ * --data-raw '{
* "order_id": "{value}", * "order_id": "{value}",
* "items": [ * "items": [