summaryrefslogtreecommitdiff
path: root/src/docs
diff options
context:
space:
mode:
authorsyuilo <syuilotan@yahoo.co.jp>2018-08-30 22:16:04 +0900
committersyuilo <syuilotan@yahoo.co.jp>2018-08-30 22:16:04 +0900
commitae36bf301af4c8dffd0543e9cd45f8d4a0dbd18b (patch)
treec9b10d65d71bdb97e2bbc263a2767f9f812ceb1e /src/docs
parentMerge pull request #2502 from acid-chicken/patch-autogen (diff)
parent8.16.0 (diff)
downloadsharkey-ae36bf301af4c8dffd0543e9cd45f8d4a0dbd18b.tar.gz
sharkey-ae36bf301af4c8dffd0543e9cd45f8d4a0dbd18b.tar.bz2
sharkey-ae36bf301af4c8dffd0543e9cd45f8d4a0dbd18b.zip
Merge branch 'develop'
Diffstat (limited to 'src/docs')
-rw-r--r--src/docs/about.en-US.md (renamed from src/docs/about.en.md)0
-rw-r--r--src/docs/about.ja-JP.md (renamed from src/docs/about.ja.md)0
-rw-r--r--src/docs/api.ja-JP.md (renamed from src/docs/api.ja.md)0
-rw-r--r--src/docs/api/endpoints/view.pug2
-rw-r--r--src/docs/api/entities/drive-file.yaml52
-rw-r--r--src/docs/api/entities/drive-folder.yaml24
-rw-r--r--src/docs/api/entities/note.yaml98
-rw-r--r--src/docs/api/entities/user.yaml96
-rw-r--r--src/docs/api/entities/view.pug2
-rw-r--r--src/docs/api/mixins.pug2
-rw-r--r--src/docs/base.pug2
-rw-r--r--src/docs/follow.ja-JP.md (renamed from src/docs/follow.ja.md)0
-rw-r--r--src/docs/mute.ja-JP.md (renamed from src/docs/mute.ja.md)0
-rw-r--r--src/docs/reversi-bot.ja-JP.md (renamed from src/docs/reversi-bot.ja.md)0
-rw-r--r--src/docs/stream.ja-JP.md (renamed from src/docs/stream.ja.md)0
-rw-r--r--src/docs/timelines.ja-JP.md (renamed from src/docs/timelines.ja.md)0
16 files changed, 139 insertions, 139 deletions
diff --git a/src/docs/about.en.md b/src/docs/about.en-US.md
index bb1c51927b..bb1c51927b 100644
--- a/src/docs/about.en.md
+++ b/src/docs/about.en-US.md
diff --git a/src/docs/about.ja.md b/src/docs/about.ja-JP.md
index 1b06361f0f..1b06361f0f 100644
--- a/src/docs/about.ja.md
+++ b/src/docs/about.ja-JP.md
diff --git a/src/docs/api.ja.md b/src/docs/api.ja-JP.md
index ecc80cc05e..ecc80cc05e 100644
--- a/src/docs/api.ja.md
+++ b/src/docs/api.ja-JP.md
diff --git a/src/docs/api/endpoints/view.pug b/src/docs/api/endpoints/view.pug
index 76e1183302..be7e84faa1 100644
--- a/src/docs/api/endpoints/view.pug
+++ b/src/docs/api/endpoints/view.pug
@@ -15,7 +15,7 @@ block main
span.path= endpointUrl.path
if endpoint.desc
- p#desc= endpoint.desc[lang] || endpoint.desc['ja']
+ p#desc= endpoint.desc[lang] || endpoint.desc['ja-JP']
if endpoint.requireCredential
div.ui.info: p
diff --git a/src/docs/api/entities/drive-file.yaml b/src/docs/api/entities/drive-file.yaml
index 62dbec363a..0c2195ac08 100644
--- a/src/docs/api/entities/drive-file.yaml
+++ b/src/docs/api/entities/drive-file.yaml
@@ -1,90 +1,90 @@
name: "DriveFile"
desc:
- ja: "ドライブのファイル。"
- en: "A file of Drive."
+ ja-JP: "ドライブのファイル。"
+ en-US: "A file of Drive."
props:
id:
type: "id"
optional: false
desc:
- ja: "ファイルID"
- en: "The ID of this file"
+ ja-JP: "ファイルID"
+ en-US: "The ID of this file"
createdAt:
type: "date"
optional: false
desc:
- ja: "アップロード日時"
- en: "The upload date of this file"
+ ja-JP: "アップロード日時"
+ en-US: "The upload date of this file"
userId:
type: "id(User)"
optional: false
desc:
- ja: "所有者ID"
- en: "The ID of the owner of this file"
+ ja-JP: "所有者ID"
+ en-US: "The ID of the owner of this file"
user:
type: "entity(User)"
optional: true
desc:
- ja: "所有者"
- en: "The owner of this file"
+ ja-JP: "所有者"
+ en-US: "The owner of this file"
name:
type: "string"
optional: false
desc:
- ja: "ファイル名"
- en: "The name of this file"
+ ja-JP: "ファイル名"
+ en-US: "The name of this file"
md5:
type: "string"
optional: false
desc:
- ja: "ファイルのMD5ハッシュ値"
- en: "The md5 hash value of this file"
+ ja-JP: "ファイルのMD5ハッシュ値"
+ en-US: "The md5 hash value of this file"
type:
type: "string"
optional: false
desc:
- ja: "ファイルの種類"
- en: "The type of this file"
+ ja-JP: "ファイルの種類"
+ en-US: "The type of this file"
datasize:
type: "number"
optional: false
desc:
- ja: "ファイルサイズ(bytes)"
- en: "The size of this file (bytes)"
+ ja-JP: "ファイルサイズ(bytes)"
+ en-US: "The size of this file (bytes)"
url:
type: "string"
optional: false
desc:
- ja: "ファイルのURL"
- en: "The URL of this file"
+ ja-JP: "ファイルのURL"
+ en-US: "The URL of this file"
folderId:
type: "id(DriveFolder)"
optional: true
desc:
- ja: "フォルダID"
- en: "The ID of the folder of this file"
+ ja-JP: "フォルダID"
+ en-US: "The ID of the folder of this file"
folder:
type: "entity(DriveFolder)"
optional: true
desc:
- ja: "フォルダ"
- en: "The folder of this file"
+ ja-JP: "フォルダ"
+ en-US: "The folder of this file"
isSensitive:
type: "boolean"
optional: true
desc:
- ja: "このメディアが「閲覧注意」(NSFW)かどうか"
- en: "Whether this media is NSFW"
+ ja-JP: "このメディアが「閲覧注意」(NSFW)かどうか"
+ en-US: "Whether this media is NSFW"
diff --git a/src/docs/api/entities/drive-folder.yaml b/src/docs/api/entities/drive-folder.yaml
index 0fb8308dd4..e3dfd2ca01 100644
--- a/src/docs/api/entities/drive-folder.yaml
+++ b/src/docs/api/entities/drive-folder.yaml
@@ -1,41 +1,41 @@
name: "DriveFolder"
desc:
- ja: "ドライブのフォルダを表します。"
- en: "A folder of Drive."
+ ja-JP: "ドライブのフォルダを表します。"
+ en-US: "A folder of Drive."
props:
id:
type: "id"
optional: false
desc:
- ja: "フォルダID"
- en: "The ID of this folder"
+ ja-JP: "フォルダID"
+ en-US: "The ID of this folder"
createdAt:
type: "date"
optional: false
desc:
- ja: "作成日時"
- en: "The created date of this folder"
+ ja-JP: "作成日時"
+ en-US: "The created date of this folder"
userId:
type: "id(User)"
optional: false
desc:
- ja: "所有者ID"
- en: "The ID of the owner of this folder"
+ ja-JP: "所有者ID"
+ en-US: "The ID of the owner of this folder"
parentId:
type: "entity(DriveFolder)"
optional: false
desc:
- ja: "親フォルダのID (ルートなら null)"
- en: "The ID of parent folder"
+ ja-JP: "親フォルダのID (ルートなら null)"
+ en-US: "The ID of parent folder"
name:
type: "string"
optional: false
desc:
- ja: "フォルダ名"
- en: "The name of this folder"
+ ja-JP: "フォルダ名"
+ en-US: "The name of this folder"
diff --git a/src/docs/api/entities/note.yaml b/src/docs/api/entities/note.yaml
index 04cb3c9824..cae9a53f82 100644
--- a/src/docs/api/entities/note.yaml
+++ b/src/docs/api/entities/note.yaml
@@ -1,190 +1,190 @@
name: "Note"
desc:
- ja: "投稿。"
- en: "A note."
+ ja-JP: "投稿。"
+ en-US: "A note."
props:
id:
type: "id"
optional: false
desc:
- ja: "投稿ID"
- en: "The ID of this note"
+ ja-JP: "投稿ID"
+ en-US: "The ID of this note"
createdAt:
type: "date"
optional: false
desc:
- ja: "投稿日時"
- en: "The posted date of this note"
+ ja-JP: "投稿日時"
+ en-US: "The posted date of this note"
viaMobile:
type: "boolean"
optional: true
desc:
- ja: "モバイル端末から投稿したか否か(自己申告であることに留意)"
- en: "Whether this note sent via a mobile device"
+ ja-JP: "モバイル端末から投稿したか否か(自己申告であることに留意)"
+ en-US: "Whether this note sent via a mobile device"
text:
type: "string"
optional: true
desc:
- ja: "投稿の本文"
- en: "The text of this note"
+ ja-JP: "投稿の本文"
+ en-US: "The text of this note"
mediaIds:
type: "id(DriveFile)[]"
optional: true
desc:
- ja: "添付されているメディアのID (なければレスポンスでは空配列)"
- en: "The IDs of the attached media (empty array for response if no media is attached)"
+ ja-JP: "添付されているメディアのID (なければレスポンスでは空配列)"
+ en-US: "The IDs of the attached media (empty array for response if no media is attached)"
media:
type: "entity(DriveFile)[]"
optional: true
desc:
- ja: "添付されているメディア"
- en: "The attached media"
+ ja-JP: "添付されているメディア"
+ en-US: "The attached media"
userId:
type: "id(User)"
optional: false
desc:
- ja: "投稿者ID"
- en: "The ID of author of this note"
+ ja-JP: "投稿者ID"
+ en-US: "The ID of author of this note"
user:
type: "entity(User)"
optional: true
desc:
- ja: "投稿者"
- en: "The author of this note"
+ ja-JP: "投稿者"
+ en-US: "The author of this note"
myReaction:
type: "string"
optional: true
desc:
- ja: "この投稿に対する自分の<a href='/docs/api/reactions'>リアクション</a>"
- en: "The your <a href='/docs/api/reactions'>reaction</a> of this note"
+ ja-JP: "この投稿に対する自分の<a href='/docs/api/reactions'>リアクション</a>"
+ en-US: "The your <a href='/docs/api/reactions'>reaction</a> of this note"
reactionCounts:
type: "object"
optional: false
desc:
- ja: "<a href='/docs/api/reactions'>リアクション</a>をキーとし、この投稿に対するそのリアクションの数を値としたオブジェクト"
+ ja-JP: "<a href='/docs/api/reactions'>リアクション</a>をキーとし、この投稿に対するそのリアクションの数を値としたオブジェクト"
replyId:
type: "id(Note)"
optional: true
desc:
- ja: "返信した投稿のID"
- en: "The ID of the replyed note"
+ ja-JP: "返信した投稿のID"
+ en-US: "The ID of the replyed note"
reply:
type: "entity(Note)"
optional: true
desc:
- ja: "返信した投稿"
- en: "The replyed note"
+ ja-JP: "返信した投稿"
+ en-US: "The replyed note"
renoteId:
type: "id(Note)"
optional: true
desc:
- ja: "引用した投稿のID"
- en: "The ID of the quoted note"
+ ja-JP: "引用した投稿のID"
+ en-US: "The ID of the quoted note"
renote:
type: "entity(Note)"
optional: true
desc:
- ja: "引用した投稿"
- en: "The quoted note"
+ ja-JP: "引用した投稿"
+ en-US: "The quoted note"
poll:
type: "object"
optional: true
desc:
- ja: "投票"
- en: "The poll"
+ ja-JP: "投票"
+ en-US: "The poll"
props:
choices:
type: "object[]"
optional: false
desc:
- ja: "投票の選択肢"
- en: "The choices of this poll"
+ ja-JP: "投票の選択肢"
+ en-US: "The choices of this poll"
props:
id:
type: "number"
optional: false
desc:
- ja: "選択肢ID"
- en: "The ID of this choice"
+ ja-JP: "選択肢ID"
+ en-US: "The ID of this choice"
isVoted:
type: "boolean"
optional: true
desc:
- ja: "自分がこの選択肢に投票したかどうか"
- en: "Whether you voted to this choice"
+ ja-JP: "自分がこの選択肢に投票したかどうか"
+ en-US: "Whether you voted to this choice"
text:
type: "string"
optional: false
desc:
- ja: "選択肢本文"
- en: "The text of this choice"
+ ja-JP: "選択肢本文"
+ en-US: "The text of this choice"
votes:
type: "number"
optional: false
desc:
- ja: "この選択肢に投票された数"
- en: "The number voted for this choice"
+ ja-JP: "この選択肢に投票された数"
+ en-US: "The number voted for this choice"
geo:
type: "object"
optional: true
desc:
- ja: "位置情報"
- en: "Geo location"
+ ja-JP: "位置情報"
+ en-US: "Geo location"
props:
coordinates:
type: "number[]"
optional: false
desc:
- ja: "座標。最初に経度:-180〜180で表す。最後に緯度:-90〜90で表す。"
+ ja-JP: "座標。最初に経度:-180〜180で表す。最後に緯度:-90〜90で表す。"
altitude:
type: "number"
optional: false
desc:
- ja: "高度。メートル単位で表す。"
+ ja-JP: "高度。メートル単位で表す。"
accuracy:
type: "number"
optional: false
desc:
- ja: "緯度、経度の精度。メートル単位で表す。"
+ ja-JP: "緯度、経度の精度。メートル単位で表す。"
altitudeAccuracy:
type: "number"
optional: false
desc:
- ja: "高度の精度。メートル単位で表す。"
+ ja-JP: "高度の精度。メートル単位で表す。"
heading:
type: "number"
optional: false
desc:
- ja: "方角。0〜360の角度で表す。0が北、90が東、180が南、270が西。"
+ ja-JP: "方角。0〜360の角度で表す。0が北、90が東、180が南、270が西。"
speed:
type: "number"
optional: false
desc:
- ja: "速度。メートル / 秒数で表す。"
+ ja-JP: "速度。メートル / 秒数で表す。"
diff --git a/src/docs/api/entities/user.yaml b/src/docs/api/entities/user.yaml
index c245974568..c90b55ee88 100644
--- a/src/docs/api/entities/user.yaml
+++ b/src/docs/api/entities/user.yaml
@@ -1,174 +1,174 @@
name: "User"
desc:
- ja: "ユーザー。"
- en: "A user."
+ ja-JP: "ユーザー。"
+ en-US: "A user."
props:
id:
type: "id"
optional: false
desc:
- ja: "ユーザーID"
- en: "The ID of this user"
+ ja-JP: "ユーザーID"
+ en-US: "The ID of this user"
createdAt:
type: "date"
optional: false
desc:
- ja: "アカウント作成日時"
- en: "The registered date of this user"
+ ja-JP: "アカウント作成日時"
+ en-US: "The registered date of this user"
username:
type: "string"
optional: false
desc:
- ja: "ユーザー名"
- en: "The username of this user"
+ ja-JP: "ユーザー名"
+ en-US: "The username of this user"
description:
type: "string"
optional: false
desc:
- ja: "アカウントの説明(自己紹介)"
- en: "The description of this user"
+ ja-JP: "アカウントの説明(自己紹介)"
+ en-US: "The description of this user"
avatarId:
type: "id(DriveFile)"
optional: true
desc:
- ja: "アバターのID"
- en: "The ID of the avatar of this user"
+ ja-JP: "アバターのID"
+ en-US: "The ID of the avatar of this user"
avatarUrl:
type: "string"
optional: false
desc:
- ja: "アバターのURL"
- en: "The URL of the avatar of this user"
+ ja-JP: "アバターのURL"
+ en-US: "The URL of the avatar of this user"
bannerId:
type: "id(DriveFile)"
optional: true
desc:
- ja: "バナーのID"
- en: "The ID of the banner of this user"
+ ja-JP: "バナーのID"
+ en-US: "The ID of the banner of this user"
bannerUrl:
type: "string"
optional: false
desc:
- ja: "バナーのURL"
- en: "The URL of the banner of this user"
+ ja-JP: "バナーのURL"
+ en-US: "The URL of the banner of this user"
followersCount:
type: "number"
optional: false
desc:
- ja: "フォロワーの数"
- en: "The number of the followers for this user"
+ ja-JP: "フォロワーの数"
+ en-US: "The number of the followers for this user"
followingCount:
type: "number"
optional: false
desc:
- ja: "フォローしているユーザーの数"
- en: "The number of the following users for this user"
+ ja-JP: "フォローしているユーザーの数"
+ en-US: "The number of the following users for this user"
isFollowing:
type: "boolean"
optional: true
desc:
- ja: "自分がこのユーザーをフォローしているか"
+ ja-JP: "自分がこのユーザーをフォローしているか"
isFollowed:
type: "boolean"
optional: true
desc:
- ja: "自分がこのユーザーにフォローされているか"
+ ja-JP: "自分がこのユーザーにフォローされているか"
isMuted:
type: "boolean"
optional: true
desc:
- ja: "自分がこのユーザーをミュートしているか"
- en: "Whether you muted this user"
+ ja-JP: "自分がこのユーザーをミュートしているか"
+ en-US: "Whether you muted this user"
notesCount:
type: "number"
optional: false
desc:
- ja: "投稿の数"
- en: "The number of the notes of this user"
+ ja-JP: "投稿の数"
+ en-US: "The number of the notes of this user"
pinnedNote:
type: "entity(Note)"
optional: true
desc:
- ja: "ピン留めされた投稿"
- en: "The pinned note of this user"
+ ja-JP: "ピン留めされた投稿"
+ en-US: "The pinned note of this user"
pinnedNoteId:
type: "id(Note)"
optional: true
desc:
- ja: "ピン留めされた投稿のID"
- en: "The ID of the pinned note of this user"
+ ja-JP: "ピン留めされた投稿のID"
+ en-US: "The ID of the pinned note of this user"
host:
type: "string | null"
optional: false
desc:
- ja: "ホスト (例: example.com:3000)"
- en: "Host (e.g. example.com:3000)"
+ ja-JP: "ホスト (例: example.com:3000)"
+ en-US: "Host (e.g. example.com:3000)"
twitter:
type: "object"
optional: true
desc:
- ja: "連携されているTwitterアカウント情報"
- en: "The info of the connected twitter account of this user"
+ ja-JP: "連携されているTwitterアカウント情報"
+ en-US: "The info of the connected twitter account of this user"
props:
userId:
type: "string"
optional: false
desc:
- ja: "ユーザーID"
- en: "The user ID"
+ ja-JP: "ユーザーID"
+ en-US: "The user ID"
screenName:
type: "string"
optional: false
desc:
- ja: "ユーザー名"
- en: "The screen name of this user"
+ ja-JP: "ユーザー名"
+ en-US: "The screen name of this user"
isBot:
type: "boolean"
optional: true
desc:
- ja: "botか否か(自己申告であることに留意)"
- en: "Whether is bot or not"
+ ja-JP: "botか否か(自己申告であることに留意)"
+ en-US: "Whether is bot or not"
profile:
type: "object"
optional: false
desc:
- ja: "プロフィール"
- en: "The profile of this user"
+ ja-JP: "プロフィール"
+ en-US: "The profile of this user"
props:
location:
type: "string"
optional: true
desc:
- ja: "場所"
- en: "The location of this user"
+ ja-JP: "場所"
+ en-US: "The location of this user"
birthday:
type: "string"
optional: true
desc:
- ja: "誕生日 (YYYY-MM-DD)"
- en: "The birthday of this user (YYYY-MM-DD)"
+ ja-JP: "誕生日 (YYYY-MM-DD)"
+ en-US: "The birthday of this user (YYYY-MM-DD)"
diff --git a/src/docs/api/entities/view.pug b/src/docs/api/entities/view.pug
index d5c192f438..1f166d053c 100644
--- a/src/docs/api/entities/view.pug
+++ b/src/docs/api/entities/view.pug
@@ -7,7 +7,7 @@ block meta
block main
h1= name
- p#desc= desc[lang] || desc['ja']
+ p#desc= desc[lang] || desc['ja-JP']
section
h2= i18n('docs.api.entities.properties')
diff --git a/src/docs/api/mixins.pug b/src/docs/api/mixins.pug
index 925aab2934..563739d52b 100644
--- a/src/docs/api/mixins.pug
+++ b/src/docs/api/mixins.pug
@@ -31,4 +31,4 @@ mixin propTable(props)
td.name= prop.name
td.type
+type(prop)
- td.desc!= prop.desc ? prop.desc[lang] || prop.desc['ja'] : null
+ td.desc!= prop.desc ? prop.desc[lang] || prop.desc['ja-JP'] : null
diff --git a/src/docs/base.pug b/src/docs/base.pug
index aeafaeffff..26f19ddf09 100644
--- a/src/docs/base.pug
+++ b/src/docs/base.pug
@@ -16,7 +16,7 @@ html(lang= lang)
nav
ul
each doc in docs
- li: a(href=`/docs/${lang}/${doc.name}`)= doc.title[lang] || doc.title['ja']
+ li: a(href=`/docs/${lang}/${doc.name}`)= doc.title[lang] || doc.title['ja-JP']
section
h2 API
ul
diff --git a/src/docs/follow.ja.md b/src/docs/follow.ja-JP.md
index a883435ab4..a883435ab4 100644
--- a/src/docs/follow.ja.md
+++ b/src/docs/follow.ja-JP.md
diff --git a/src/docs/mute.ja.md b/src/docs/mute.ja-JP.md
index 6a9608662a..6a9608662a 100644
--- a/src/docs/mute.ja.md
+++ b/src/docs/mute.ja-JP.md
diff --git a/src/docs/reversi-bot.ja.md b/src/docs/reversi-bot.ja-JP.md
index 98b543ca6c..98b543ca6c 100644
--- a/src/docs/reversi-bot.ja.md
+++ b/src/docs/reversi-bot.ja-JP.md
diff --git a/src/docs/stream.ja.md b/src/docs/stream.ja-JP.md
index c720299932..c720299932 100644
--- a/src/docs/stream.ja.md
+++ b/src/docs/stream.ja-JP.md
diff --git a/src/docs/timelines.ja.md b/src/docs/timelines.ja-JP.md
index 36ba61bd2d..36ba61bd2d 100644
--- a/src/docs/timelines.ja.md
+++ b/src/docs/timelines.ja-JP.md