summaryrefslogtreecommitdiff
path: root/src/server/api/endpoints/users/relation.ts
diff options
context:
space:
mode:
authorYuzuRyo61 <yuzuryo61@yuzulia.work>2021-03-06 22:34:11 +0900
committerGitHub <noreply@github.com>2021-03-06 22:34:11 +0900
commita07d753da84191bc8c185a7bcd6d73fab9529b5d (patch)
tree085bc62b1f979020796a73373c3050f4948ed2bd /src/server/api/endpoints/users/relation.ts
parentfeat: video play inline (using video tag) (#7242) (diff)
downloadsharkey-a07d753da84191bc8c185a7bcd6d73fab9529b5d.tar.gz
sharkey-a07d753da84191bc8c185a7bcd6d73fab9529b5d.tar.bz2
sharkey-a07d753da84191bc8c185a7bcd6d73fab9529b5d.zip
APIドキュメントの改善 (#6757)
* Update api document in admin/announcements * Update api document in announcements * Update api document in i/read-announcements * Update api document in username/available * Update api document & Fix typo in API 403 error * Update api document * Update api document * Update api document * Fix API permission definition * Update api document * Update api document * Update api document * Update api document * Update api document * Update api document * Update api document * Update api document * Fix bug in users (api) * Apply reviews #6757 * Apply reviews #6757 Co-authored-by: syuilo <Syuilotan@yahoo.co.jp>
Diffstat (limited to 'src/server/api/endpoints/users/relation.ts')
-rw-r--r--src/server/api/endpoints/users/relation.ts87
1 files changed, 87 insertions, 0 deletions
diff --git a/src/server/api/endpoints/users/relation.ts b/src/server/api/endpoints/users/relation.ts
index 086e9bd1ea..1beb925398 100644
--- a/src/server/api/endpoints/users/relation.ts
+++ b/src/server/api/endpoints/users/relation.ts
@@ -19,6 +19,93 @@ export const meta = {
'ja-JP': 'ユーザーID (配列でも可)'
}
}
+ },
+
+ res: {
+ oneOf: [
+ {
+ type: 'object' as const,
+ optional: false as const, nullable: false as const,
+ properties: {
+ id: {
+ type: 'string' as const,
+ optional: false as const, nullable: false as const,
+ format: 'id'
+ },
+ isFollowing: {
+ type: 'boolean' as const,
+ optional: false as const, nullable: false as const
+ },
+ hasPendingFollowRequestFromYou: {
+ type: 'boolean' as const,
+ optional: false as const, nullable: false as const
+ },
+ hasPendingFollowRequestToYou: {
+ type: 'boolean' as const,
+ optional: false as const, nullable: false as const
+ },
+ isFollowed: {
+ type: 'boolean' as const,
+ optional: false as const, nullable: false as const
+ },
+ isBlocking: {
+ type: 'boolean' as const,
+ optional: false as const, nullable: false as const
+ },
+ isBlocked: {
+ type: 'boolean' as const,
+ optional: false as const, nullable: false as const
+ },
+ isMuted: {
+ type: 'boolean' as const,
+ optional: false as const, nullable: false as const
+ }
+ }
+ },
+ {
+ type: 'array' as const,
+ optional: false as const, nullable: false as const,
+ items: {
+ type: 'object' as const,
+ optional: false as const, nullable: false as const,
+ properties: {
+ id: {
+ type: 'string' as const,
+ optional: false as const, nullable: false as const,
+ format: 'id'
+ },
+ isFollowing: {
+ type: 'boolean' as const,
+ optional: false as const, nullable: false as const
+ },
+ hasPendingFollowRequestFromYou: {
+ type: 'boolean' as const,
+ optional: false as const, nullable: false as const
+ },
+ hasPendingFollowRequestToYou: {
+ type: 'boolean' as const,
+ optional: false as const, nullable: false as const
+ },
+ isFollowed: {
+ type: 'boolean' as const,
+ optional: false as const, nullable: false as const
+ },
+ isBlocking: {
+ type: 'boolean' as const,
+ optional: false as const, nullable: false as const
+ },
+ isBlocked: {
+ type: 'boolean' as const,
+ optional: false as const, nullable: false as const
+ },
+ isMuted: {
+ type: 'boolean' as const,
+ optional: false as const, nullable: false as const
+ }
+ }
+ }
+ }
+ ]
}
};