diff options
Diffstat (limited to 'src/web/docs')
| -rw-r--r-- | src/web/docs/api.ja.pug | 4 | ||||
| -rw-r--r-- | src/web/docs/api/endpoints/posts/timeline.yaml | 8 | ||||
| -rw-r--r-- | src/web/docs/api/entities/user.yaml | 4 |
3 files changed, 8 insertions, 8 deletions
diff --git a/src/web/docs/api.ja.pug b/src/web/docs/api.ja.pug index 2bb08f7f32..665cfdc4b8 100644 --- a/src/web/docs/api.ja.pug +++ b/src/web/docs/api.ja.pug @@ -54,7 +54,7 @@ section h3 2.ユーザーに認証させる p あなたのアプリを使ってもらうには、ユーザーにアカウントへのアクセスの許可をもらう必要があります。 p - | 認証セッションを開始するには、#{common.config.api_url}/auth/session/generate へパラメータに app_secret としてシークレットキーを含めたリクエストを送信します。 + | 認証セッションを開始するには、#{common.config.api_url}/auth/session/generate へパラメータに appSecret としてシークレットキーを含めたリクエストを送信します。 | リクエスト形式はJSONで、メソッドはPOSTです。 | レスポンスとして認証セッションのトークンや認証フォームのURLが取得できるので、認証フォームのURLをブラウザで表示し、ユーザーにフォームを提示してください。 @@ -76,7 +76,7 @@ section th 説明 tbody tr - td app_secret + td appSecret td string td あなたのアプリのシークレットキー tr diff --git a/src/web/docs/api/endpoints/posts/timeline.yaml b/src/web/docs/api/endpoints/posts/timeline.yaml index 01976b0611..9c44dd736a 100644 --- a/src/web/docs/api/endpoints/posts/timeline.yaml +++ b/src/web/docs/api/endpoints/posts/timeline.yaml @@ -10,22 +10,22 @@ params: optional: true desc: ja: "取得する最大の数" - - name: "since_id" + - name: "sinceId" type: "id(Post)" optional: true desc: ja: "指定すると、この投稿を基点としてより新しい投稿を取得します" - - name: "until_id" + - name: "untilId" type: "id(Post)" optional: true desc: ja: "指定すると、この投稿を基点としてより古い投稿を取得します" - - name: "since_date" + - name: "sinceDate" type: "number" optional: true desc: ja: "指定した時間を基点としてより新しい投稿を取得します。数値は、1970 年 1 月 1 日 00:00:00 UTC から指定した日時までの経過時間をミリ秒単位で表します。" - - name: "until_date" + - name: "untilDate" type: "number" optional: true desc: diff --git a/src/web/docs/api/entities/user.yaml b/src/web/docs/api/entities/user.yaml index 60f2c86084..f45455e731 100644 --- a/src/web/docs/api/entities/user.yaml +++ b/src/web/docs/api/entities/user.yaml @@ -35,7 +35,7 @@ props: desc: ja: "アバターのID" en: "The ID of the avatar of this user" - - name: "avatar_url" + - name: "avatarUrl" type: "string" optional: false desc: @@ -47,7 +47,7 @@ props: desc: ja: "バナーのID" en: "The ID of the banner of this user" - - name: "banner_url" + - name: "bannerUrl" type: "string" optional: false desc: |