syntax = "proto3";

package backend.common;

option go_package = ".;commonPb";

message Error {
  enum Code {
    OK = 0;

    reserved 1 to 9999;

    // ========= Common =========

    // 鉴权
    UNAUTHORIZED = 10000;
    reserved 10001 to 10999;

    // 通用请求错误
    BAD_REQUEST = 11000;
    INVALID_CONTENT_TYPE = 11001;
    INVALID_CONTENT_ENCODING = 11002;
    TOO_MANY_REQUESTS = 11003;
    reserved 11004 to 11099;

    // ========= Biz =========

    // Config
    INVALID_STORAGE_TYPE = 11100;
    reserved 11101 to 11199;

    // DataEvent
    INVALID_DE_DATA = 11200;
    reserved 11201 to 19999;

    // Checkin
    CHECKIN_REPEATED = 20000;
    reserved 20001 to 20999;

    // Course
    COURSE_NOT_FOUND = 21000;
    // 课程没有权益
    COURSE_NOT_INTEREST = 21001;
    reserved 21002 to 21999;

    // Recommend
    MODULE_NOT_FOUND = 22000;
    reserved 22001 to 22999;

    // User Course
    USER_COURSE_ALREADY_ADDED = 23000;
    USER_COURSE_NOT_FOUND = 23001;
    reserved 23002 to 23999;

    // PT
    PT_LIMITED = 24000;
    reserved 24001 to 24099;

    // Payment 24100 - 24299

    // 无效的价格
    INVALID_PRICE = 24100;
    // 无效的 product ID
    INVALID_PRODUCT_ID = 24101;
    // 无效的订单号
    INVALID_ORDER_NUMBER = 24102;
    // 无效的用户 ID
    INVALID_USER_ID = 24103;
    // 无效的收据
    INVALID_RECEIPT = 24104;
    // 异常的 iOS 收据，需要客户端 check 和重试
    EMPTY_IOS_RECEIPT = 24105;

    reserved 24106 to 24299;

    // UserPlan 相关
    // 免费用户限制 plan 课程数量
    USER_PLAN_LIMITED_COURSE_COUNT = 24300;


    // 保留业务段 24400 to 89999
    reserved 24400 to 89999;

    // ========= SYSTEM =========
    // 服务自身错误
    INTERNAL_ERROR = 90000;
    reserved 90001 to 90099;

    // encoding/decoding error

    // JSONPB encoding/decoding with error
    JSONPB_ERROR = 90100;

    // JSON encoding/decoding with error
    JSON_ERROR = 90101;

    // PB encoding/decoding with error
    PB_ERROR = 90102;
    reserved 90103 to 90999;

    // 依赖服务错误
    EXTERNAL_ERROR = 91000;

    reserved 91001 to max;
  }

  // 业务错误码
  Code code = 1;

  // 错误信息
  string msg = 2;

  // 补充错误信息
  // @optional
  repeated string errors = 3;
}