-
-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(docs): Updated API Reference (v2) (#9148)
Automated changes by [create-pull-request](https:/peter-evans/create-pull-request) GitHub action Co-authored-by: Oli Juhl <[email protected]>
- Loading branch information
1 parent
a63f691
commit 56ee4d6
Showing
254 changed files
with
6,353 additions
and
5,465 deletions.
There are no files selected for viewing
2 changes: 2 additions & 0 deletions
2
www/apps/api-reference/specs/admin/code_samples/Shell/auth_token_refresh/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 |
---|---|---|
@@ -0,0 +1,2 @@ | ||
curl -X POST '{backend_url}/auth/token/refresh' \ | ||
-H 'Authorization: Bearer {token}' |
2 changes: 1 addition & 1 deletion
2
www/apps/api-reference/specs/admin/code_samples/Shell/auth_user_{auth_provider}/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 +1 @@ | ||
curl -X POST '{backend_url}/auth/user/{auth_provider}' | ||
curl -X POST '{backend_url}/auth/user/github' |
2 changes: 1 addition & 1 deletion
2
...s/api-reference/specs/admin/code_samples/Shell/auth_user_{auth_provider}_callback/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 +1 @@ | ||
curl -X POST '{backend_url}/auth/user/{auth_provider}/callback' | ||
curl -X POST '{backend_url}/auth/user/github/callback?code=123' |
7 changes: 6 additions & 1 deletion
7
...s/api-reference/specs/admin/code_samples/Shell/auth_user_{auth_provider}_register/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 +1,6 @@ | ||
curl -X POST '{backend_url}/auth/user/{auth_provider}/register' | ||
curl -X POST '{backend_url}/auth/user/emailpass/register' \ | ||
-H 'Content-Type: application/json' \ | ||
--data-raw '{ | ||
"email": "[email protected]", | ||
"password": "supersecret" | ||
}' |
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
2 changes: 1 addition & 1 deletion
2
www/apps/api-reference/specs/admin/components/schemas/AdminApiKeyResponse.yaml
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
10 changes: 5 additions & 5 deletions
10
www/apps/api-reference/specs/admin/components/schemas/AdminBatchProductRequest.yaml
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,21 +1,21 @@ | ||
type: object | ||
description: SUMMARY | ||
description: The products to create, update, or delete. | ||
x-schemaName: AdminBatchProductRequest | ||
properties: | ||
create: | ||
type: array | ||
description: The product's create. | ||
description: The products to create. | ||
items: | ||
$ref: ./AdminCreateProduct.yaml | ||
update: | ||
type: array | ||
description: The product's update. | ||
description: The products to update. | ||
items: | ||
$ref: ./AdminUpdateProduct.yaml | ||
delete: | ||
type: array | ||
description: The product's delete. | ||
description: The products to delete. | ||
items: | ||
type: string | ||
title: delete | ||
description: The delete's details. | ||
description: A product's ID. |
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
10 changes: 5 additions & 5 deletions
10
www/apps/api-reference/specs/admin/components/schemas/AdminBatchProductVariantRequest.yaml
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,21 +1,21 @@ | ||
type: object | ||
description: SUMMARY | ||
description: The product variants to create, update, or delete. | ||
x-schemaName: AdminBatchProductVariantRequest | ||
properties: | ||
create: | ||
type: array | ||
description: The product's create. | ||
description: The product variants to create. | ||
items: | ||
$ref: ./AdminCreateProductVariant.yaml | ||
update: | ||
type: array | ||
description: The product's update. | ||
description: The product variants to update. | ||
items: | ||
$ref: ./AdminUpdateProductVariant.yaml | ||
delete: | ||
type: array | ||
description: The product's delete. | ||
description: The product variants to delete. | ||
items: | ||
type: string | ||
title: delete | ||
description: The delete's details. | ||
description: A product variant's ID. |
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
2 changes: 1 addition & 1 deletion
2
www/apps/api-reference/specs/admin/components/schemas/AdminCampaignResponse.yaml
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
3 changes: 0 additions & 3 deletions
3
www/apps/api-reference/specs/admin/components/schemas/AdminCancelFulfillment.yaml
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.