summaryrefslogtreecommitdiff
path: root/src/server/api
diff options
context:
space:
mode:
authorsyuilo <syuilotan@yahoo.co.jp>2019-02-26 14:21:28 +0900
committersyuilo <syuilotan@yahoo.co.jp>2019-02-26 14:21:28 +0900
commit077bdbfdef9dfd07c897757032bcd54d2b3ea069 (patch)
tree1560891a9e41b02619a6f4c729319db925edad2e /src/server/api
parenti18n整理 (diff)
downloadsharkey-077bdbfdef9dfd07c897757032bcd54d2b3ea069.tar.gz
sharkey-077bdbfdef9dfd07c897757032bcd54d2b3ea069.tar.bz2
sharkey-077bdbfdef9dfd07c897757032bcd54d2b3ea069.zip
Improve doc
Diffstat (limited to 'src/server/api')
-rw-r--r--src/server/api/endpoints/drive/folders.ts9
-rw-r--r--src/server/api/endpoints/drive/folders/find.ts9
-rw-r--r--src/server/api/endpoints/drive/folders/show.ts4
-rw-r--r--src/server/api/openapi/schemas.ts40
4 files changed, 60 insertions, 2 deletions
diff --git a/src/server/api/endpoints/drive/folders.ts b/src/server/api/endpoints/drive/folders.ts
index a0b972f71d..73c179f7be 100644
--- a/src/server/api/endpoints/drive/folders.ts
+++ b/src/server/api/endpoints/drive/folders.ts
@@ -36,7 +36,14 @@ export const meta = {
default: null as any,
transform: transform,
}
- }
+ },
+
+ res: {
+ type: 'array',
+ items: {
+ type: 'DriveFolder',
+ },
+ },
};
export default define(meta, async (ps, user) => {
diff --git a/src/server/api/endpoints/drive/folders/find.ts b/src/server/api/endpoints/drive/folders/find.ts
index 17769567ad..16b6c10633 100644
--- a/src/server/api/endpoints/drive/folders/find.ts
+++ b/src/server/api/endpoints/drive/folders/find.ts
@@ -23,7 +23,14 @@ export const meta = {
'ja-JP': 'フォルダID'
}
},
- }
+ },
+
+ res: {
+ type: 'array',
+ items: {
+ type: 'DriveFolder',
+ },
+ },
};
export default define(meta, async (ps, user) => {
diff --git a/src/server/api/endpoints/drive/folders/show.ts b/src/server/api/endpoints/drive/folders/show.ts
index 0337436221..bbfcbed51f 100644
--- a/src/server/api/endpoints/drive/folders/show.ts
+++ b/src/server/api/endpoints/drive/folders/show.ts
@@ -29,6 +29,10 @@ export const meta = {
}
},
+ res: {
+ type: 'DriveFolder',
+ },
+
errors: {
noSuchFolder: {
message: 'No such folder.',
diff --git a/src/server/api/openapi/schemas.ts b/src/server/api/openapi/schemas.ts
index 127a7939df..e4b917693a 100644
--- a/src/server/api/openapi/schemas.ts
+++ b/src/server/api/openapi/schemas.ts
@@ -278,6 +278,46 @@ export const schemas = {
required: ['id', 'createdAt', 'name', 'type', 'datasize', 'md5']
},
+ DriveFolder: {
+ type: 'object',
+ properties: {
+ id: {
+ type: 'string',
+ format: 'id',
+ description: 'The unique identifier for this Drive folder.',
+ example: 'xxxxxxxxxxxxxxxxxxxxxxxx',
+ },
+ createdAt: {
+ type: 'string',
+ format: 'date-time',
+ description: 'The date that the Drive folder was created.'
+ },
+ name: {
+ type: 'string',
+ description: 'The folder name.',
+ },
+ foldersCount: {
+ type: 'number',
+ description: 'The count of child folders.',
+ },
+ filesCount: {
+ type: 'number',
+ description: 'The count of child files.',
+ },
+ parentId: {
+ type: 'string',
+ format: 'id',
+ nullable: true,
+ description: 'The parent folder ID of this folder.',
+ example: 'xxxxxxxxxxxxxxxxxxxxxxxx',
+ },
+ parent: {
+ type: 'DriveFolder',
+ },
+ },
+ required: ['id', 'createdAt', 'name']
+ },
+
Muting: {
type: 'object',
properties: {