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
@@ -4,13 +4,19 @@ description: >-
|
||||
allow users to describe additional information in relation to these.
|
||||
type: object
|
||||
required:
|
||||
- value
|
||||
- resource_type
|
||||
- author_id
|
||||
- created_at
|
||||
- deleted_at
|
||||
- id
|
||||
- metadata
|
||||
- resource_id
|
||||
- resource_type
|
||||
- updated_at
|
||||
- value
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The note's ID
|
||||
type: string
|
||||
example: note_01G8TM8ENBMC7R90XRR1G6H26Q
|
||||
resource_type:
|
||||
description: The type of resource that the Note refers to.
|
||||
@@ -25,26 +31,30 @@ properties:
|
||||
type: string
|
||||
example: This order must be fulfilled on Monday
|
||||
author_id:
|
||||
type: string
|
||||
description: The ID of the author (user)
|
||||
nullable: true
|
||||
type: string
|
||||
example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V
|
||||
author:
|
||||
description: Available if the relation `author` is expanded.
|
||||
nullable: true
|
||||
$ref: ./User.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