docs: fix bugs in API reference (#10557)

2024-12-11 18:32:58 +02:00
parent 0264294ab5
commit cccce65ef9
26 changed files with 91 additions and 76 deletions
--- a/www/apps/api-reference/specs/store/code_samples/Shell/store_carts_{id}_line-items/post.sh
+++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_carts_{id}_line-items/post.sh
@@ -1,6 +1,6 @@
 curl -X POST '{backend_url}/store/carts/{id}/line-items' \
-H 'Content-Type: application/json' \ \
-H 'x-publishable-api-key: {your_publishable_api_key}'
+-H 'Content-Type: application/json' \
+-H 'x-publishable-api-key: {your_publishable_api_key}' \
 --data-raw '{
  "variant_id": "{value}",
  "quantity": 3360689747918848,
--- a/www/apps/api-reference/specs/store/code_samples/Shell/store_carts_{id}_line-items_{line_id}/post.sh
+++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_carts_{id}_line-items_{line_id}/post.sh
@@ -1,6 +1,6 @@
 curl -X POST '{backend_url}/store/carts/{id}/line-items/{line_id}' \
-H 'Content-Type: application/json' \ \
-H 'x-publishable-api-key: {your_publishable_api_key}'
+-H 'Content-Type: application/json' \
+-H 'x-publishable-api-key: {your_publishable_api_key}' \
 --data-raw '{
  "quantity": 8980402259623936,
  "metadata": {}
--- a/www/apps/api-reference/specs/store/code_samples/Shell/store_carts_{id}_promotions/post.sh
+++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_carts_{id}_promotions/post.sh
@@ -1,6 +1,6 @@
 curl -X POST '{backend_url}/store/carts/{id}/promotions' \
-H 'Content-Type: application/json' \ \
-H 'x-publishable-api-key: {your_publishable_api_key}'
+-H 'Content-Type: application/json' \
+-H 'x-publishable-api-key: {your_publishable_api_key}' \
 --data-raw '{
  "promo_codes": [
    "{value}"
--- a/www/apps/api-reference/specs/store/code_samples/Shell/store_carts_{id}_shipping-methods/post.sh
+++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_carts_{id}_shipping-methods/post.sh
@@ -1,6 +1,6 @@
 curl -X POST '{backend_url}/store/carts/{id}/shipping-methods' \
-H 'Content-Type: application/json' \ \
-H 'x-publishable-api-key: {your_publishable_api_key}'
+-H 'Content-Type: application/json' \
+-H 'x-publishable-api-key: {your_publishable_api_key}' \
 --data-raw '{
  "option_id": "{value}"
 }'
--- a/www/apps/api-reference/specs/store/code_samples/Shell/store_customers/post.sh
+++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_customers/post.sh
@@ -1,7 +1,7 @@
 curl -X POST '{backend_url}/store/customers' \
 -H 'Authorization: Bearer {token}' \
-H 'Content-Type: application/json' \ \
-H 'x-publishable-api-key: {your_publishable_api_key}'
+-H 'Content-Type: application/json' \
+-H 'x-publishable-api-key: {your_publishable_api_key}' \
 --data-raw '{
  "email": "Monserrate.Leannon88@yahoo.com",
  "company_name": "{value}",
--- a/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me/post.sh
+++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me/post.sh
@@ -1,7 +1,7 @@
 curl -X POST '{backend_url}/store/customers/me' \
 -H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \ \
-H 'x-publishable-api-key: {your_publishable_api_key}'
+-H 'Content-Type: application/json' \
+-H 'x-publishable-api-key: {your_publishable_api_key}' \
 --data-raw '{
  "company_name": "{value}",
  "first_name": "{value}",
--- a/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me_addresses/post.sh
+++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me_addresses/post.sh
@@ -1,7 +1,7 @@
 curl -X POST '{backend_url}/store/customers/me/addresses' \
 -H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \ \
-H 'x-publishable-api-key: {your_publishable_api_key}'
+-H 'Content-Type: application/json' \
+-H 'x-publishable-api-key: {your_publishable_api_key}' \
 --data-raw '{
  "metadata": {},
  "first_name": "{value}",
--- a/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me_addresses_{address_id}/delete.sh
+++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me_addresses_{address_id}/delete.sh
@@ -1,3 +1,3 @@
-curl -X DELETE '{backend_url}/store/customers/me/addresses/{address_id}' \ \
-H 'x-publishable-api-key: {your_publishable_api_key}'
+curl -X DELETE '{backend_url}/store/customers/me/addresses/{address_id}' \
+-H 'x-publishable-api-key: {your_publishable_api_key}' \
 -H 'Authorization: Bearer {access_token}'
--- a/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me_addresses_{address_id}/post.sh
+++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me_addresses_{address_id}/post.sh
@@ -1,7 +1,7 @@
 curl -X POST '{backend_url}/store/customers/me/addresses/{address_id}' \
 -H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \ \
-H 'x-publishable-api-key: {your_publishable_api_key}'
+-H 'Content-Type: application/json' \
+-H 'x-publishable-api-key: {your_publishable_api_key}' \
 --data-raw '{
  "first_name": "{value}",
 }'
--- a/www/apps/api-reference/specs/store/code_samples/Shell/store_payment-collections/post.sh
+++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_payment-collections/post.sh
@@ -1,6 +1,6 @@
 curl -X POST '{backend_url}/store/payment-collections' \
-H 'Content-Type: application/json' \ \
-H 'x-publishable-api-key: {your_publishable_api_key}'
+-H 'Content-Type: application/json' \
+-H 'x-publishable-api-key: {your_publishable_api_key}' \
 --data-raw '{
  "cart_id": "{value}"
 }'
--- a/www/apps/api-reference/specs/store/code_samples/Shell/store_payment-collections_{id}_payment-sessions/post.sh
+++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_payment-collections_{id}_payment-sessions/post.sh
@@ -1,6 +1,6 @@
 curl -X POST '{backend_url}/store/payment-collections/{id}/payment-sessions' \
-H 'Content-Type: application/json' \ \
-H 'x-publishable-api-key: {your_publishable_api_key}'
+-H 'Content-Type: application/json' \
+-H 'x-publishable-api-key: {your_publishable_api_key}' \
 --data-raw '{
  "provider_id": "{value}"
 }'
--- a/www/apps/api-reference/specs/store/code_samples/Shell/store_return/post.sh
+++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_return/post.sh
@@ -1,6 +1,6 @@
 curl -X POST '{backend_url}/store/return' \
-H 'Content-Type: application/json' \ \
-H 'x-publishable-api-key: {your_publishable_api_key}'
+-H 'Content-Type: application/json' \
+-H 'x-publishable-api-key: {your_publishable_api_key}' \
 --data-raw '{
  "order_id": "{value}",
  "items": [
--- a/www/apps/api-reference/specs/store/openapi.full.yaml
+++ b/www/apps/api-reference/specs/store/openapi.full.yaml
@@ -935,8 +935,8 @@ paths:
          label: cURL
          source: |-
            curl -X POST '{backend_url}/store/carts/{id}/line-items' \
-            -H 'Content-Type: application/json' \ \
-            -H 'x-publishable-api-key: {your_publishable_api_key}'
+            -H 'Content-Type: application/json' \
+            -H 'x-publishable-api-key: {your_publishable_api_key}' \
            --data-raw '{
              "variant_id": "{value}",
              "quantity": 3360689747918848,
@@ -1007,8 +1007,8 @@ paths:
          label: cURL
          source: |-
            curl -X POST '{backend_url}/store/carts/{id}/line-items/{line_id}' \
-            -H 'Content-Type: application/json' \ \
-            -H 'x-publishable-api-key: {your_publishable_api_key}'
+            -H 'Content-Type: application/json' \
+            -H 'x-publishable-api-key: {your_publishable_api_key}' \
            --data-raw '{
              "quantity": 8980402259623936,
              "metadata": {}
@@ -1167,8 +1167,8 @@ paths:
          label: cURL
          source: |-
            curl -X POST '{backend_url}/store/carts/{id}/promotions' \
-            -H 'Content-Type: application/json' \ \
-            -H 'x-publishable-api-key: {your_publishable_api_key}'
+            -H 'Content-Type: application/json' \
+            -H 'x-publishable-api-key: {your_publishable_api_key}' \
            --data-raw '{
              "promo_codes": [
                "{value}"
@@ -1303,8 +1303,8 @@ paths:
          label: cURL
          source: |-
            curl -X POST '{backend_url}/store/carts/{id}/shipping-methods' \
-            -H 'Content-Type: application/json' \ \
-            -H 'x-publishable-api-key: {your_publishable_api_key}'
+            -H 'Content-Type: application/json' \
+            -H 'x-publishable-api-key: {your_publishable_api_key}' \
            --data-raw '{
              "option_id": "{value}"
            }'
@@ -2252,8 +2252,8 @@ paths:
          source: |-
            curl -X POST '{backend_url}/store/customers' \
            -H 'Authorization: Bearer {token}' \
-            -H 'Content-Type: application/json' \ \
-            -H 'x-publishable-api-key: {your_publishable_api_key}'
+            -H 'Content-Type: application/json' \
+            -H 'x-publishable-api-key: {your_publishable_api_key}' \
            --data-raw '{
              "email": "Monserrate.Leannon88@yahoo.com",
              "company_name": "{value}",
@@ -2371,8 +2371,8 @@ paths:
          source: |-
            curl -X POST '{backend_url}/store/customers/me' \
            -H 'Authorization: Bearer {access_token}' \
-            -H 'Content-Type: application/json' \ \
-            -H 'x-publishable-api-key: {your_publishable_api_key}'
+            -H 'Content-Type: application/json' \
+            -H 'x-publishable-api-key: {your_publishable_api_key}' \
            --data-raw '{
              "company_name": "{value}",
              "first_name": "{value}",
@@ -2625,8 +2625,8 @@ paths:
          source: |-
            curl -X POST '{backend_url}/store/customers/me/addresses' \
            -H 'Authorization: Bearer {access_token}' \
-            -H 'Content-Type: application/json' \ \
-            -H 'x-publishable-api-key: {your_publishable_api_key}'
+            -H 'Content-Type: application/json' \
+            -H 'x-publishable-api-key: {your_publishable_api_key}' \
            --data-raw '{
              "metadata": {},
              "first_name": "{value}",
@@ -2815,8 +2815,8 @@ paths:
          source: |-
            curl -X POST '{backend_url}/store/customers/me/addresses/{address_id}' \
            -H 'Authorization: Bearer {access_token}' \
-            -H 'Content-Type: application/json' \ \
-            -H 'x-publishable-api-key: {your_publishable_api_key}'
+            -H 'Content-Type: application/json' \
+            -H 'x-publishable-api-key: {your_publishable_api_key}' \
            --data-raw '{
              "first_name": "{value}",
            }'
@@ -2875,8 +2875,8 @@ paths:
        - lang: Shell
          label: cURL
          source: |-
-            curl -X DELETE '{backend_url}/store/customers/me/addresses/{address_id}' \ \
-            -H 'x-publishable-api-key: {your_publishable_api_key}'
+            curl -X DELETE '{backend_url}/store/customers/me/addresses/{address_id}' \
+            -H 'x-publishable-api-key: {your_publishable_api_key}' \
            -H 'Authorization: Bearer {access_token}'
      tags:
        - Customers
@@ -3430,8 +3430,8 @@ paths:
          label: cURL
          source: |-
            curl -X POST '{backend_url}/store/payment-collections' \
-            -H 'Content-Type: application/json' \ \
-            -H 'x-publishable-api-key: {your_publishable_api_key}'
+            -H 'Content-Type: application/json' \
+            -H 'x-publishable-api-key: {your_publishable_api_key}' \
            --data-raw '{
              "cart_id": "{value}"
            }'
@@ -3494,8 +3494,8 @@ paths:
          label: cURL
          source: |-
            curl -X POST '{backend_url}/store/payment-collections/{id}/payment-sessions' \
-            -H 'Content-Type: application/json' \ \
-            -H 'x-publishable-api-key: {your_publishable_api_key}'
+            -H 'Content-Type: application/json' \
+            -H 'x-publishable-api-key: {your_publishable_api_key}' \
            --data-raw '{
              "provider_id": "{value}"
            }'
@@ -5451,8 +5451,8 @@ paths:
          label: cURL
          source: |-
            curl -X POST '{backend_url}/store/return' \
-            -H 'Content-Type: application/json' \ \
-            -H 'x-publishable-api-key: {your_publishable_api_key}'
+            -H 'Content-Type: application/json' \
+            -H 'x-publishable-api-key: {your_publishable_api_key}' \
            --data-raw '{
              "order_id": "{value}",
              "items": [
--- a/www/packages/docs-ui/src/components/CodeTabs/index.tsx
+++ b/www/packages/docs-ui/src/components/CodeTabs/index.tsx
@@ -107,15 +107,30 @@ export const CodeTabs = ({
        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 = {
        ...(getCodeBlockProps(codeBlock) || {
          source: "",
        }),
-        badgeLabel: undefined,
-        hasTabs: true,
-        className: clsx("!my-0", codeBlockProps.className),
+        ...commonProps,
      }

      tempTabs.push({
--- a/www/utils/generated/oas-output/operations/store/delete_store_customers_me_addresses_[address_id].ts
+++ b/www/utils/generated/oas-output/operations/store/delete_store_customers_me_addresses_[address_id].ts
@@ -34,8 +34,8 @@
 *   - lang: Shell
 *     label: cURL
 *     source: |-
- *       curl -X DELETE '{backend_url}/store/customers/me/addresses/{address_id}' \ \
- *       -H 'x-publishable-api-key: {your_publishable_api_key}'
+ *       curl -X DELETE '{backend_url}/store/customers/me/addresses/{address_id}' \
+ *       -H 'x-publishable-api-key: {your_publishable_api_key}' \
 *       -H 'Authorization: Bearer {access_token}'
 * tags:
 *   - Customers
--- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items.ts
+++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items.ts
@@ -37,8 +37,8 @@
 *     label: cURL
 *     source: |-
 *       curl -X POST '{backend_url}/store/carts/{id}/line-items' \
- *       -H 'Content-Type: application/json' \ \
- *       -H 'x-publishable-api-key: {your_publishable_api_key}'
+ *       -H 'Content-Type: application/json' \
+ *       -H 'x-publishable-api-key: {your_publishable_api_key}' \
 *       --data-raw '{
 *         "variant_id": "{value}",
 *         "quantity": 3360689747918848,
--- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items_[line_id].ts
+++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items_[line_id].ts
@@ -43,8 +43,8 @@
 *     label: cURL
 *     source: |-
 *       curl -X POST '{backend_url}/store/carts/{id}/line-items/{line_id}' \
- *       -H 'Content-Type: application/json' \ \
- *       -H 'x-publishable-api-key: {your_publishable_api_key}'
+ *       -H 'Content-Type: application/json' \
+ *       -H 'x-publishable-api-key: {your_publishable_api_key}' \
 *       --data-raw '{
 *         "quantity": 8980402259623936,
 *         "metadata": {}
--- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_promotions.ts
+++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_promotions.ts
@@ -45,8 +45,8 @@
 *     label: cURL
 *     source: |-
 *       curl -X POST '{backend_url}/store/carts/{id}/promotions' \
- *       -H 'Content-Type: application/json' \ \
- *       -H 'x-publishable-api-key: {your_publishable_api_key}'
+ *       -H 'Content-Type: application/json' \
+ *       -H 'x-publishable-api-key: {your_publishable_api_key}' \
 *       --data-raw '{
 *         "promo_codes": [
 *           "{value}"
--- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_shipping-methods.ts
+++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_shipping-methods.ts
@@ -51,8 +51,8 @@
 *     label: cURL
 *     source: |-
 *       curl -X POST '{backend_url}/store/carts/{id}/shipping-methods' \
- *       -H 'Content-Type: application/json' \ \
- *       -H 'x-publishable-api-key: {your_publishable_api_key}'
+ *       -H 'Content-Type: application/json' \
+ *       -H 'x-publishable-api-key: {your_publishable_api_key}' \
 *       --data-raw '{
 *         "option_id": "{value}"
 *       }'
--- a/www/utils/generated/oas-output/operations/store/post_store_customers.ts
+++ b/www/utils/generated/oas-output/operations/store/post_store_customers.ts
@@ -31,8 +31,8 @@
 *     source: |-
 *       curl -X POST '{backend_url}/store/customers' \
 *       -H 'Authorization: Bearer {token}' \
- *       -H 'Content-Type: application/json' \ \
- *       -H 'x-publishable-api-key: {your_publishable_api_key}'
+ *       -H 'Content-Type: application/json' \
+ *       -H 'x-publishable-api-key: {your_publishable_api_key}' \
 *       --data-raw '{
 *         "email": "Monserrate.Leannon88@yahoo.com",
 *         "company_name": "{value}",
--- a/www/utils/generated/oas-output/operations/store/post_store_customers_me.ts
+++ b/www/utils/generated/oas-output/operations/store/post_store_customers_me.ts
@@ -34,8 +34,8 @@
 *     source: |-
 *       curl -X POST '{backend_url}/store/customers/me' \
 *       -H 'Authorization: Bearer {access_token}' \
- *       -H 'Content-Type: application/json' \ \
- *       -H 'x-publishable-api-key: {your_publishable_api_key}'
+ *       -H 'Content-Type: application/json' \
+ *       -H 'x-publishable-api-key: {your_publishable_api_key}' \
 *       --data-raw '{
 *         "company_name": "{value}",
 *         "first_name": "{value}",
--- a/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses.ts
+++ b/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses.ts
@@ -92,8 +92,8 @@
 *     source: |-
 *       curl -X POST '{backend_url}/store/customers/me/addresses' \
 *       -H 'Authorization: Bearer {access_token}' \
- *       -H 'Content-Type: application/json' \ \
- *       -H 'x-publishable-api-key: {your_publishable_api_key}'
+ *       -H 'Content-Type: application/json' \
+ *       -H 'x-publishable-api-key: {your_publishable_api_key}' \
 *       --data-raw '{
 *         "metadata": {},
 *         "first_name": "{value}",
--- a/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts
+++ b/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts
@@ -98,8 +98,8 @@
 *     source: |-
 *       curl -X POST '{backend_url}/store/customers/me/addresses/{address_id}' \
 *       -H 'Authorization: Bearer {access_token}' \
- *       -H 'Content-Type: application/json' \ \
- *       -H 'x-publishable-api-key: {your_publishable_api_key}'
+ *       -H 'Content-Type: application/json' \
+ *       -H 'x-publishable-api-key: {your_publishable_api_key}' \
 *       --data-raw '{
 *         "first_name": "{value}",
 *       }'
--- a/www/utils/generated/oas-output/operations/store/post_store_payment-collections.ts
+++ b/www/utils/generated/oas-output/operations/store/post_store_payment-collections.ts
@@ -30,8 +30,8 @@
 *     label: cURL
 *     source: |-
 *       curl -X POST '{backend_url}/store/payment-collections' \
- *       -H 'Content-Type: application/json' \ \
- *       -H 'x-publishable-api-key: {your_publishable_api_key}'
+ *       -H 'Content-Type: application/json' \
+ *       -H 'x-publishable-api-key: {your_publishable_api_key}' \
 *       --data-raw '{
 *         "cart_id": "{value}"
 *       }'
--- a/www/utils/generated/oas-output/operations/store/post_store_payment-collections_[id]_payment-sessions.ts
+++ b/www/utils/generated/oas-output/operations/store/post_store_payment-collections_[id]_payment-sessions.ts
@@ -38,8 +38,8 @@
 *     label: cURL
 *     source: |-
 *       curl -X POST '{backend_url}/store/payment-collections/{id}/payment-sessions' \
- *       -H 'Content-Type: application/json' \ \
- *       -H 'x-publishable-api-key: {your_publishable_api_key}'
+ *       -H 'Content-Type: application/json' \
+ *       -H 'x-publishable-api-key: {your_publishable_api_key}' \
 *       --data-raw '{
 *         "provider_id": "{value}"
 *       }'
--- a/www/utils/generated/oas-output/operations/store/post_store_return.ts
+++ b/www/utils/generated/oas-output/operations/store/post_store_return.ts
@@ -14,8 +14,8 @@
 *     label: cURL
 *     source: |-
 *       curl -X POST '{backend_url}/store/return' \
- *       -H 'Content-Type: application/json' \ \
- *       -H 'x-publishable-api-key: {your_publishable_api_key}'
+ *       -H 'Content-Type: application/json' \
+ *       -H 'x-publishable-api-key: {your_publishable_api_key}' \
 *       --data-raw '{
 *         "order_id": "{value}",
 *         "items": [