paricafe/src/server/api/endpoints/charts/users.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

41 lines
877 B
TypeScript

import $ from 'cafy';
import define from '../../define';
import usersChart from '../../../../services/chart/users';
export const meta = {
stability: 'stable',
desc: {
'ja-JP': 'ユーザーのチャートを取得します。'
},
tags: ['charts', 'users'],
params: {
span: {
validator: $.str.or(['day', 'hour']),
desc: {
'ja-JP': '集計のスパン (day または hour)'
}
},
limit: {
validator: $.optional.num.range(1, 500),
default: 30,
desc: {
'ja-JP': '最大数。例えば 30 を指定したとすると、スパンが"day"の場合は30日分のデータが、スパンが"hour"の場合は30時間分のデータが返ります。'
}
},
},
res: {
type: 'array',
items: {
type: 'object',
},
},
};
export default define(meta, async (ps) => {
return await usersChart.getChart(ps.span as any, ps.limit);
});