chore(docs): Generated API Reference (#3262)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
67f9429293
commit
4fb22e8ba5
@@ -2,11 +2,17 @@ title: Product Collection
|
||||
description: Product Collections represents a group of Products that are related.
|
||||
type: object
|
||||
required:
|
||||
- created_at
|
||||
- deleted_at
|
||||
- handle
|
||||
- id
|
||||
- metadata
|
||||
- title
|
||||
- updated_at
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The product collection's ID
|
||||
type: string
|
||||
example: pcol_01F0YESBFAZ0DV6V831JXWH0BG
|
||||
title:
|
||||
description: The title that the Product Collection is identified by.
|
||||
@@ -16,6 +22,7 @@ properties:
|
||||
description: >-
|
||||
A unique string that identifies the Product Collection - can for example
|
||||
be used in slug structures.
|
||||
nullable: true
|
||||
type: string
|
||||
example: summer-collection
|
||||
products:
|
||||
@@ -24,22 +31,23 @@ properties:
|
||||
relation `products` is expanded.
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
description: A product collection object.
|
||||
$ref: ./Product.yaml
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was updated.
|
||||
type: string
|
||||
format: date-time
|
||||
deleted_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was deleted.
|
||||
nullable: true
|
||||
type: string
|
||||
format: date-time
|
||||
metadata:
|
||||
type: object
|
||||
description: An optional key-value map with additional details
|
||||
nullable: true
|
||||
type: object
|
||||
example:
|
||||
car: white
|
||||
|
||||
Reference in New Issue
Block a user