Improve API doc

Fix #4825
This commit is contained in:
syuilo
2019-05-01 04:44:46 +09:00
parent e6cdf1b995
commit 1903aaf351
3 changed files with 51 additions and 1 deletions

View File

@ -84,5 +84,51 @@ export const packedPageSchema = {
type: types.object,
optional: bool.false, nullable: bool.false,
properties: {
id: {
type: types.string,
optional: bool.false, nullable: bool.false,
format: 'id',
example: 'xxxxxxxxxx',
},
createdAt: {
type: types.string,
optional: bool.false, nullable: bool.false,
format: 'date-time',
},
updatedAt: {
type: types.string,
optional: bool.false, nullable: bool.false,
format: 'date-time',
},
title: {
type: types.string,
optional: bool.false, nullable: bool.false,
},
name: {
type: types.string,
optional: bool.false, nullable: bool.false,
},
summary: {
type: types.string,
optional: bool.false, nullable: bool.true,
},
content: {
type: types.array,
optional: bool.false, nullable: bool.false,
},
variables: {
type: types.array,
optional: bool.false, nullable: bool.false,
},
userId: {
type: types.string,
optional: bool.false, nullable: bool.false,
format: 'id',
},
user: {
type: types.object,
ref: 'User',
optional: bool.false, nullable: bool.false,
},
}
};