summaryrefslogtreecommitdiff
path: root/src/models
diff options
context:
space:
mode:
authorsyuilo <Syuilotan@yahoo.co.jp>2021-06-08 14:24:21 +0900
committersyuilo <Syuilotan@yahoo.co.jp>2021-06-08 14:24:21 +0900
commit55c549a9f83f25ac67fba888223faa9f98749b48 (patch)
tree09aba86b913d1ab4fd7049fe1e7961493e08c305 /src/models
parentrefactor type (diff)
downloadmisskey-55c549a9f83f25ac67fba888223faa9f98749b48.tar.gz
misskey-55c549a9f83f25ac67fba888223faa9f98749b48.tar.bz2
misskey-55c549a9f83f25ac67fba888223faa9f98749b48.zip
Remove entity descriptions
#6627
Diffstat (limited to 'src/models')
-rw-r--r--src/models/repositories/blocking.ts3
-rw-r--r--src/models/repositories/channel.ts3
-rw-r--r--src/models/repositories/clip.ts5
-rw-r--r--src/models/repositories/drive-file.ts13
-rw-r--r--src/models/repositories/drive-folder.ts6
-rw-r--r--src/models/repositories/following.ts4
-rw-r--r--src/models/repositories/hashtag.ts7
-rw-r--r--src/models/repositories/messaging-message.ts2
-rw-r--r--src/models/repositories/muting.ts3
-rw-r--r--src/models/repositories/note-favorite.ts2
-rw-r--r--src/models/repositories/note-reaction.ts4
-rw-r--r--src/models/repositories/note.ts6
-rw-r--r--src/models/repositories/notification.ts3
-rw-r--r--src/models/repositories/user-group.ts3
-rw-r--r--src/models/repositories/user-list.ts3
-rw-r--r--src/models/repositories/user.ts12
16 files changed, 0 insertions, 79 deletions
diff --git a/src/models/repositories/blocking.ts b/src/models/repositories/blocking.ts
index 60b43fae3e..9a4f3f6c68 100644
--- a/src/models/repositories/blocking.ts
+++ b/src/models/repositories/blocking.ts
@@ -41,14 +41,12 @@ export const packedBlockingSchema = {
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'id',
- description: 'The unique identifier for this blocking.',
example: 'xxxxxxxxxx',
},
createdAt: {
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'date-time',
- description: 'The date that the blocking was created.'
},
blockeeId: {
type: 'string' as const,
@@ -59,7 +57,6 @@ export const packedBlockingSchema = {
type: 'object' as const,
optional: false as const, nullable: false as const,
ref: 'User',
- description: 'The blockee.'
},
}
};
diff --git a/src/models/repositories/channel.ts b/src/models/repositories/channel.ts
index a1c85f2bd7..3a6bd4c923 100644
--- a/src/models/repositories/channel.ts
+++ b/src/models/repositories/channel.ts
@@ -51,14 +51,12 @@ export const packedChannelSchema = {
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'id',
- description: 'The unique identifier for this Channel.',
example: 'xxxxxxxxxx',
},
createdAt: {
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'date-time',
- description: 'The date that the Channel was created.'
},
lastNotedAt: {
type: 'string' as const,
@@ -68,7 +66,6 @@ export const packedChannelSchema = {
name: {
type: 'string' as const,
optional: false as const, nullable: false as const,
- description: 'The name of the Channel.'
},
description: {
type: 'string' as const,
diff --git a/src/models/repositories/clip.ts b/src/models/repositories/clip.ts
index 8d1f63c44b..293807b125 100644
--- a/src/models/repositories/clip.ts
+++ b/src/models/repositories/clip.ts
@@ -39,14 +39,12 @@ export const packedClipSchema = {
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'id',
- description: 'The unique identifier for this Clip.',
example: 'xxxxxxxxxx',
},
createdAt: {
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'date-time',
- description: 'The date that the Clip was created.'
},
userId: {
type: 'string' as const,
@@ -61,17 +59,14 @@ export const packedClipSchema = {
name: {
type: 'string' as const,
optional: false as const, nullable: false as const,
- description: 'The name of the Clip.'
},
description: {
type: 'string' as const,
optional: false as const, nullable: true as const,
- description: 'The description of the Clip.'
},
isPublic: {
type: 'boolean' as const,
optional: false as const, nullable: false as const,
- description: 'Whether this Clip is public.',
},
},
};
diff --git a/src/models/repositories/drive-file.ts b/src/models/repositories/drive-file.ts
index 92bf12a4e0..675faca8e3 100644
--- a/src/models/repositories/drive-file.ts
+++ b/src/models/repositories/drive-file.ts
@@ -154,44 +154,37 @@ export const packedDriveFileSchema = {
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'id',
- description: 'The unique identifier for this Drive file.',
example: 'xxxxxxxxxx',
},
createdAt: {
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'date-time',
- description: 'The date that the Drive file was created on Misskey.'
},
name: {
type: 'string' as const,
optional: false as const, nullable: false as const,
- description: 'The file name with extension.',
example: 'lenna.jpg'
},
type: {
type: 'string' as const,
optional: false as const, nullable: false as const,
- description: 'The MIME type of this Drive file.',
example: 'image/jpeg'
},
md5: {
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'md5',
- description: 'The MD5 hash of this Drive file.',
example: '15eca7fba0480996e2245f5185bf39f2'
},
size: {
type: 'number' as const,
optional: false as const, nullable: false as const,
- description: 'The size of this Drive file. (bytes)',
example: 51469
},
isSensitive: {
type: 'boolean' as const,
optional: false as const, nullable: false as const,
- description: 'Whether this Drive file is sensitive.',
},
blurhash: {
type: 'string' as const,
@@ -222,13 +215,11 @@ export const packedDriveFileSchema = {
type: 'string' as const,
optional: false as const, nullable: true as const,
format: 'url',
- description: 'The URL of this Drive file.',
},
thumbnailUrl: {
type: 'string' as const,
optional: false as const, nullable: true as const,
format: 'url',
- description: 'The thumbnail URL of this Drive file.',
},
comment: {
type: 'string' as const,
@@ -238,26 +229,22 @@ export const packedDriveFileSchema = {
type: 'string' as const,
optional: false as const, nullable: true as const,
format: 'id',
- description: 'The parent folder ID of this Drive file.',
example: 'xxxxxxxxxx',
},
folder: {
type: 'object' as const,
optional: true as const, nullable: true as const,
- description: 'The parent folder of this Drive file.',
ref: 'DriveFolder'
},
userId: {
type: 'string' as const,
optional: false as const, nullable: true as const,
format: 'id',
- description: 'Owner ID of this Drive file.',
example: 'xxxxxxxxxx',
},
user: {
type: 'object' as const,
optional: true as const, nullable: true as const,
- description: 'Owner of this Drive file.',
ref: 'User'
}
},
diff --git a/src/models/repositories/drive-folder.ts b/src/models/repositories/drive-folder.ts
index cc07c56675..d1922c96f8 100644
--- a/src/models/repositories/drive-folder.ts
+++ b/src/models/repositories/drive-folder.ts
@@ -59,35 +59,29 @@ export const packedDriveFolderSchema = {
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'id',
- description: 'The unique identifier for this Drive folder.',
example: 'xxxxxxxxxx',
},
createdAt: {
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'date-time',
- description: 'The date that the Drive folder was created.'
},
name: {
type: 'string' as const,
optional: false as const, nullable: false as const,
- description: 'The folder name.',
},
foldersCount: {
type: 'number' as const,
optional: true as const, nullable: false as const,
- description: 'The count of child folders.',
},
filesCount: {
type: 'number' as const,
optional: true as const, nullable: false as const,
- description: 'The count of child files.',
},
parentId: {
type: 'string' as const,
optional: false as const, nullable: true as const,
format: 'id',
- description: 'The parent folder ID of this folder.',
example: 'xxxxxxxxxx',
},
parent: {
diff --git a/src/models/repositories/following.ts b/src/models/repositories/following.ts
index b886432978..3aed83f320 100644
--- a/src/models/repositories/following.ts
+++ b/src/models/repositories/following.ts
@@ -95,14 +95,12 @@ export const packedFollowingSchema = {
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'id',
- description: 'The unique identifier for this following.',
example: 'xxxxxxxxxx',
},
createdAt: {
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'date-time',
- description: 'The date that the following was created.'
},
followeeId: {
type: 'string' as const,
@@ -113,7 +111,6 @@ export const packedFollowingSchema = {
type: 'object' as const,
optional: true as const, nullable: false as const,
ref: 'User',
- description: 'The followee.'
},
followerId: {
type: 'string' as const,
@@ -124,7 +121,6 @@ export const packedFollowingSchema = {
type: 'object' as const,
optional: true as const, nullable: false as const,
ref: 'User',
- description: 'The follower.'
},
}
};
diff --git a/src/models/repositories/hashtag.ts b/src/models/repositories/hashtag.ts
index 0089ab50db..3fee2f771d 100644
--- a/src/models/repositories/hashtag.ts
+++ b/src/models/repositories/hashtag.ts
@@ -34,38 +34,31 @@ export const packedHashtagSchema = {
tag: {
type: 'string' as const,
optional: false as const, nullable: false as const,
- description: 'The hashtag name. No # prefixed.',
example: 'misskey',
},
mentionedUsersCount: {
type: 'number' as const,
optional: false as const, nullable: false as const,
- description: 'Number of all users using this hashtag.'
},
mentionedLocalUsersCount: {
type: 'number' as const,
optional: false as const, nullable: false as const,
- description: 'Number of local users using this hashtag.'
},
mentionedRemoteUsersCount: {
type: 'number' as const,
optional: false as const, nullable: false as const,
- description: 'Number of remote users using this hashtag.'
},
attachedUsersCount: {
type: 'number' as const,
optional: false as const, nullable: false as const,
- description: 'Number of all users who attached this hashtag to profile.'
},
attachedLocalUsersCount: {
type: 'number' as const,
optional: false as const, nullable: false as const,
- description: 'Number of local users who attached this hashtag to profile.'
},
attachedRemoteUsersCount: {
type: 'number' as const,
optional: false as const, nullable: false as const,
- description: 'Number of remote users who attached this hashtag to profile.'
},
}
};
diff --git a/src/models/repositories/messaging-message.ts b/src/models/repositories/messaging-message.ts
index 8d6d03a236..c77b14ca7f 100644
--- a/src/models/repositories/messaging-message.ts
+++ b/src/models/repositories/messaging-message.ts
@@ -53,14 +53,12 @@ export const packedMessagingMessageSchema = {
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'id',
- description: 'The unique identifier for this MessagingMessage.',
example: 'xxxxxxxxxx',
},
createdAt: {
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'date-time',
- description: 'The date that the MessagingMessage was created.'
},
userId: {
type: 'string' as const,
diff --git a/src/models/repositories/muting.ts b/src/models/repositories/muting.ts
index b5bbe8a0a3..32e681bf0b 100644
--- a/src/models/repositories/muting.ts
+++ b/src/models/repositories/muting.ts
@@ -41,14 +41,12 @@ export const packedMutingSchema = {
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'id',
- description: 'The unique identifier for this muting.',
example: 'xxxxxxxxxx',
},
createdAt: {
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'date-time',
- description: 'The date that the muting was created.'
},
muteeId: {
type: 'string' as const,
@@ -59,7 +57,6 @@ export const packedMutingSchema = {
type: 'object' as const,
optional: false as const, nullable: false as const,
ref: 'User',
- description: 'The mutee.'
},
}
};
diff --git a/src/models/repositories/note-favorite.ts b/src/models/repositories/note-favorite.ts
index 316ebdff35..e58b258fcb 100644
--- a/src/models/repositories/note-favorite.ts
+++ b/src/models/repositories/note-favorite.ts
@@ -35,14 +35,12 @@ export const packedNoteFavoriteSchema = {
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'id',
- description: 'The unique identifier for this favorite.',
example: 'xxxxxxxxxx',
},
createdAt: {
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'date-time',
- description: 'The date that the favorite was created.'
},
note: {
type: 'object' as const,
diff --git a/src/models/repositories/note-reaction.ts b/src/models/repositories/note-reaction.ts
index 4c56809603..5de9e1be65 100644
--- a/src/models/repositories/note-reaction.ts
+++ b/src/models/repositories/note-reaction.ts
@@ -32,25 +32,21 @@ export const packedNoteReactionSchema = {
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'id',
- description: 'The unique identifier for this reaction.',
example: 'xxxxxxxxxx',
},
createdAt: {
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'date-time',
- description: 'The date that the reaction was created.'
},
user: {
type: 'object' as const,
optional: false as const, nullable: false as const,
ref: 'User',
- description: 'User who performed this reaction.'
},
type: {
type: 'string' as const,
optional: false as const, nullable: false as const,
- description: 'The reaction type.'
},
},
};
diff --git a/src/models/repositories/note.ts b/src/models/repositories/note.ts
index 7b1df73024..df0ca8c6ad 100644
--- a/src/models/repositories/note.ts
+++ b/src/models/repositories/note.ts
@@ -281,14 +281,12 @@ export const packedNoteSchema = {
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'id',
- description: 'The unique identifier for this Note.',
example: 'xxxxxxxxxx',
},
createdAt: {
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'date-time',
- description: 'The date that the Note was created on Misskey.'
},
text: {
type: 'string' as const,
@@ -426,7 +424,6 @@ export const packedNoteSchema = {
reactions: {
type: 'object' as const,
optional: false as const, nullable: false as const,
- description: 'Key is either Unicode emoji or custom emoji, value is count of that emoji reaction.',
},
renoteCount: {
type: 'number' as const,
@@ -439,18 +436,15 @@ export const packedNoteSchema = {
uri: {
type: 'string' as const,
optional: false as const, nullable: true as const,
- description: 'The URI of a note. it will be null when the note is local.',
},
url: {
type: 'string' as const,
optional: false as const, nullable: true as const,
- description: 'The human readable url of a note. it will be null when the note is local.',
},
myReaction: {
type: 'object' as const,
optional: true as const, nullable: true as const,
- description: 'Key is either Unicode emoji or custom emoji, value is count of that emoji reaction.',
},
},
};
diff --git a/src/models/repositories/notification.ts b/src/models/repositories/notification.ts
index abadea4632..94a2c3c91a 100644
--- a/src/models/repositories/notification.ts
+++ b/src/models/repositories/notification.ts
@@ -117,20 +117,17 @@ export const packedNotificationSchema = {
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'id',
- description: 'The unique identifier for this notification.',
example: 'xxxxxxxxxx',
},
createdAt: {
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'date-time',
- description: 'The date that the notification was created.'
},
type: {
type: 'string' as const,
optional: false as const, nullable: false as const,
enum: ['follow', 'followRequestAccepted', 'receiveFollowRequest', 'mention', 'reply', 'renote', 'quote', 'reaction', 'pollVote'],
- description: 'The type of the notification.'
},
userId: {
type: 'string' as const,
diff --git a/src/models/repositories/user-group.ts b/src/models/repositories/user-group.ts
index 9861b23356..c7d73ebe26 100644
--- a/src/models/repositories/user-group.ts
+++ b/src/models/repositories/user-group.ts
@@ -34,19 +34,16 @@ export const packedUserGroupSchema = {
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'id',
- description: 'The unique identifier for this UserGroup.',
example: 'xxxxxxxxxx',
},
createdAt: {
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'date-time',
- description: 'The date that the UserGroup was created.'
},
name: {
type: 'string' as const,
optional: false as const, nullable: false as const,
- description: 'The name of the UserGroup.'
},
ownerId: {
type: 'string' as const,
diff --git a/src/models/repositories/user-list.ts b/src/models/repositories/user-list.ts
index 094abace63..7710bebfcc 100644
--- a/src/models/repositories/user-list.ts
+++ b/src/models/repositories/user-list.ts
@@ -33,19 +33,16 @@ export const packedUserListSchema = {
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'id',
- description: 'The unique identifier for this UserList.',
example: 'xxxxxxxxxx',
},
createdAt: {
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'date-time',
- description: 'The date that the UserList was created.'
},
name: {
type: 'string' as const,
optional: false as const, nullable: false as const,
- description: 'The name of the UserList.'
},
userIds: {
type: 'array' as const,
diff --git a/src/models/repositories/user.ts b/src/models/repositories/user.ts
index 1ebc16a563..90a91987fb 100644
--- a/src/models/repositories/user.ts
+++ b/src/models/repositories/user.ts
@@ -342,19 +342,16 @@ export const packedUserSchema = {
type: 'string' as const,
nullable: false as const, optional: false as const,
format: 'id',
- description: 'The unique identifier for this User.',
example: 'xxxxxxxxxx',
},
name: {
type: 'string' as const,
nullable: true as const, optional: false as const,
- description: 'The name of the user, as they’ve defined it.',
example: '藍'
},
username: {
type: 'string' as const,
nullable: false as const, optional: false as const,
- description: 'The screen name, handle, or alias that this user identifies themselves with.',
example: 'ai'
},
host: {
@@ -379,24 +376,20 @@ export const packedUserSchema = {
isAdmin: {
type: 'boolean' as const,
nullable: false as const, optional: false as const,
- description: 'Whether this account is the admin.',
default: false
},
isModerator: {
type: 'boolean' as const,
nullable: false as const, optional: false as const,
- description: 'Whether this account is a moderator.',
default: false
},
isBot: {
type: 'boolean' as const,
nullable: false as const, optional: true as const,
- description: 'Whether this account is a bot.'
},
isCat: {
type: 'boolean' as const,
nullable: false as const, optional: true as const,
- description: 'Whether this account is a cat.'
},
emojis: {
type: 'array' as const,
@@ -438,7 +431,6 @@ export const packedUserSchema = {
type: 'string' as const,
nullable: false as const, optional: true as const,
format: 'date-time',
- description: 'The date that the user account was created on Misskey.'
},
updatedAt: {
type: 'string' as const,
@@ -471,7 +463,6 @@ export const packedUserSchema = {
description: {
type: 'string' as const,
nullable: true as const, optional: true as const,
- description: 'The user-defined UTF-8 string describing their account.',
example: 'Hi masters, I am Ai!'
},
location: {
@@ -505,17 +496,14 @@ export const packedUserSchema = {
followersCount: {
type: 'number' as const,
nullable: false as const, optional: true as const,
- description: 'The number of followers this account currently has.'
},
followingCount: {
type: 'number' as const,
nullable: false as const, optional: true as const,
- description: 'The number of users this account is following.'
},
notesCount: {
type: 'number' as const,
nullable: false as const, optional: true as const,
- description: 'The number of Notes (including renotes) issued by the user.'
},
pinnedNoteIds: {
type: 'array' as const,