From 5f5156561fe58b5d842e5505a2293bc94a732a72 Mon Sep 17 00:00:00 2001 From: syuilo Date: Sun, 15 Jul 2018 18:28:08 +0900 Subject: ドキュメントをMarkdownで書くように MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/client/docs/api/entities/drive-file.yaml | 73 ----------- src/client/docs/api/entities/note.yaml | 168 ------------------------- src/client/docs/api/entities/post.yaml | 168 ------------------------- src/client/docs/api/entities/style.styl | 1 - src/client/docs/api/entities/user.yaml | 177 --------------------------- src/client/docs/api/entities/view.pug | 20 --- 6 files changed, 607 deletions(-) delete mode 100644 src/client/docs/api/entities/drive-file.yaml delete mode 100644 src/client/docs/api/entities/note.yaml delete mode 100644 src/client/docs/api/entities/post.yaml delete mode 100644 src/client/docs/api/entities/style.styl delete mode 100644 src/client/docs/api/entities/user.yaml delete mode 100644 src/client/docs/api/entities/view.pug (limited to 'src/client/docs/api/entities') diff --git a/src/client/docs/api/entities/drive-file.yaml b/src/client/docs/api/entities/drive-file.yaml deleted file mode 100644 index 02ab0d608e..0000000000 --- a/src/client/docs/api/entities/drive-file.yaml +++ /dev/null @@ -1,73 +0,0 @@ -name: "DriveFile" - -desc: - ja: "ドライブのファイル。" - en: "A file of Drive." - -props: - - name: "id" - type: "id" - optional: false - desc: - ja: "ファイルID" - en: "The ID of this file" - - name: "createdAt" - type: "date" - optional: false - desc: - ja: "アップロード日時" - en: "The upload date of this file" - - name: "userId" - type: "id(User)" - optional: false - desc: - ja: "所有者ID" - en: "The ID of the owner of this file" - - name: "user" - type: "entity(User)" - optional: true - desc: - ja: "所有者" - en: "The owner of this file" - - name: "name" - type: "string" - optional: false - desc: - ja: "ファイル名" - en: "The name of this file" - - name: "md5" - type: "string" - optional: false - desc: - ja: "ファイルのMD5ハッシュ値" - en: "The md5 hash value of this file" - - name: "type" - type: "string" - optional: false - desc: - ja: "ファイルの種類" - en: "The type of this file" - - name: "datasize" - type: "number" - optional: false - desc: - ja: "ファイルサイズ(bytes)" - en: "The size of this file (bytes)" - - name: "url" - type: "string" - optional: false - desc: - ja: "ファイルのURL" - en: "The URL of this file" - - name: "folderId" - type: "id(DriveFolder)" - optional: true - desc: - ja: "フォルダID" - en: "The ID of the folder of this file" - - name: "folder" - type: "entity(DriveFolder)" - optional: true - desc: - ja: "フォルダ" - en: "The folder of this file" diff --git a/src/client/docs/api/entities/note.yaml b/src/client/docs/api/entities/note.yaml deleted file mode 100644 index c508dab3db..0000000000 --- a/src/client/docs/api/entities/note.yaml +++ /dev/null @@ -1,168 +0,0 @@ -name: "Note" - -desc: - ja: "投稿。" - en: "A note." - -props: - - name: "id" - type: "id" - optional: false - desc: - ja: "投稿ID" - en: "The ID of this note" - - name: "createdAt" - type: "date" - optional: false - desc: - ja: "投稿日時" - en: "The posted date of this note" - - name: "viaMobile" - type: "boolean" - optional: true - desc: - ja: "モバイル端末から投稿したか否か(自己申告であることに留意)" - en: "Whether this note sent via a mobile device" - - name: "text" - type: "string" - optional: true - desc: - ja: "投稿の本文" - en: "The text of this note" - - name: "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)" - - name: "media" - type: "entity(DriveFile)[]" - optional: true - desc: - ja: "添付されているメディア" - en: "The attached media" - - name: "userId" - type: "id(User)" - optional: false - desc: - ja: "投稿者ID" - en: "The ID of author of this note" - - name: "user" - type: "entity(User)" - optional: true - desc: - ja: "投稿者" - en: "The author of this note" - - name: "myReaction" - type: "string" - optional: true - desc: - ja: "この投稿に対する自分のリアクション" - en: "The your reaction of this note" - - name: "reactionCounts" - type: "object" - optional: false - desc: - ja: "リアクションをキーとし、この投稿に対するそのリアクションの数を値としたオブジェクト" - - name: "replyId" - type: "id(Note)" - optional: true - desc: - ja: "返信した投稿のID" - en: "The ID of the replyed note" - - name: "reply" - type: "entity(Note)" - optional: true - desc: - ja: "返信した投稿" - en: "The replyed note" - - name: "renoteId" - type: "id(Note)" - optional: true - desc: - ja: "引用した投稿のID" - en: "The ID of the quoted note" - - name: "renote" - type: "entity(Note)" - optional: true - desc: - ja: "引用した投稿" - en: "The quoted note" - - name: "poll" - type: "object" - optional: true - desc: - ja: "投票" - en: "The poll" - defName: "poll" - def: - - name: "choices" - type: "object[]" - optional: false - desc: - ja: "投票の選択肢" - en: "The choices of this poll" - defName: "choice" - def: - - name: "id" - type: "number" - optional: false - desc: - ja: "選択肢ID" - en: "The ID of this choice" - - name: "isVoted" - type: "boolean" - optional: true - desc: - ja: "自分がこの選択肢に投票したかどうか" - en: "Whether you voted to this choice" - - name: "text" - type: "string" - optional: false - desc: - ja: "選択肢本文" - en: "The text of this choice" - - name: "votes" - type: "number" - optional: false - desc: - ja: "この選択肢に投票された数" - en: "The number voted for this choice" - - name: "geo" - type: "object" - optional: true - desc: - ja: "位置情報" - en: "Geo location" - defName: "geo" - def: - - name: "coordinates" - type: "number[]" - optional: false - desc: - ja: "座標。最初に経度：-180〜180で表す。最後に緯度：-90〜90で表す。" - - name: "altitude" - type: "number" - optional: false - desc: - ja: "高度。メートル単位で表す。" - - name: "accuracy" - type: "number" - optional: false - desc: - ja: "緯度、経度の精度。メートル単位で表す。" - - name: "altitudeAccuracy" - type: "number" - optional: false - desc: - ja: "高度の精度。メートル単位で表す。" - - name: "heading" - type: "number" - optional: false - desc: - ja: "方角。0〜360の角度で表す。0が北、90が東、180が南、270が西。" - - name: "speed" - type: "number" - optional: false - desc: - ja: "速度。メートル / 秒数で表す。" diff --git a/src/client/docs/api/entities/post.yaml b/src/client/docs/api/entities/post.yaml deleted file mode 100644 index 6fd26543bb..0000000000 --- a/src/client/docs/api/entities/post.yaml +++ /dev/null @@ -1,168 +0,0 @@ -name: "Note" - -desc: - ja: "投稿。" - en: "A note." - -props: - - name: "id" - type: "id" - optional: false - desc: - ja: "投稿ID" - en: "The ID of this note" - - name: "createdAt" - type: "date" - optional: false - desc: - ja: "投稿日時" - en: "The posted date of this note" - - name: "viaMobile" - type: "boolean" - optional: true - desc: - ja: "モバイル端末から投稿したか否か(自己申告であることに留意)" - en: "Whether this note sent via a mobile device" - - name: "text" - type: "string" - optional: true - desc: - ja: "投稿の本文 (ローカルの場合Markdown風のフォーマット)" - en: "The text of this note (in Markdown like format if local)" - - name: "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)" - - name: "media" - type: "entity(DriveFile)[]" - optional: true - desc: - ja: "添付されているメディア" - en: "The attached media" - - name: "userId" - type: "id(User)" - optional: false - desc: - ja: "投稿者ID" - en: "The ID of author of this note" - - name: "user" - type: "entity(User)" - optional: true - desc: - ja: "投稿者" - en: "The author of this note" - - name: "myReaction" - type: "string" - optional: true - desc: - ja: "この投稿に対する自分のリアクション" - en: "The your reaction of this note" - - name: "reactionCounts" - type: "object" - optional: false - desc: - ja: "リアクションをキーとし、この投稿に対するそのリアクションの数を値としたオブジェクト" - - name: "replyId" - type: "id(Note)" - optional: true - desc: - ja: "返信した投稿のID" - en: "The ID of the replyed note" - - name: "reply" - type: "entity(Note)" - optional: true - desc: - ja: "返信した投稿" - en: "The replyed note" - - name: "renoteId" - type: "id(Note)" - optional: true - desc: - ja: "引用した投稿のID" - en: "The ID of the quoted note" - - name: "renote" - type: "entity(Note)" - optional: true - desc: - ja: "引用した投稿" - en: "The quoted note" - - name: "poll" - type: "object" - optional: true - desc: - ja: "投票" - en: "The poll" - defName: "poll" - def: - - name: "choices" - type: "object[]" - optional: false - desc: - ja: "投票の選択肢" - en: "The choices of this poll" - defName: "choice" - def: - - name: "id" - type: "number" - optional: false - desc: - ja: "選択肢ID" - en: "The ID of this choice" - - name: "isVoted" - type: "boolean" - optional: true - desc: - ja: "自分がこの選択肢に投票したかどうか" - en: "Whether you voted to this choice" - - name: "text" - type: "string" - optional: false - desc: - ja: "選択肢本文" - en: "The text of this choice" - - name: "votes" - type: "number" - optional: false - desc: - ja: "この選択肢に投票された数" - en: "The number voted for this choice" - - name: "geo" - type: "object" - optional: true - desc: - ja: "位置情報" - en: "Geo location" - defName: "geo" - def: - - name: "coordinates" - type: "number[]" - optional: false - desc: - ja: "座標。最初に経度：-180〜180で表す。最後に緯度：-90〜90で表す。" - - name: "altitude" - type: "number" - optional: false - desc: - ja: "高度。メートル単位で表す。" - - name: "accuracy" - type: "number" - optional: false - desc: - ja: "緯度、経度の精度。メートル単位で表す。" - - name: "altitudeAccuracy" - type: "number" - optional: false - desc: - ja: "高度の精度。メートル単位で表す。" - - name: "heading" - type: "number" - optional: false - desc: - ja: "方角。0〜360の角度で表す。0が北、90が東、180が南、270が西。" - - name: "speed" - type: "number" - optional: false - desc: - ja: "速度。メートル / 秒数で表す。" diff --git a/src/client/docs/api/entities/style.styl b/src/client/docs/api/entities/style.styl deleted file mode 100644 index bddf0f53ab..0000000000 --- a/src/client/docs/api/entities/style.styl +++ /dev/null @@ -1 +0,0 @@ -@import "../style" diff --git a/src/client/docs/api/entities/user.yaml b/src/client/docs/api/entities/user.yaml deleted file mode 100644 index 3328734d2b..0000000000 --- a/src/client/docs/api/entities/user.yaml +++ /dev/null @@ -1,177 +0,0 @@ -name: "User" - -desc: - ja: "ユーザー。" - en: "A user." - -props: - id: - type: "id" - optional: false - desc: - ja: "ユーザーID" - en: "The ID of this user" - - createdAt: - type: "date" - optional: false - desc: - ja: "アカウント作成日時" - en: "The registered date of this user" - - username: - type: "string" - optional: false - desc: - ja: "ユーザー名" - en: "The username of this user" - - description: - type: "string" - optional: false - desc: - ja: "アカウントの説明(自己紹介)" - en: "The description of this user" - - avatarId: - type: "id(DriveFile)" - optional: true - desc: - ja: "アバターのID" - en: "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" - - bannerId: - type: "id(DriveFile)" - optional: true - desc: - ja: "バナーのID" - en: "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" - - followersCount: - type: "number" - optional: false - desc: - ja: "フォロワーの数" - en: "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" - - isFollowing: - type: "boolean" - optional: true - desc: - ja: "自分がこのユーザーをフォローしているか" - - isFollowed: - type: "boolean" - optional: true - desc: - ja: "自分がこのユーザーにフォローされているか" - - isMuted: - type: "boolean" - optional: true - desc: - ja: "自分がこのユーザーをミュートしているか" - en: "Whether you muted this user" - - notesCount: - type: "number" - optional: false - desc: - ja: "投稿の数" - en: "The number of the notes of this user" - - pinnedNote: - type: "entity(Note)" - optional: true - desc: - ja: "ピン留めされた投稿" - en: "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" - - driveCapacity: - type: "number" - optional: false - desc: - ja: "ドライブの容量(bytes)" - en: "The capacity of drive of this user (bytes)" - - host: - type: "string | null" - optional: false - desc: - ja: "ホスト (例: example.com:3000)" - en: "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" - props: - userId: - type: "string" - optional: false - desc: - ja: "ユーザーID" - en: "The user ID" - screenName: - type: "string" - optional: false - desc: - ja: "ユーザー名" - en: "The screen name of this user" - - isBot: - type: "boolean" - optional: true - desc: - ja: "botか否か(自己申告であることに留意)" - en: "Whether is bot or not" - - profile: - type: "object" - optional: false - desc: - ja: "プロフィール" - en: "The profile of this user" - props: - location: - type: "string" - optional: true - desc: - ja: "場所" - en: "The location of this user" - birthday: - type: "string" - optional: true - desc: - ja: "誕生日 (YYYY-MM-DD)" - en: "The birthday of this user (YYYY-MM-DD)" diff --git a/src/client/docs/api/entities/view.pug b/src/client/docs/api/entities/view.pug deleted file mode 100644 index 3f50bfd3bd..0000000000 --- a/src/client/docs/api/entities/view.pug +++ /dev/null @@ -1,20 +0,0 @@ -extends ../../layout.pug -include ../mixins - -block meta - link(rel="stylesheet" href="/docs/assets/api/entities/style.css") - -block main - h1= name - - p#desc= desc[lang] || desc['ja'] - - section - h2= i18n('docs.api.entities.properties') - +propTable(props) - - if propDefs - each propDef in propDefs - section(id= propDef.name) - h3= propDef.name - +propTable(propDef.props) -- cgit v1.2.3-freya