user.yml

users:
  get:
    tags:
      - user
    operationId: getUsers
    summary: ユーザーの情報を取得する
    description: ページ番号が指定されなかった場合は1ページ目を返す
    security: []
    parameters:
      - name: page
        in: query
        description: ページ番号
        required: false
        schema:
          type: string
          pattern: ^[1-9]\d*$
          minimum: 1
          default: 1
      - name: limit
        in: query
        description: 1ページあたりの表示数
        required: false
        schema:
          type: string
          pattern: ^[1-9]\d*$
          minimum: 1
          default: 10
      - name: name
        in: query
        description: ユーザー名
        required: false
        schema:
          type: string
      - name: email
        in: query
        description: メールアドレス
        required: false
        schema:
          type: string
          format: email
    responses:
      '200':
        description: 情報の取得に成功した
        content:
          application/json:
            schema:
              type: object
              properties:
                totalUser:
                  description: 総ユーザー数
                  type: integer
                users:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: integer
                      name:
                        type: string
              required:
                - totalUser
                - users
      '400':
        $ref: '../components/responses/4xx.yml#/BadRequest'
      '500':
        $ref: '../components/responses/5xx.yml#/InternalServerError'

  post:
    tags:
      - user
    operationId: createUser
    summary: ユーザーを追加する
    security:
      - CookieAuth: []
    requestBody:
      required: true
      content:
        application/json:
          schema:
            type: object
            properties:
              name:
                type: string
              email:
                type: string
                format: email
              password:
                type: string
                format: password
                pattern: ^(?=.*[A-Za-z])(?=.*\d)[A-Za-z\d]+$
                minLength: 8
            required:
              - name
              - email
              - password
          example:
            name: '比企谷八幡'
            email: 'hikigaya@oregairu.com'
            password: 'passw0rd'
    responses:
      '201':
        description: ユーザーの追加に成功した
        content:
          application/json:
            schema:
              $ref: '../components/schemas/User.yml'
            examples:
              user:
                $ref: '../components/examples/user.yml'
      '400':
        $ref: '../components/responses/4xx.yml#/BadRequest'
      '401':
        $ref: '../components/responses/4xx.yml#/Unauthorized'
      '409':
        description: すでに同じメールアドレスで登録されたユーザーが存在する
        content:
          application/json:
            schema:
              $ref: '../components/schemas/Error.yml'
            example:
              message: 'Conflict'
      '500':
        $ref: '../components/responses/5xx.yml#/InternalServerError'

  delete:
    tags:
      - user
    operationId: deleteUsers
    summary: 指定された1人以上のユーザーを削除する
    security:
      - CookieAuth: []
    requestBody:
      required: true
      content:
        application/json:
          schema:
            type: object
            properties:
              userIdList:
                type: array
                items:
                  type: integer
            required:
              - userIdList
            example:
              userIdList:
                - 1
                - 2
                - 3
    responses:
      '204':
        description: ユーザーの削除に成功した
      '400':
        $ref: '../components/responses/4xx.yml#/BadRequest'
      '401':
        $ref: '../components/responses/4xx.yml#/Unauthorized'
      '500':
        $ref: '../components/responses/5xx.yml#/InternalServerError'

user:
  get:
    tags:
      - user
    operationId: getUser
    summary: 特定のユーザーの情報を取得する
    security:
      - CookieAuth: []
    parameters:
      - name: userId
        in: path
        description: '取得するユーザーのID'
        required: true
        schema:
          type: string
          pattern: '^\d+$'
    responses:
      '200':
        description: 情報の取得に成功した
        content:
          application/json:
            schema:
              $ref: '../components/schemas/User.yml'
            examples:
              user:
                $ref: '../components/examples/user.yml'
      '400':
        $ref: '../components/responses/4xx.yml#/BadRequest'
      '401':
        $ref: '../components/responses/4xx.yml#/Unauthorized'
      '404':
        $ref: '../components/responses/4xx.yml#/NotFound'
      '500':
        $ref: '../components/responses/5xx.yml#/InternalServerError'

  patch:
    tags:
      - user
    operationId: updateUser
    summary: 特定のユーザーの情報を更新する
    description: リクエストボディに含まれている情報のみ更新する
    security:
      - CookieAuth: []
    parameters:
      - name: userId
        in: path
        description: 更新するユーザーのID
        required: true
        schema:
          type: string
          pattern: '^\d+$'
    requestBody:
      required: true
      content:
        application/json:
          schema:
            type: object
            properties:
              name:
                type: string
              email:
                type: string
                format: email
              currentPassword:
                type: string
                format: password
                pattern: ^(?=.*[A-Za-z])(?=.*\d)[A-Za-z\d]+$
                minLength: 8
              newPassword:
                type: string
                format: password
                pattern: ^(?=.*[A-Za-z])(?=.*\d)[A-Za-z\d]+$
                minLength: 8
          example:
            name: '比企谷八幡'
            email: 'hikigaya@oregairu.com'
            currentPassword: 'passw0rd'
            newPassword: 'pa55word'
    responses:
      '200':
        description: 情報の更新に成功した
        content:
          application/json:
            schema:
              $ref: '../components/schemas/User.yml'
            examples:
              user:
                $ref: '../components/examples/user.yml'
      '400':
        $ref: '../components/responses/4xx.yml#/BadRequest'
      '401':
        $ref: '../components/responses/4xx.yml#/Unauthorized'
      '404':
        $ref: '../components/responses/4xx.yml#/NotFound'
      '500':
        $ref: '../components/responses/5xx.yml#/InternalServerError'

  delete:
    tags:
      - user
    operationId: deleteUser
    summary: 特定のユーザーを削除する
    security:
      - CookieAuth: []
    parameters:
      - name: userId
        in: path
        description: 削除するユーザーのID
        required: true
        schema:
          type: string
          pattern: '^\d+$'
    responses:
      '204':
        description: ユーザーの削除に成功した
        content:
          application/json:
            schema:
              type: object
              properties:
                message:
                  type: string
            example:
              message: 'No Content'
      '400':
        $ref: '../components/responses/4xx.yml#/BadRequest'
      '401':
        description: Unauthorized
        content:
          application/json:
            schema:
              $ref: '../components/schemas/Error.yml'
      '404':
        $ref: '../components/responses/4xx.yml#/NotFound'
      '500':
        $ref: '../components/responses/5xx.yml#/InternalServerError'