{"swagger":"2.0","info":{"description":"Rapaq Social Backend API","version":"0.0.1","title":"A backend application","contact":{"name":"Gary Chen","email":"cutedogspark@gmail.com"}},"host":"35.201.229.54:8080","basePath":"/api/v1","tags":[{"name":"User","description":"User information, included register, login... ."},{"name":"Point Category","description":"point category category collection."}],"schemes":["http"],"paths":{"/logout":{"post":{"tags":["User"],"summary":"Firebase user logout","consumes":["multipart/form-data"],"parameters":[],"security":[{"Bearer":[]}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/user_logout_response_success"}}},"400":{"description":"| Code | Message |\n|---|---|\n| 40000000 | Parameter error (please check your key and message)   |\n| 40100003 | This token is expired since 2018-06-11T03:18:19+00:00 |\n","schema":{"type":"array","items":{"$ref":"#/definitions/response_error_struct"}}},"401":{"description":"| Code | Message |\n|---|---|\n| 40100004 | token invalid |\n","schema":{"type":"array","items":{"$ref":"#/definitions/response_error_struct"}}}}}},"/login":{"post":{"tags":["User"],"summary":"Firebase user login","consumes":["multipart/form-data"],"parameters":[{"name":"fbs_token","in":"formData","description":"Firebase authentication token id.","required":true,"type":"string"},{"name":"device","in":"formData","description":"ios or android.","required":true,"type":"string","enum":["ios","android"]},{"name":"token","in":"formData","description":"firebase message token.","required":true,"type":"string"},{"name":"model_name","in":"formData","description":"device model name, ex: iphone 7s pluse","required":true,"type":"string"},{"name":"model_version","in":"formData","description":"device os version, ex: android 5.0 or ios 11.3","required":true,"type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/user_login_response_success"}}},"400":{"description":"| Code | Message |\n|---|---|\n| 40000000 | Parameter error (please check your key and message)   |\n| 40100003 | This token is expired since 2018-06-11T03:18:19+00:00 |\n","schema":{"type":"array","items":{"$ref":"#/definitions/response_error_struct"}}},"401":{"description":"| Code | Message |\n|---|---|\n| 40100004 | token invalid |\n","schema":{"type":"array","items":{"$ref":"#/definitions/response_error_struct"}}}}}},"/register":{"post":{"tags":["User"],"summary":"Firebase user register","description":"Firebase authentication user, take firebase token id register.\n","consumes":["multipart/form-data"],"parameters":[{"name":"fbs_token","in":"formData","description":"Firebase authentication token id.","required":true,"type":"string"},{"name":"device","in":"formData","description":"ios or android.","required":true,"type":"string","enum":["ios","android"]},{"name":"token","in":"formData","description":"firebase message token.","required":true,"type":"string"},{"name":"model_name","in":"formData","description":"device model name, ex: iphone 7s pluse","required":true,"type":"string"},{"name":"model_version","in":"formData","description":"device os version, ex: android 5.0 or ios 11.3","required":true,"type":"string"},{"name":"display_name","in":"formData","required":true,"type":"string"},{"name":"first_name","in":"formData","required":false,"type":"string"},{"name":"last_name","in":"formData","required":false,"type":"string"},{"name":"address","in":"formData","required":false,"type":"string"},{"name":"location","in":"formData","required":false,"type":"string"},{"name":"site","in":"formData","required":false,"type":"string"},{"name":"language","in":"formData","description":"Use ISO 639-1 format value [Reference](https://en.wikipedia.org/wiki/ISO_639-1)\n","required":true,"type":"string","default":"zh-TW"},{"name":"birthday","in":"formData","description":"yyyy/mm/dd","required":false,"type":"string"},{"name":"bio","in":"formData","required":false,"type":"string"},{"name":"avatar","in":"formData","description":"App upload to firebase store then get path, example '/files/users/{Firebase_UID}/avatar/'","required":false,"type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/user_login_response_success"}}},"400":{"description":"| Code | Message |\n|---|---|\n| 40000000 | Parameter error (please check your key and message)   |\n| 40100003 | This token is expired since 2018-06-11T03:18:19+00:00 |\n","schema":{"type":"array","items":{"$ref":"#/definitions/response_error_struct"}}},"401":{"description":"| Code | Message |\n|---|---|\n| 40100004 | token invalid |\n","schema":{"type":"array","items":{"$ref":"#/definitions/response_error_struct"}}}}}},"/category":{"get":{"tags":["Point Category"],"summary":"search category by id","consumes":["multipart/form-data"],"parameters":[{"name":"fbs_token","in":"formData","description":"Firebase authentication token id.","required":true,"type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/responses_200"}}}}}},"/category/{category_id}":{"get":{"tags":["Point Category"],"summary":"search category by id","consumes":["multipart/form-data"],"parameters":[{"name":"category_id","in":"path","description":"category id.","required":true,"type":"string"},{"name":"fbs_token","in":"formData","description":"Firebase authentication token id.","required":true,"type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/responses_200"}}}}}}},"securityDefinitions":{"Bearer":{"type":"apiKey","name":"Authorization","in":"header"}},"definitions":{"user_login_response_success":{"type":"object","properties":{"items":{"$ref":"#/definitions/user_login_response_success_items"}},"example":{"items":{"expires_in":216000,"token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC8zNS4yMDEuMjI5LjU0OjgwODBcL2FwaVwvdjFcL3JlZ2lzdGVyIiwiaWF0IjoxNTI4NjQxMTM1LCJleHAiOjE1Mjg4NTcxMzUsIm5iZiI6MTUyODY0MTEzNSwianRpIjoiYVFONjFrUzlvZ0czUHZzZCIsInN1YiI6IlYyQ1pLaUlEY2ZTeWpMeFlUVW5hQU82MXk0ZzIiLCJwcnYiOiIyM2JkNWM4OTQ5ZjYwMGFkYjM5ZTcwMWM0MDA4NzJkYjdhNTk3NmY3In0.nbgabNpaOCVf0Mlgka1wVq_DygJ21wYVzTDKn7eOs-s"}}},"user_logout_response_success":{"type":"object","properties":{"items":{"type":"string","example":"logout success"}},"example":{"items":"logout success"}},"response_error_struct":{"type":"object","properties":{"error_code":{"type":"integer"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"description":"\"errors\": {\n    \"token\": [\n      \"The token field is required.\"\n    ],\n    \"model_version\": [\n      \"The model version field is required.\"\n    ]\n}\n"}}}},"responses_200":{"type":"object","required":["description"],"properties":{"id":{"type":"integer","format":"int64","readOnly":true},"description":{"type":"string","minLength":1},"completed":{"type":"boolean"}},"example":{"description":"description","id":0,"completed":true}},"user_login_response_success_items":{"properties":{"token":{"type":"string","example":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC8zNS4yMDEuMjI5LjU0OjgwODBcL2FwaVwvdjFcL3JlZ2lzdGVyIiwiaWF0IjoxNTI4NjQxMTM1LCJleHAiOjE1Mjg4NTcxMzUsIm5iZiI6MTUyODY0MTEzNSwianRpIjoiYVFONjFrUzlvZ0czUHZzZCIsInN1YiI6IlYyQ1pLaUlEY2ZTeWpMeFlUVW5hQU82MXk0ZzIiLCJwcnYiOiIyM2JkNWM4OTQ5ZjYwMGFkYjM5ZTcwMWM0MDA4NzJkYjdhNTk3NmY3In0.nbgabNpaOCVf0Mlgka1wVq_DygJ21wYVzTDKn7eOs-s"},"expires_in":{"type":"integer","format":"int64","example":216000}},"example":{"expires_in":216000,"token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC8zNS4yMDEuMjI5LjU0OjgwODBcL2FwaVwvdjFcL3JlZ2lzdGVyIiwiaWF0IjoxNTI4NjQxMTM1LCJleHAiOjE1Mjg4NTcxMzUsIm5iZiI6MTUyODY0MTEzNSwianRpIjoiYVFONjFrUzlvZ0czUHZzZCIsInN1YiI6IlYyQ1pLaUlEY2ZTeWpMeFlUVW5hQU82MXk0ZzIiLCJwcnYiOiIyM2JkNWM4OTQ5ZjYwMGFkYjM5ZTcwMWM0MDA4NzJkYjdhNTk3NmY3In0.nbgabNpaOCVf0Mlgka1wVq_DygJ21wYVzTDKn7eOs-s"}}}}