-
-
Notifications
You must be signed in to change notification settings - Fork 2.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: fix bugs in API reference (#10557)
- Loading branch information
1 parent
0264294
commit cccce65
Showing
26 changed files
with
91 additions
and
76 deletions.
There are no files selected for viewing
4 changes: 2 additions & 2 deletions
4
www/apps/api-reference/specs/store/code_samples/Shell/store_carts_{id}_line-items/post.sh
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
...pi-reference/specs/store/code_samples/Shell/store_carts_{id}_line-items_{line_id}/post.sh
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
www/apps/api-reference/specs/store/code_samples/Shell/store_carts_{id}_promotions/post.sh
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
...ps/api-reference/specs/store/code_samples/Shell/store_carts_{id}_shipping-methods/post.sh
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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}" | ||
| }' |
4 changes: 2 additions & 2 deletions
4
www/apps/api-reference/specs/store/code_samples/Shell/store_customers/post.sh
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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": "[email protected]", | ||
| "company_name": "{value}", | ||
|
|
||
4 changes: 2 additions & 2 deletions
4
www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me/post.sh
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me_addresses/post.sh
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
...erence/specs/store/code_samples/Shell/store_customers_me_addresses_{address_id}/delete.sh
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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}' |
4 changes: 2 additions & 2 deletions
4
...eference/specs/store/code_samples/Shell/store_customers_me_addresses_{address_id}/post.sh
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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}", | ||
| }' |
4 changes: 2 additions & 2 deletions
4
www/apps/api-reference/specs/store/code_samples/Shell/store_payment-collections/post.sh
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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}" | ||
| }' |
4 changes: 2 additions & 2 deletions
4
...ce/specs/store/code_samples/Shell/store_payment-collections_{id}_payment-sessions/post.sh
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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}" | ||
| }' |
4 changes: 2 additions & 2 deletions
4
www/apps/api-reference/specs/store/code_samples/Shell/store_return/post.sh
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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": "[email protected]", | ||
| "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": [ | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.