summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorsyuilo <syuilotan@yahoo.co.jp>2018-08-11 00:49:29 +0900
committersyuilo <syuilotan@yahoo.co.jp>2018-08-11 00:49:29 +0900
commitfa469725c781f6c699ead5d271dffd1bb30bf64e (patch)
tree80821e2c91c52e9ea43b63c67b30bfe2f57c5477 /src
parentfix(package): update file-type to version 9.0.0 (diff)
downloadsharkey-fa469725c781f6c699ead5d271dffd1bb30bf64e.tar.gz
sharkey-fa469725c781f6c699ead5d271dffd1bb30bf64e.tar.bz2
sharkey-fa469725c781f6c699ead5d271dffd1bb30bf64e.zip
Add doc
Diffstat (limited to 'src')
-rw-r--r--src/docs/api/entities/drive-folder.yaml41
1 files changed, 41 insertions, 0 deletions
diff --git a/src/docs/api/entities/drive-folder.yaml b/src/docs/api/entities/drive-folder.yaml
new file mode 100644
index 0000000000..0fb8308dd4
--- /dev/null
+++ b/src/docs/api/entities/drive-folder.yaml
@@ -0,0 +1,41 @@
+name: "DriveFolder"
+
+desc:
+ ja: "ドライブのフォルダを表します。"
+ en: "A folder of Drive."
+
+props:
+ id:
+ type: "id"
+ optional: false
+ desc:
+ ja: "フォルダID"
+ en: "The ID of this folder"
+
+ createdAt:
+ type: "date"
+ optional: false
+ desc:
+ ja: "作成日時"
+ en: "The created date of this folder"
+
+ userId:
+ type: "id(User)"
+ optional: false
+ desc:
+ ja: "所有者ID"
+ en: "The ID of the owner of this folder"
+
+ parentId:
+ type: "entity(DriveFolder)"
+ optional: false
+ desc:
+ ja: "親フォルダのID (ルートなら null)"
+ en: "The ID of parent folder"
+
+ name:
+ type: "string"
+ optional: false
+ desc:
+ ja: "フォルダ名"
+ en: "The name of this folder"