[create-pull-request] automated change (bangumi#14)

Co-authored-by: Trim21-bot <[email protected]>

Author: trim21-bot

api.yaml

@@ -105,8 +105,10 @@ paths:
                       remain:
                         type: integer
                         description: 剩余可用登录次数。
+        '415':
+          description: content-type 不是 `application/json`
         '422':
-          description: 无法以 JSON 格式解析请求
+          description: JSON 语法错误
         '502':
           description: hCaptcha HTTP 请求失败
   /p/logout:
@@ -139,6 +141,89 @@ paths:
                 $ref: '#/components/schemas/User'
         '401':
           description: 用户未登录或者 session 已失效
+  /p/groups/{name}:
+    get:
+      tags:
+        - 小组
+      summary: 获取小组首页信息
+      operationId: getGroupProfileByName
+      parameters:
+        - name: name
+          in: path
+          schema:
+            type: string
+          description: 小组名，类似于 `https://bgm.tv/groups/boring` 的 `boring`
+          required: true
+      responses:
+        '200':
+          description: 返回当前用户
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Group'
+        '404':
+          description: 小组不存在
+  /p/groups/{name}/members:
+    get:
+      tags:
+        - 小组
+      summary: 获取小组成员信息
+      operationId: listGroupMembersByName
+      parameters:
+        - name: name
+          in: path
+          schema:
+            type: string
+          description: 小组名，类似于 `https://bgm.tv/groups/boring` 的 `boring`
+          required: true
+        - name: type
+          in: query
+          schema:
+            type: string
+            default: all
+            enum:
+              - mod
+              - normal
+              - all
+          description: 成员类型，默认为 `all`
+          required: true
+        - required: false
+          schema:
+            title: Limit
+            maximum: 50
+            minimum: 1
+            type: integer
+            default: 30
+          name: limit
+          description: 分页参数
+          in: query
+        - required: false
+          schema:
+            title: Offset
+            minimum: 0
+            type: integer
+            default: 0
+          description: 分页参数
+          name: offset
+          in: query
+      responses:
+        '200':
+          description: 列出用户
+          content:
+            application/json:
+              schema:
+                title: Paged[GroupMember]
+                allOf:
+                  - $ref: '#/components/schemas/Paged'
+                  - type: object
+                    properties:
+                      data:
+                        title: Data
+                        type: array
+                        items:
+                          $ref: '#/components/schemas/GroupMember'
+        '404':
+          description: 小组不存在
 components:
   schemas:
     User:
@@ -220,7 +305,58 @@ components:
           title: Sign
           description: 个人签名
           type: string
+    Group:
+      additionalProperties: false
+      properties:
+        id:
+          description: 小组的数字 ID
+          example: 11
+          type: integer
+        created_at:
+          format: date-time
+          example: '2008-08-01T06:11:29+08:00'
+          type: string
+        description:
+          example: "本小组欢迎对各种技术有一定了解的人，\r\n比如像橘花热衷杀人技术……\r\n\r\n不过、本组主要谈论ＰＣ软硬件方面，\r\n想了解相关知识，结识可怕的技术宅，请进。"
+          format: bbcode
+          type: string
+        icon:
+          format: url
+          type: string
+          example: https://lain.bgm.tv/pic/icon/l/000/00/00/11.jpg
+        name:
+          example: a
+          description: 小组的 string ID，原本出现在小组URL中
+          type: string
+        new_members:
+          description: 新加入的用户，最多 10 个。
+          type: array
+          items:
+            $ref: '#/components/schemas/GroupMember/items'
+        title:
+          type: string
+          example: ～技术宅真可怕～
+        total_members:
+          example: 9450
+          description: 用户数
+          type: integer
+      required:
+        - created_at
+        - name
+        - title
+        - description
+        - icon
+        - related_groups
+        - new_topics
+        - new_members
+        - total_members
+        - id
+      type: object
     Avatar:
+      example:
+        large: https://lain.bgm.tv/pic/user/l/000/00/00/1.jpg?r=1391790456
+        medium: https://lain.bgm.tv/pic/user/m/000/00/00/1.jpg?r=1391790456
+        small: https://lain.bgm.tv/pic/user/s/000/00/00/1.jpg?r=1391790456
       title: Avatar
       required:
         - large
@@ -265,6 +401,45 @@ components:
                 path:
                   type: string
                   description: request path
+    Paged:
+      type: object
+      properties:
+        total:
+          title: Total
+          type: integer
+        limit:
+          title: Limit
+          type: integer
+        offset:
+          title: Offset
+          type: integer
+    GroupMember:
+      type: array
+      items:
+        additionalProperties: false
+        properties:
+          avatar:
+            $ref: '#/components/schemas/Avatar'
+          id:
+            type: integer
+            example: 1
+          nickname:
+            type: string
+            example: Sai🖖
+          username:
+            type: string
+            example: sai
+          joined_at:
+            type: string
+            format: date-time
+            example: '2022-06-25T21:07:38.466+08:00'
+        required:
+          - id
+          - username
+          - nickname
+          - avatar
+          - joined_at
+        type: object
   securitySchemes:
     CookiesSession:
       name: sessionID