chore(docs): Updated API Reference (v2) (#8073)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
This commit is contained in:
github-actions[bot]
2024-07-11 07:59:07 +00:00
committed by GitHub
parent f441663224
commit adfa1d8574
19 changed files with 245 additions and 71 deletions

View File

@@ -1,6 +1,14 @@
type: object
description: The parent's collection.
x-schemaName: AdminCollection
required:
- id
- title
- handle
- created_at
- updated_at
- deleted_at
- metadata
properties:
id:
type: string

View File

@@ -39,10 +39,9 @@ properties:
title: name
description: The default tax rate's name.
is_combinable:
type: string
enum:
- 'true'
- 'false'
type: boolean
title: is_combinable
description: The default tax rate's is combinable.
metadata:
type: object
description: The default tax rate's metadata.

View File

@@ -25,7 +25,6 @@ required:
- is_giftcard
- collection_id
- type_id
- tags
- images
- discountable
- external_id
@@ -49,6 +48,11 @@ properties:
$ref: ./AdminProductVariant.yaml
type:
type: object
tags:
type: array
description: The parent's tags.
items:
$ref: ./AdminProductTag.yaml
title:
type: string
title: title
@@ -147,11 +151,6 @@ properties:
type: string
title: type_id
description: The parent's type id.
tags:
type: array
description: The parent's tags.
items:
$ref: ./BaseProductTag.yaml
images:
type: array
description: The parent's images.

View File

@@ -0,0 +1,35 @@
type: object
description: The tag's tags.
x-schemaName: AdminProductTag
required:
- id
- value
- created_at
- updated_at
properties:
id:
type: string
title: id
description: The tag's ID.
value:
type: string
title: value
description: The tag's value.
created_at:
type: string
format: date-time
title: created_at
description: The tag's created at.
updated_at:
type: string
format: date-time
title: updated_at
description: The tag's updated at.
deleted_at:
type: string
format: date-time
title: deleted_at
description: The tag's deleted at.
metadata:
type: object
description: The tag's metadata.

View File

@@ -2,6 +2,7 @@ type: object
description: SUMMARY
x-schemaName: AdminUpdateTaxRate
required:
- code
- metadata
properties:
rate:

View File

@@ -20,7 +20,6 @@ required:
- material
- collection_id
- type_id
- tags
- variants
- options
- images

View File

@@ -25,7 +25,6 @@ required:
- is_giftcard
- collection_id
- type_id
- tags
- images
- discountable
- external_id