hippofish/src/server/api/endpoints/users/show.ts
syuilo 52774bbe64
Introduce OpenAPI specs (#4351)
* wip

* wip

* wip

* Update index.ts

* Update gen-openapi-spec.ts

* Update api.ja-JP.md

* Fix

* Improve doc

* Update gen-openapi-spec.ts

* Update redoc.html

* Improve doc

* Update gen-openapi-spec.ts

* Improve doc

* Update CHANGELOG.md
2019-02-23 11:20:58 +09:00

110 lines
2.4 KiB
TypeScript

import $ from 'cafy';
import ID, { transform, transformMany } from '../../../../misc/cafy-id';
import User, { pack, isRemoteUser } from '../../../../models/user';
import resolveRemoteUser from '../../../../remote/resolve-user';
import define from '../../define';
import { apiLogger } from '../../logger';
import { ApiError } from '../../error';
const cursorOption = { fields: { data: false } };
export const meta = {
desc: {
'ja-JP': '指定したユーザーの情報を取得します。'
},
tags: ['users'],
requireCredential: false,
params: {
userId: {
validator: $.optional.type(ID),
transform: transform,
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
},
userIds: {
validator: $.optional.arr($.type(ID)).unique(),
transform: transformMany,
desc: {
'ja-JP': 'ユーザーID (配列)'
}
},
username: {
validator: $.optional.str
},
host: {
validator: $.optional.nullable.str
}
},
res: {
type: 'User',
},
errors: {
failedToResolveRemoteUser: {
message: 'Failed to resolve remote user.',
code: 'FAILED_TO_RESOLVE_REMOTE_USER',
id: 'ef7b9be4-9cba-4e6f-ab41-90ed171c7d3c',
kind: 'server' as 'server'
},
noSuchUser: {
message: 'No such user.',
code: 'NO_SUCH_USER',
id: '4362f8dc-731f-4ad8-a694-be5a88922a24'
},
}
};
export default define(meta, async (ps, me) => {
let user;
if (ps.userIds) {
const users = await User.find({
_id: {
$in: ps.userIds
}
});
return await Promise.all(users.map(u => pack(u, me, {
detail: true
})));
} else {
// Lookup user
if (typeof ps.host === 'string') {
user = await resolveRemoteUser(ps.username, ps.host, cursorOption).catch(e => {
apiLogger.warn(`failed to resolve remote user: ${e}`);
throw new ApiError(meta.errors.failedToResolveRemoteUser);
});
} else {
const q: any = ps.userId != null
? { _id: ps.userId }
: { usernameLower: ps.username.toLowerCase(), host: null };
user = await User.findOne(q, cursorOption);
}
if (user === null) {
throw new ApiError(meta.errors.noSuchUser);
}
// ユーザー情報更新
if (isRemoteUser(user)) {
if (user.lastFetchedAt == null || Date.now() - user.lastFetchedAt.getTime() > 1000 * 60 * 60 * 24) {
resolveRemoteUser(ps.username, ps.host, { }, true);
}
}
return await pack(user, me, {
detail: true
});
}
});