chore(docs): Generated API Reference (#4706)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
github-actions[bot]
2023-08-07 16:54:48 +03:00
committed by GitHub
parent efdea04963
commit 658339767b
1138 changed files with 11740 additions and 7043 deletions

View File

@@ -1,7 +1,8 @@
title: Note
description: >-
Notes are elements which we can use in association with different resources to
allow users to describe additional information in relation to these.
A Note is an element that can be used in association with different resources
to allow admin users to describe additional information. For example, they can
be used to add additional information about orders.
type: object
required:
- author_id
@@ -31,12 +32,13 @@ properties:
type: string
example: This order must be fulfilled on Monday
author_id:
description: The ID of the author (user)
description: The ID of the user that created the note.
nullable: true
type: string
example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V
author:
description: Available if the relation `author` is expanded.
description: The details of the user that created the note.
x-expandable: author
nullable: true
$ref: ./User.yaml
created_at: