summaryrefslogtreecommitdiff
path: root/src/server/api/openapi
diff options
context:
space:
mode:
authorsyuilo <syuilotan@yahoo.co.jp>2019-02-24 19:42:26 +0900
committersyuilo <syuilotan@yahoo.co.jp>2019-02-24 19:42:26 +0900
commitb67f3438e95af5c9a1143fa9214ae697a1372223 (patch)
tree173ec9ae6e63c078aab618423c30d93ebb9eaba5 /src/server/api/openapi
parentImprove doc (diff)
downloadsharkey-b67f3438e95af5c9a1143fa9214ae697a1372223.tar.gz
sharkey-b67f3438e95af5c9a1143fa9214ae697a1372223.tar.bz2
sharkey-b67f3438e95af5c9a1143fa9214ae697a1372223.zip
Improve doc
Diffstat (limited to 'src/server/api/openapi')
-rw-r--r--src/server/api/openapi/schemas.ts46
1 files changed, 45 insertions, 1 deletions
diff --git a/src/server/api/openapi/schemas.ts b/src/server/api/openapi/schemas.ts
index a8d684923b..4f63c7aefd 100644
--- a/src/server/api/openapi/schemas.ts
+++ b/src/server/api/openapi/schemas.ts
@@ -221,5 +221,49 @@ export const schemas = {
},
},
required: ['id', 'createdAt', 'name', 'type', 'datasize', 'md5']
- }
+ },
+
+ Muting: {
+ type: 'object',
+ properties: {
+ id: {
+ type: 'string',
+ format: 'id',
+ description: 'The unique identifier for this mute.',
+ example: 'xxxxxxxxxxxxxxxxxxxxxxxx',
+ },
+ createdAt: {
+ type: 'string',
+ format: 'date-time',
+ description: 'The date that the mute was created.'
+ },
+ mutee: {
+ $ref: '#/components/schemas/User',
+ description: 'The mutee.'
+ },
+ },
+ required: ['id', 'createdAt', 'mutee']
+ },
+
+ Blocking: {
+ type: 'object',
+ properties: {
+ id: {
+ type: 'string',
+ format: 'id',
+ description: 'The unique identifier for this block.',
+ example: 'xxxxxxxxxxxxxxxxxxxxxxxx',
+ },
+ createdAt: {
+ type: 'string',
+ format: 'date-time',
+ description: 'The date that the block was created.'
+ },
+ blockee: {
+ $ref: '#/components/schemas/User',
+ description: 'The blockee.'
+ },
+ },
+ required: ['id', 'createdAt', 'blockee']
+ },
};