diff options
| author | Akihiko Odaki <nekomanma@pixiv.co.jp> | 2018-03-29 01:20:40 +0900 |
|---|---|---|
| committer | Akihiko Odaki <nekomanma@pixiv.co.jp> | 2018-03-29 01:54:41 +0900 |
| commit | 90f8fe7e538bb7e52d2558152a0390e693f39b11 (patch) | |
| tree | 0f830887053c8f352b1cd0c13ca715fd14c1f030 /src/web/docs/api/entities | |
| parent | Implement remote account resolution (diff) | |
| download | sharkey-90f8fe7e538bb7e52d2558152a0390e693f39b11.tar.gz sharkey-90f8fe7e538bb7e52d2558152a0390e693f39b11.tar.bz2 sharkey-90f8fe7e538bb7e52d2558152a0390e693f39b11.zip | |
Introduce processor
Diffstat (limited to 'src/web/docs/api/entities')
| -rw-r--r-- | src/web/docs/api/entities/drive-file.yaml | 73 | ||||
| -rw-r--r-- | src/web/docs/api/entities/post.yaml | 173 | ||||
| -rw-r--r-- | src/web/docs/api/entities/style.styl | 1 | ||||
| -rw-r--r-- | src/web/docs/api/entities/user.yaml | 173 | ||||
| -rw-r--r-- | src/web/docs/api/entities/view.pug | 20 |
5 files changed, 0 insertions, 440 deletions
diff --git a/src/web/docs/api/entities/drive-file.yaml b/src/web/docs/api/entities/drive-file.yaml deleted file mode 100644 index 2ebbb089ab..0000000000 --- a/src/web/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: "created_at" - type: "date" - optional: false - desc: - ja: "アップロード日時" - en: "The upload date of this file" - - name: "user_id" - 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: "folder_id" - 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/web/docs/api/entities/post.yaml b/src/web/docs/api/entities/post.yaml deleted file mode 100644 index f780263144..0000000000 --- a/src/web/docs/api/entities/post.yaml +++ /dev/null @@ -1,173 +0,0 @@ -name: "Post" - -desc: - ja: "投稿。" - en: "A post." - -props: - - name: "id" - type: "id" - optional: false - desc: - ja: "投稿ID" - en: "The ID of this post" - - name: "created_at" - type: "date" - optional: false - desc: - ja: "投稿日時" - en: "The posted date of this post" - - name: "via_mobile" - type: "boolean" - optional: true - desc: - ja: "モバイル端末から投稿したか否か(自己申告であることに留意)" - en: "Whether this post sent via a mobile device" - - name: "text" - type: "string" - optional: true - desc: - ja: "投稿の本文" - en: "The text of this post" - - name: "media_ids" - type: "id(DriveFile)[]" - optional: true - desc: - ja: "添付されているメディアのID" - en: "The IDs of the attached media" - - name: "media" - type: "entity(DriveFile)[]" - optional: true - desc: - ja: "添付されているメディア" - en: "The attached media" - - name: "user_id" - type: "id(User)" - optional: false - desc: - ja: "投稿者ID" - en: "The ID of author of this post" - - name: "user" - type: "entity(User)" - optional: true - desc: - ja: "投稿者" - en: "The author of this post" - - name: "my_reaction" - type: "string" - optional: true - desc: - ja: "この投稿に対する自分の<a href='/docs/api/reactions'>リアクション</a>" - en: "The your <a href='/docs/api/reactions'>reaction</a> of this post" - - name: "reaction_counts" - type: "object" - optional: false - desc: - ja: "<a href='/docs/api/reactions'>リアクション</a>をキーとし、この投稿に対するそのリアクションの数を値としたオブジェクト" - - name: "reply_id" - type: "id(Post)" - optional: true - desc: - ja: "返信した投稿のID" - en: "The ID of the replyed post" - - name: "reply" - type: "entity(Post)" - optional: true - desc: - ja: "返信した投稿" - en: "The replyed post" - - name: "repost_id" - type: "id(Post)" - optional: true - desc: - ja: "引用した投稿のID" - en: "The ID of the quoted post" - - name: "repost" - type: "entity(Post)" - optional: true - desc: - ja: "引用した投稿" - en: "The quoted post" - - 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: "is_voted" - 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: "latitude" - type: "number" - optional: false - desc: - ja: "緯度。-90〜90で表す。" - - name: "longitude" - type: "number" - optional: false - desc: - ja: "経度。-180〜180で表す。" - - 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/web/docs/api/entities/style.styl b/src/web/docs/api/entities/style.styl deleted file mode 100644 index bddf0f53ab..0000000000 --- a/src/web/docs/api/entities/style.styl +++ /dev/null @@ -1 +0,0 @@ -@import "../style" diff --git a/src/web/docs/api/entities/user.yaml b/src/web/docs/api/entities/user.yaml deleted file mode 100644 index a451a40807..0000000000 --- a/src/web/docs/api/entities/user.yaml +++ /dev/null @@ -1,173 +0,0 @@ -name: "User" - -desc: - ja: "ユーザー。" - en: "A user." - -props: - - name: "id" - type: "id" - optional: false - desc: - ja: "ユーザーID" - en: "The ID of this user" - - name: "created_at" - type: "date" - optional: false - desc: - ja: "アカウント作成日時" - en: "The registered date of this user" - - name: "username" - type: "string" - optional: false - desc: - ja: "ユーザー名" - en: "The username of this user" - - name: "description" - type: "string" - optional: false - desc: - ja: "アカウントの説明(自己紹介)" - en: "The description of this user" - - name: "avatar_id" - type: "id(DriveFile)" - optional: true - desc: - ja: "アバターのID" - en: "The ID of the avatar of this user" - - name: "avatar_url" - type: "string" - optional: false - desc: - ja: "アバターのURL" - en: "The URL of the avatar of this user" - - name: "banner_id" - type: "id(DriveFile)" - optional: true - desc: - ja: "バナーのID" - en: "The ID of the banner of this user" - - name: "banner_url" - type: "string" - optional: false - desc: - ja: "バナーのURL" - en: "The URL of the banner of this user" - - name: "followers_count" - type: "number" - optional: false - desc: - ja: "フォロワーの数" - en: "The number of the followers for this user" - - name: "following_count" - type: "number" - optional: false - desc: - ja: "フォローしているユーザーの数" - en: "The number of the following users for this user" - - name: "is_following" - type: "boolean" - optional: true - desc: - ja: "自分がこのユーザーをフォローしているか" - - name: "is_followed" - type: "boolean" - optional: true - desc: - ja: "自分がこのユーザーにフォローされているか" - - name: "is_muted" - type: "boolean" - optional: true - desc: - ja: "自分がこのユーザーをミュートしているか" - en: "Whether you muted this user" - - name: "posts_count" - type: "number" - optional: false - desc: - ja: "投稿の数" - en: "The number of the posts of this user" - - name: "pinned_post" - type: "entity(Post)" - optional: true - desc: - ja: "ピン留めされた投稿" - en: "The pinned post of this user" - - name: "pinned_post_id" - type: "id(Post)" - optional: true - desc: - ja: "ピン留めされた投稿のID" - en: "The ID of the pinned post of this user" - - name: "drive_capacity" - type: "number" - optional: false - desc: - ja: "ドライブの容量(bytes)" - en: "The capacity of drive of this user (bytes)" - - name: "host" - type: "string | null" - optional: false - desc: - ja: "ホスト (例: example.com:3000)" - en: "Host (e.g. example.com:3000)" - - name: "account" - type: "object" - optional: false - desc: - ja: "このサーバーにおけるアカウント" - en: "The account of this user on this server" - defName: "account" - def: - - name: "last_used_at" - type: "date" - optional: false - desc: - ja: "最終利用日時" - en: "The last used date of this user" - - name: "is_bot" - type: "boolean" - optional: true - desc: - ja: "botか否か(自己申告であることに留意)" - en: "Whether is bot or not" - - name: "twitter" - type: "object" - optional: true - desc: - ja: "連携されているTwitterアカウント情報" - en: "The info of the connected twitter account of this user" - defName: "twitter" - def: - - name: "user_id" - type: "string" - optional: false - desc: - ja: "ユーザーID" - en: "The user ID" - - name: "screen_name" - type: "string" - optional: false - desc: - ja: "ユーザー名" - en: "The screen name of this user" - - name: "profile" - type: "object" - optional: false - desc: - ja: "プロフィール" - en: "The profile of this user" - defName: "profile" - def: - - name: "location" - type: "string" - optional: true - desc: - ja: "場所" - en: "The location of this user" - - name: "birthday" - type: "string" - optional: true - desc: - ja: "誕生日 (YYYY-MM-DD)" - en: "The birthday of this user (YYYY-MM-DD)" diff --git a/src/web/docs/api/entities/view.pug b/src/web/docs/api/entities/view.pug deleted file mode 100644 index 2156463dc7..0000000000 --- a/src/web/docs/api/entities/view.pug +++ /dev/null @@ -1,20 +0,0 @@ -extends ../../layout.pug -include ../mixins - -block meta - link(rel="stylesheet" href="/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.params) |