定義書更新

Author: takecchi

docs/cuculus-openapi.yaml

@@ -84,30 +84,37 @@ paths:
           in: path
           schema:
             type: number
-        - name: limit
+        - name: max_id
           required: false
           in: query
-          example: 20
-          description: 取得件数
+          example: '26439435541307392'
+          description: このIDを上限として、より小さいIDの投稿を取得します。
           schema:
-            minimum: 1
-            maximum: 40
-            default: 20
-            type: number
+            type: string
         - name: since_id
           required: false
           in: query
           example: '26439435541307392'
-          description: 以降
+          description: このIDを下限として、それよりも大きいIDの投稿を取得します。(min_idと併用不可)
           schema:
             type: string
-        - name: until_id
+        - name: min_id
           required: false
           in: query
           example: '26439435541307392'
-          description: 以前
+          description: このIDよりも新しい直後からの投稿を取得します。(since_idと併用不可)
           schema:
             type: string
+        - name: limit
+          required: false
+          in: query
+          example: 20
+          description: 取得件数
+          schema:
+            minimum: 1
+            maximum: 40
+            default: 20
+            type: number
       responses:
         '200':
           description: 投稿一覧
@@ -117,6 +124,8 @@ paths:
                 type: array
                 items:
                   $ref: '#/components/schemas/UserPost'
+        '400':
+          description: min_idとsince_idは同時に指定できません
         '404':
           description: ユーザーが見つかりませんでした。
       tags:
@@ -673,30 +682,37 @@ paths:
       operationId: getHomeTimeline
       summary: ホームタイムラインの取得
       parameters:
-        - name: limit
+        - name: max_id
           required: false
           in: query
-          example: 20
-          description: 取得件数
+          example: '26439435541307392'
+          description: このIDを上限として、より小さいIDの投稿を取得します。
           schema:
-            minimum: 1
-            maximum: 40
-            default: 20
-            type: number
+            type: string
         - name: since_id
           required: false
           in: query
           example: '26439435541307392'
-          description: 以降
+          description: このIDを下限として、それよりも大きいIDの投稿を取得します。(min_idと併用不可)
           schema:
             type: string
-        - name: until_id
+        - name: min_id
           required: false
           in: query
           example: '26439435541307392'
-          description: 以前
+          description: このIDよりも新しい直後からの投稿を取得します。(since_idと併用不可)
           schema:
             type: string
+        - name: limit
+          required: false
+          in: query
+          example: 20
+          description: 取得件数
+          schema:
+            minimum: 1
+            maximum: 40
+            default: 20
+            type: number
       responses:
         '200':
           description: ポスト一覧
@@ -706,6 +722,8 @@ paths:
                 type: array
                 items:
                   $ref: '#/components/schemas/UserPost'
+        '400':
+          description: min_idとsince_idは同時に指定できません
       tags:
         - timelines
       security:
@@ -715,30 +733,37 @@ paths:
       operationId: getPublicTimeline
       summary: 全体タイムラインの取得(廃止予定)
       parameters:
-        - name: limit
+        - name: max_id
           required: false
           in: query
-          example: 20
-          description: 取得件数
+          example: '26439435541307392'
+          description: このIDを上限として、より小さいIDの投稿を取得します。
           schema:
-            minimum: 1
-            maximum: 40
-            default: 20
-            type: number
+            type: string
         - name: since_id
           required: false
           in: query
           example: '26439435541307392'
-          description: 以降
+          description: このIDを下限として、それよりも大きいIDの投稿を取得します。(min_idと併用不可)
           schema:
             type: string
-        - name: until_id
+        - name: min_id
           required: false
           in: query
           example: '26439435541307392'
-          description: 以前
+          description: このIDよりも新しい直後からの投稿を取得します。(since_idと併用不可)
           schema:
             type: string
+        - name: limit
+          required: false
+          in: query
+          example: 20
+          description: 取得件数
+          schema:
+            minimum: 1
+            maximum: 40
+            default: 20
+            type: number
       responses:
         '200':
           description: ポスト一覧
@@ -748,6 +773,8 @@ paths:
                 type: array
                 items:
                   $ref: '#/components/schemas/UserPost'
+        '400':
+          description: min_idとsince_idは同時に指定できません
       tags:
         - timelines
       security: