summaryrefslogtreecommitdiff
path: root/src/server/api/openapi
diff options
context:
space:
mode:
authorsyuilo <syuilotan@yahoo.co.jp>2019-02-25 03:35:45 +0900
committersyuilo <syuilotan@yahoo.co.jp>2019-02-25 03:35:45 +0900
commit495aad6a2d5a9f3e95c1a1aa96dbd391d19b3511 (patch)
tree12d941cc2a5487e6f861ab67080d168f6b2d8fbd /src/server/api/openapi
parentImprove doc (diff)
downloadsharkey-495aad6a2d5a9f3e95c1a1aa96dbd391d19b3511.tar.gz
sharkey-495aad6a2d5a9f3e95c1a1aa96dbd391d19b3511.tar.bz2
sharkey-495aad6a2d5a9f3e95c1a1aa96dbd391d19b3511.zip
Improve doc
Diffstat (limited to 'src/server/api/openapi')
-rw-r--r--src/server/api/openapi/schemas.ts22
1 files changed, 22 insertions, 0 deletions
diff --git a/src/server/api/openapi/schemas.ts b/src/server/api/openapi/schemas.ts
index 4f63c7aefd..cca789bf7a 100644
--- a/src/server/api/openapi/schemas.ts
+++ b/src/server/api/openapi/schemas.ts
@@ -97,6 +97,28 @@ export const schemas = {
required: ['id', 'name', 'username', 'createdAt']
},
+ UserList: {
+ type: 'object',
+ properties: {
+ id: {
+ type: 'string',
+ format: 'id',
+ description: 'The unique identifier for this UserList.',
+ example: 'xxxxxxxxxxxxxxxxxxxxxxxx',
+ },
+ createdAt: {
+ type: 'string',
+ format: 'date-time',
+ description: 'The date that the UserList was created.'
+ },
+ title: {
+ type: 'string',
+ description: 'The name of the UserList.'
+ },
+ },
+ required: ['id', 'createdAt', 'title']
+ },
+
Note: {
type: 'object',
properties: {