swagger.yaml

openapi: 3.0.0
info:
  title: API Documentation
  description: Mô tả tất cả API từ Fish Server
  version: 1.0.0
servers:
  - url: http://localhost:3000
    description: Máy chủ phát triển
tags:
  - name: invitation api
    description: api để gửi thư mời user vô 1 thuyền
  - name: ship api
    description: api liên quan tới thuyền
  - name: user api 
    description: api cơ bản cho người dùng
  - name: admin api 
    description: api cho quản trị viên

components:
  schemas:
    CommonResponse:
      type: object
      properties:
        timestamp:
          type: string
          format: date-time
          description: Thời gian phản hồi
        status:
          type: string
          description: Trạng thái của phản hồi (success, error, ...)
        code:
          type: integer
          description: Mã phản hồi HTTP
        message:
          type: object
          description: Phản hồi của ứng dụng
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

paths:
  /admin/assign:
    patch:
      summary: gán quyền (role) cho người dùng
      description: API này cho phép admin gán quyền hoặc nhiệm vụ cho một người dùng cụ thể.
      tags:
        - admin api
      security:
        - BearerAuth: []
      parameters:
        - name: email
          in: query
          required: true
          schema:
            type: string
        - name: role
          in: query
          required: true
          schema:
            type: string
      responses:
        default:
          description: Phản hồi chung cho mọi mã trạng thái
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CommonResponse"

  /admin/getUser:
    get: 
      summary: lấy thông tin tất cả user
      description: API này cho phép lấy thông tin của tất cả người dùng
      tags:
        - admin api
      security:
        - BearerAuth: []
      parameters:
        - name: page
          in: query
          required: true
          schema:
            type: integer
            default: 0
      responses:
        default:                 
          description: Phản hồi chung cho mọi mã trạng thái
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CommonResponse"

  /admin/deleteUser/{email}:
    delete:
      summary: xóa thông tin của user ra khỏi database
      description: API này cho phép xóa thông tin của user ra khỏi database, đồng thời xóa luôn thuyền mà user đó sở hữu
      tags:
        - admin api
      security:
        - BearerAuth: []
      # parameters:
      responses:
        default:
          description: Phản hồi chung cho mọi mã trạng thái
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CommonResponse"

  /api/info:
    get:
      summary: lấy thông tin người dùng
      description: API này cho phép lấy thông tin của user
      tags:
        - user api 
      security:
        - BearerAuth: []
      responses:
        default:
          description: Phản hồi chung cho mọi mã trạng thái
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CommonResponse"

  /api/changeDisplayName:
    patch:
      summary: đổi tên hiển thị
      description: :v
      tags:
        - user api
      security:
        - BearerAuth: []
      parameters:
        - name: name
          in: query
          required: true
          schema:
            type: string
      responses:
        default:
          description: Phản hồi chung cho mọi mã trạng thái
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CommonResponse"    

  /ship:
    post:
      summary: tạo thuyền mới
      tags:
        - ship api
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                crewSize:
                  type: integer
      responses:
        default:
          description: Phản hồi chung cho mọi mã trạng thái
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CommonResponse"
    get:
      summary: lấy thông tin tất cả thuyền mà user sỡ hữu
      tags:
        - ship api
      security:
        - BearerAuth: []
      responses:
        default:
          description: Phản hồi chung cho mọi mã trạng thái
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CommonResponse"

  /ship/addMember:
    post:
      summary: Gửi thư mời thành viên khác lên thuyên
      description: Gửi một email tồn tại trong 12 tiếng, email nãy sẽ chứa url đến <domain>/invitation/join/....
      tags:
        - ship api
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                shipID:
                  type: string
                userEmail:
                  type: string
      responses:
        default:
          description: Phản hồi chung cho mọi mã trạng thái
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CommonResponse"

  /ship/leave/{ship_id}:
    get:
      summary: Rời khỏi thuyền
      description: API để out khỏi thuyền. Đối với owner, báo lỗi không thể out. Nếu thuyền không tồn tại, báo lỗi 404.
      tags:
        - ship api
      security:
        - BearerAuth: []
      responses:
        default:
          description: Phản hồi chung cho mọi mã trạng thái
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CommonResponse"

  /ship/promote/{user_id}:
    get:
      summary: Nhường quyền owner cho 1 thuyền viên
      description: Nhường quyền owner cho 1 thuyền viên owner -> member & member -> owner. Báo lỗi 404 nếu user_id không tồn tại hoặc không có trên thuyền.
      tags:
        - ship api
      security:
        - BearerAuth: []
      responses:
        default:
          description: Phản hồi chung cho mọi mã trạng thái
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CommonResponse"

  /ship/delete/{ship_id}:
    delete:
      summary: Xóa 1 thuyền trong danh sách thuyền đã tạo của user
      description: Xóa 1 thuyền trong danh sách thuyền đã tạo của user, nếu {ship_id} không tồn tại báo lỗi 404
      tags:
        - ship api
      security:
        - BearerAuth: []
      responses:
        default:
          description: Phản hồi chung cho mọi mã trạng thái
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CommonResponse"

  /ship/delete/{ship_id}/{user_id}:
    delete:
      summary: Xóa 1 thành viên ra khỏi thuyền
      description: Xóa 1 thành viên ra khỏi thuyền, nếu {ship_id} / {user_id} không tồn tại báo lỗi 404
      tags:
        - ship api
      security:
        - BearerAuth: []
      responses:
        default:
          description: Phản hồi chung cho mọi mã trạng thái
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CommonResponse"

  /invitation/join/{invitation_id}:
    post:
      summary: chấp nhận lời mời
      description: xóa dữ liệu sau khi chấp nhận (hoặc lỗi)
      tags:
        - invitation api
      parameters:
        - name: email
          in: query
          required: true
          schema:
            type: string
      responses:
        default:
          description: Phản hồi chung cho mọi mã trạng thái
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CommonResponse"