chore(docs): Updated API Reference (v2) (#9666)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
co-authored by
Oli Juhl
Shahed Nasser
parent
2ea766daf5
commit
8209d936a0
@@ -1,8 +1,52 @@
|
||||
/**
|
||||
* @schema BaseCollection
|
||||
* type: object
|
||||
* description: The collection's details.
|
||||
* description: The product collection's details.
|
||||
* x-schemaName: BaseCollection
|
||||
* required:
|
||||
* - id
|
||||
* - title
|
||||
* - handle
|
||||
* - created_at
|
||||
* - updated_at
|
||||
* - deleted_at
|
||||
* - metadata
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The collection's ID.
|
||||
* title:
|
||||
* type: string
|
||||
* title: title
|
||||
* description: The collection's title.
|
||||
* handle:
|
||||
* type: string
|
||||
* title: handle
|
||||
* description: The collection's handle.
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: created_at
|
||||
* description: The collection's creation date.
|
||||
* updated_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: updated_at
|
||||
* description: The collection's update date.
|
||||
* deleted_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* title: deleted_at
|
||||
* description: The collection's deletion date.
|
||||
* products:
|
||||
* type: array
|
||||
* description: The collection's products.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminProduct"
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The collection's metadata, used to store custom key-value pairs.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
Reference in New Issue
Block a user