{"openapi":"3.0.3","info":{"title":"A getting started API.","version":"1.0.0"},"servers":[{"url":"/v1"}],"paths":{"/users":{"parameters":[],"get":{"summary":"Returns users.","operationId":"getUsers","parameters":[],"responses":{"200":{"description":"Returned list of users successfully","content":{"application/json":{"schema":{"type":"array","maxItems":100,"items":{"$ref":"#/components/schemas/User"}}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"default":{"$ref":"#/components/responses/Default"}},"tags":["Users"]}},"/users/{id}":{"parameters":[{"name":"id","in":"path","description":"User id.","required":true,"schema":{"$ref":"#/components/schemas/UserId"}}],"get":{"summary":"Return user by id.","operationId":"getUser","responses":{"200":{"description":"Returned the user successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"204":{"description":"No user found"},"400":{"description":"Cast to ObjectId failed for value _id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponseBody"}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"default":{"$ref":"#/components/responses/Default"}},"tags":["Users"]},"delete":{"summary":"Delete user by id.","operationId":"deleteUser","responses":{"200":{"description":"User deleted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"default":{"$ref":"#/components/responses/Default"}},"tags":["Users"]},"put":{"summary":"Update user by id.","operationId":"updateUser","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"responses":{"200":{"description":"User updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"default":{"$ref":"#/components/responses/Default"}},"tags":["Users"]}},"/users/forgot":{"post":{"summary":"Send password recovery email","security":[],"operationId":"forgot","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"$ref":"#/components/schemas/Email"}},"additionalProperties":false}}}},"responses":{"200":{"description":"No error, but no sending confirmation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponseBody"}}}},"503":{"description":"Mail server out of service","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponseBody"}}}},"default":{"$ref":"#/components/responses/Default"}},"tags":["Auth"]}},"/users/logout":{"get":{"summary":"Logout the user","operationId":"logout","responses":{"200":{"description":"User log out","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponseBody"}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"default":{"$ref":"#/components/responses/Default"}},"tags":["Auth"]}},"/users/me":{"get":{"summary":"Return logged user.","operationId":"getMe","responses":{"200":{"description":"Returned own user successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"default":{"$ref":"#/components/responses/Default"}},"tags":["Users"]}},"/users/login":{"post":{"summary":"Return a user token for authorization.","operationId":"loginUser","security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserLogin"}}}},"responses":{"200":{"description":"Returned token successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenResponseBody"}}}},"default":{"$ref":"#/components/responses/Default"}},"tags":["Auth"]}},"/users/register":{"post":{"summary":"Create a user and return a success message","operationId":"registerUser","security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"responses":{"200":{"description":"User created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponseBody"}}}},"default":{"$ref":"#/components/responses/Default"}},"tags":["Auth"]}},"/users/reset/{token}":{"parameters":[{"name":"token","in":"path","description":"Password recovery token","required":true,"schema":{"$ref":"#/components/schemas/Token"}}],"put":{"summary":"Reset the user password","security":[],"operationId":"resetPassword","responses":{"200":{"description":"User password reseted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponseBody"}}}},"default":{"$ref":"#/components/responses/Default"}},"tags":["Auth"]}}},"components":{"responses":{"UnauthorizedError":{"description":"Access token is missing or invalid","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/BasicString"}}}},"Default":{"description":"An error occurred","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponseBody"}}}}},"schemas":{"BasicString":{"type":"string","maxLength":99,"minLength":1,"pattern":".*"},"Email":{"type":"string","format":"email","maxLength":999,"minLength":3,"pattern":"^(([^<>()\\[\\]\\\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))$","example":"franciscoj.godoy@sdos.es"},"Password":{"type":"string","format":"password","maxLength":16,"minLength":8,"pattern":"^(?=.*\\d)(?=.*[A-Z])(?=.*[a-z])(?=.*[^\\w\\d\\s:])([^\\s]){8,16}$","example":"Aa12345&"},"Role":{"type":"string","default":"basic","enum":["basic","supervisor","admin"],"maxLength":10,"minLength":3,"pattern":".*"},"Token":{"type":"string","format":"bearer","maxLength":999,"minLength":10,"pattern":".*"},"UserId":{"type":"string","minLength":24,"maxLength":24,"pattern":"^(?=(.*[0-9])+)(?=(.*[a-z])+)(?=(.*[A-Z])+)[0-9a-zA-Z]{24}$","example":"5f3f88228c247e18b0fe95fe"},"Username":{"type":"string","maxLength":99,"minLength":3,"pattern":".*"},"SuccessResponseBody":{"properties":{"success":{"description":"Notify whether the response is success or not","type":"boolean"},"msg":{"$ref":"#/components/schemas/BasicString"}},"readOnly":true,"required":["success","msg"],"additionalProperties":false},"TokenResponseBody":{"properties":{"success":{"description":"Notify whether the response is success or not","type":"boolean"},"token":{"$ref":"#/components/schemas/Token"}},"readOnly":true,"required":["success","token"],"additionalProperties":false},"User":{"properties":{"email":{"$ref":"#/components/schemas/Email"},"username":{"$ref":"#/components/schemas/Username"},"password":{"$ref":"#/components/schemas/Password"},"role":{"$ref":"#/components/schemas/Role"},"accessToken":{"$ref":"#/components/schemas/Token"},"resetPasswordToken":{"$ref":"#/components/schemas/Token"},"resetPasswordExpires":{"$ref":"#/components/schemas/BasicString"}},"required":["email","password"],"additionalProperties":false},"UserLogin":{"properties":{"email":{"$ref":"#/components/schemas/Email"},"password":{"$ref":"#/components/schemas/Password"}},"required":["email","password"],"additionalProperties":false}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"Bearer"}}},"security":[{"BearerAuth":[]}]}