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>
This commit is contained in:
YuzuRyo61 2021-03-06 22:34:11 +09:00 committed by GitHub
parent 3003100443
commit a07d753da8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
100 changed files with 3050 additions and 109 deletions

View file

@ -46,33 +46,35 @@ export const packedAppSchema = {
properties: {
id: {
type: 'string' as const,
optional: false as const, nullable: false as const,
format: 'id',
description: 'The unique identifier for this Note.',
example: 'xxxxxxxxxx',
optional: false as const, nullable: false as const
},
name: {
type: 'string' as const,
optional: false as const, nullable: false as const,
description: 'アプリケーションの名前'
optional: false as const, nullable: false as const
},
callbackUrl: {
createdAt: {
type: 'string' as const,
optional: false as const, nullable: true as const,
description: 'コールバックするURL'
optional: false as const, nullable: false as const
},
lastUsedAt: {
type: 'string' as const,
optional: false as const, nullable: false as const
},
permission: {
type: 'array' as const,
optional: true as const, nullable: false as const,
optional: false as const, nullable: false as const,
items: {
type: 'string' as const,
optional: false as const, nullable: false as const,
optional: false as const, nullable: false as const
}
},
secret: {
type: 'string' as const,
optional: true as const, nullable: false as const,
description: 'アプリケーションのシークレットキー'
optional: true as const, nullable: false as const
},
isAuthorized: {
type: 'boolean' as const,
optional: true as const, nullable: false as const
}
},
}
};