chore(docs): Generated API Reference (automated) (#12943)
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
This commit is contained in:
1 parent
e153ef491d
commit
3028425a86
7 files changed
+50
-107
No files matched your search
@@ -33,8 +33,18 @@ properties:
|
|||||||
- gte
|
- gte
|
||||||
- nin
|
- nin
|
||||||
value:
|
value:
|
||||||
type: string
|
oneOf:
|
||||||
title: value
|
- type: string
|
||||||
|
title: value
|
||||||
|
description: The shipping option rule's value.
|
||||||
|
example: 'true'
|
||||||
|
- type: array
|
||||||
|
description: The shipping option rule's values.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: value
|
||||||
|
description: A value of the shipping option rule.
|
||||||
|
example: 'true'
|
||||||
shipping_option_id:
|
shipping_option_id:
|
||||||
type: string
|
type: string
|
||||||
title: shipping_option_id
|
title: shipping_option_id
|
||||||
|
|||||||
@@ -1,24 +0,0 @@
|
|||||||
type: object
|
|
||||||
description: The gift card invitation's details.
|
|
||||||
x-schemaName: StoreGiftCardInvitation
|
|
||||||
required:
|
|
||||||
- id
|
|
||||||
- email
|
|
||||||
- status
|
|
||||||
- gift_card
|
|
||||||
properties:
|
|
||||||
id:
|
|
||||||
type: string
|
|
||||||
title: id
|
|
||||||
description: The gift card invitation's ID.
|
|
||||||
email:
|
|
||||||
type: string
|
|
||||||
title: email
|
|
||||||
description: The gift card invitation's email.
|
|
||||||
format: email
|
|
||||||
status:
|
|
||||||
type: string
|
|
||||||
title: status
|
|
||||||
description: The gift card invitation's status.
|
|
||||||
gift_card:
|
|
||||||
$ref: ./StoreGiftCard.yaml
|
|
||||||
@@ -65983,8 +65983,18 @@ components:
|
|||||||
- gte
|
- gte
|
||||||
- nin
|
- nin
|
||||||
value:
|
value:
|
||||||
type: string
|
oneOf:
|
||||||
title: value
|
- type: string
|
||||||
|
title: value
|
||||||
|
description: The shipping option rule's value.
|
||||||
|
example: 'true'
|
||||||
|
- type: array
|
||||||
|
description: The shipping option rule's values.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: value
|
||||||
|
description: A value of the shipping option rule.
|
||||||
|
example: 'true'
|
||||||
shipping_option_id:
|
shipping_option_id:
|
||||||
type: string
|
type: string
|
||||||
title: shipping_option_id
|
title: shipping_option_id
|
||||||
@@ -75865,31 +75875,6 @@ components:
|
|||||||
format: date-time
|
format: date-time
|
||||||
title: updated_at
|
title: updated_at
|
||||||
description: The date the gift card was updated.
|
description: The date the gift card was updated.
|
||||||
StoreGiftCardInvitation:
|
|
||||||
type: object
|
|
||||||
description: The gift card invitation's details.
|
|
||||||
x-schemaName: StoreGiftCardInvitation
|
|
||||||
required:
|
|
||||||
- id
|
|
||||||
- email
|
|
||||||
- status
|
|
||||||
- gift_card
|
|
||||||
properties:
|
|
||||||
id:
|
|
||||||
type: string
|
|
||||||
title: id
|
|
||||||
description: The gift card invitation's ID.
|
|
||||||
email:
|
|
||||||
type: string
|
|
||||||
title: email
|
|
||||||
description: The gift card invitation's email.
|
|
||||||
format: email
|
|
||||||
status:
|
|
||||||
type: string
|
|
||||||
title: status
|
|
||||||
description: The gift card invitation's status.
|
|
||||||
gift_card:
|
|
||||||
$ref: '#/components/schemas/StoreGiftCard'
|
|
||||||
StoreGiftCardResponse:
|
StoreGiftCardResponse:
|
||||||
type: object
|
type: object
|
||||||
description: The gift card's details.
|
description: The gift card's details.
|
||||||
|
|||||||
@@ -33,8 +33,18 @@ properties:
|
|||||||
- gte
|
- gte
|
||||||
- nin
|
- nin
|
||||||
value:
|
value:
|
||||||
type: string
|
oneOf:
|
||||||
title: value
|
- type: string
|
||||||
|
title: value
|
||||||
|
description: The shipping option rule's value.
|
||||||
|
example: 'true'
|
||||||
|
- type: array
|
||||||
|
description: The shipping option rule's values.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: value
|
||||||
|
description: A value of the shipping option rule.
|
||||||
|
example: 'true'
|
||||||
shipping_option_id:
|
shipping_option_id:
|
||||||
type: string
|
type: string
|
||||||
title: shipping_option_id
|
title: shipping_option_id
|
||||||
|
|||||||
@@ -1,24 +0,0 @@
|
|||||||
type: object
|
|
||||||
description: The gift card invitation's details.
|
|
||||||
x-schemaName: StoreGiftCardInvitation
|
|
||||||
required:
|
|
||||||
- id
|
|
||||||
- email
|
|
||||||
- status
|
|
||||||
- gift_card
|
|
||||||
properties:
|
|
||||||
id:
|
|
||||||
type: string
|
|
||||||
title: id
|
|
||||||
description: The gift card invitation's ID.
|
|
||||||
email:
|
|
||||||
type: string
|
|
||||||
title: email
|
|
||||||
description: The gift card invitation's email.
|
|
||||||
format: email
|
|
||||||
status:
|
|
||||||
type: string
|
|
||||||
title: status
|
|
||||||
description: The gift card invitation's status.
|
|
||||||
gift_card:
|
|
||||||
$ref: ./StoreGiftCard.yaml
|
|
||||||
@@ -20810,8 +20810,18 @@ components:
|
|||||||
- gte
|
- gte
|
||||||
- nin
|
- nin
|
||||||
value:
|
value:
|
||||||
type: string
|
oneOf:
|
||||||
title: value
|
- type: string
|
||||||
|
title: value
|
||||||
|
description: The shipping option rule's value.
|
||||||
|
example: 'true'
|
||||||
|
- type: array
|
||||||
|
description: The shipping option rule's values.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: value
|
||||||
|
description: A value of the shipping option rule.
|
||||||
|
example: 'true'
|
||||||
shipping_option_id:
|
shipping_option_id:
|
||||||
type: string
|
type: string
|
||||||
title: shipping_option_id
|
title: shipping_option_id
|
||||||
@@ -30692,31 +30702,6 @@ components:
|
|||||||
format: date-time
|
format: date-time
|
||||||
title: updated_at
|
title: updated_at
|
||||||
description: The date the gift card was updated.
|
description: The date the gift card was updated.
|
||||||
StoreGiftCardInvitation:
|
|
||||||
type: object
|
|
||||||
description: The gift card invitation's details.
|
|
||||||
x-schemaName: StoreGiftCardInvitation
|
|
||||||
required:
|
|
||||||
- id
|
|
||||||
- email
|
|
||||||
- status
|
|
||||||
- gift_card
|
|
||||||
properties:
|
|
||||||
id:
|
|
||||||
type: string
|
|
||||||
title: id
|
|
||||||
description: The gift card invitation's ID.
|
|
||||||
email:
|
|
||||||
type: string
|
|
||||||
title: email
|
|
||||||
description: The gift card invitation's email.
|
|
||||||
format: email
|
|
||||||
status:
|
|
||||||
type: string
|
|
||||||
title: status
|
|
||||||
description: The gift card invitation's status.
|
|
||||||
gift_card:
|
|
||||||
$ref: '#/components/schemas/StoreGiftCard'
|
|
||||||
StoreGiftCardResponse:
|
StoreGiftCardResponse:
|
||||||
type: object
|
type: object
|
||||||
description: The gift card's details.
|
description: The gift card's details.
|
||||||
|
|||||||
+2
-1
@@ -2,7 +2,8 @@
|
|||||||
* @oas [post] /admin/uploads/presigned-urls
|
* @oas [post] /admin/uploads/presigned-urls
|
||||||
* operationId: PostUploadsPresignedUrls
|
* operationId: PostUploadsPresignedUrls
|
||||||
* summary: Get Presigned Upload URL
|
* summary: Get Presigned Upload URL
|
||||||
* description: Get a presigned URL for uploading a file to the configured File Module Provider. The presigned URL can be used to upload files directly to the third-party provider. This only works if your configured provider supports presigned URLs, such as the S3 provider.
|
* description: Get a presigned URL for uploading a file to the configured File Module Provider. The presigned URL can be used to upload files directly to the third-party provider. This only works if
|
||||||
|
* your configured provider supports presigned URLs, such as the S3 provider.
|
||||||
* x-authenticated: true
|
* x-authenticated: true
|
||||||
* security:
|
* security:
|
||||||
* - api_token: []
|
* - api_token: []
|
||||||
|
|||||||
Reference in new issue
Block a user