summaryrefslogtreecommitdiff
path: root/src/web/docs/api/endpoints
diff options
context:
space:
mode:
authorAkihiko Odaki <nekomanma@pixiv.co.jp>2018-03-29 01:20:40 +0900
committerAkihiko Odaki <nekomanma@pixiv.co.jp>2018-03-29 01:54:41 +0900
commit90f8fe7e538bb7e52d2558152a0390e693f39b11 (patch)
tree0f830887053c8f352b1cd0c13ca715fd14c1f030 /src/web/docs/api/endpoints
parentImplement remote account resolution (diff)
downloadsharkey-90f8fe7e538bb7e52d2558152a0390e693f39b11.tar.gz
sharkey-90f8fe7e538bb7e52d2558152a0390e693f39b11.tar.bz2
sharkey-90f8fe7e538bb7e52d2558152a0390e693f39b11.zip
Introduce processor
Diffstat (limited to 'src/web/docs/api/endpoints')
-rw-r--r--src/web/docs/api/endpoints/posts/create.yaml53
-rw-r--r--src/web/docs/api/endpoints/posts/timeline.yaml32
-rw-r--r--src/web/docs/api/endpoints/style.styl21
-rw-r--r--src/web/docs/api/endpoints/view.pug32
4 files changed, 0 insertions, 138 deletions
diff --git a/src/web/docs/api/endpoints/posts/create.yaml b/src/web/docs/api/endpoints/posts/create.yaml
deleted file mode 100644
index 5e2307dab4..0000000000
--- a/src/web/docs/api/endpoints/posts/create.yaml
+++ /dev/null
@@ -1,53 +0,0 @@
-endpoint: "posts/create"
-
-desc:
- ja: "投稿します。"
- en: "Compose new post."
-
-params:
- - name: "text"
- type: "string"
- optional: true
- desc:
- ja: "投稿の本文"
- en: "The text of your post"
- - name: "media_ids"
- type: "id(DriveFile)[]"
- optional: true
- desc:
- ja: "添付するメディア(1~4つ)"
- en: "Media you want to attach (1~4)"
- - name: "reply_id"
- type: "id(Post)"
- optional: true
- desc:
- ja: "返信する投稿"
- en: "The post you want to reply"
- - name: "repost_id"
- type: "id(Post)"
- optional: true
- desc:
- ja: "引用する投稿"
- en: "The post you want to quote"
- - name: "poll"
- type: "object"
- optional: true
- desc:
- ja: "投票"
- en: "The poll"
- defName: "poll"
- def:
- - name: "choices"
- type: "string[]"
- optional: false
- desc:
- ja: "投票の選択肢"
- en: "Choices of a poll"
-
-res:
- - name: "created_post"
- type: "entity(Post)"
- optional: false
- desc:
- ja: "作成した投稿"
- en: "A post that created"
diff --git a/src/web/docs/api/endpoints/posts/timeline.yaml b/src/web/docs/api/endpoints/posts/timeline.yaml
deleted file mode 100644
index 01976b0611..0000000000
--- a/src/web/docs/api/endpoints/posts/timeline.yaml
+++ /dev/null
@@ -1,32 +0,0 @@
-endpoint: "posts/timeline"
-
-desc:
- ja: "タイムラインを取得します。"
- en: "Get your timeline."
-
-params:
- - name: "limit"
- type: "number"
- optional: true
- desc:
- ja: "取得する最大の数"
- - name: "since_id"
- type: "id(Post)"
- optional: true
- desc:
- ja: "指定すると、この投稿を基点としてより新しい投稿を取得します"
- - name: "until_id"
- type: "id(Post)"
- optional: true
- desc:
- ja: "指定すると、この投稿を基点としてより古い投稿を取得します"
- - name: "since_date"
- type: "number"
- optional: true
- desc:
- ja: "指定した時間を基点としてより新しい投稿を取得します。数値は、1970 年 1 月 1 日 00:00:00 UTC から指定した日時までの経過時間をミリ秒単位で表します。"
- - name: "until_date"
- type: "number"
- optional: true
- desc:
- ja: "指定した時間を基点としてより古い投稿を取得します。数値は、1970 年 1 月 1 日 00:00:00 UTC から指定した日時までの経過時間をミリ秒単位で表します。"
diff --git a/src/web/docs/api/endpoints/style.styl b/src/web/docs/api/endpoints/style.styl
deleted file mode 100644
index 2af9fe9a77..0000000000
--- a/src/web/docs/api/endpoints/style.styl
+++ /dev/null
@@ -1,21 +0,0 @@
-@import "../style"
-
-#url
- padding 8px 12px 8px 8px
- font-family Consolas, 'Courier New', Courier, Monaco, monospace
- color #fff
- background #222e40
- border-radius 4px
-
- > .method
- display inline-block
- margin 0 8px 0 0
- padding 0 6px
- color #f4fcff
- background #17afc7
- border-radius 4px
- user-select none
- pointer-events none
-
- > .host
- opacity 0.7
diff --git a/src/web/docs/api/endpoints/view.pug b/src/web/docs/api/endpoints/view.pug
deleted file mode 100644
index d271a5517a..0000000000
--- a/src/web/docs/api/endpoints/view.pug
+++ /dev/null
@@ -1,32 +0,0 @@
-extends ../../layout.pug
-include ../mixins
-
-block meta
- link(rel="stylesheet" href="/assets/api/endpoints/style.css")
-
-block main
- h1= endpoint
-
- p#url
- span.method POST
- span.host
- = url.host
- | /
- span.path= url.path
-
- p#desc= desc[lang] || desc['ja']
-
- section
- h2 %i18n:docs.api.endpoints.params%
- +propTable(params)
-
- if paramDefs
- each paramDef in paramDefs
- section(id= paramDef.name)
- h3= paramDef.name
- +propTable(paramDef.params)
-
- if res
- section
- h2 %i18n:docs.api.endpoints.res%
- +propTable(res)