{"openapi":"3.0.0","servers":[{"description":"TP2 API","url":"https://virtserver.swaggerhub.com/a10212/a10212_TP2/1.0.0"},{"url":"http://localhost:5000/","description":"Local Server"}],"info":{"description":"\tThis is the API documentation of TP2 for Arquitetura de Sistemas","version":"1.0.0","title":"10212 TP2 API","contact":{"email":"a10212@alunos.ipca.pt"}},"paths":{"/utilizadores":{"get":{"operationId":"lista_todos_utilizadores","description":"Lista todos os utilizadores registados na base de dados","security":[{"BearerAuth":["administrador"]}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Utilizador"}}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden. UnauthorizedError"}},"summary":"gets all registeres users"},"post":{"summary":"register a new user","operationId":"registar_utilizador","description":"Adds an user to the system","responses":{"201":{"description":"item created"},"400":{"description":"invalid input, object invalid"},"409":{"description":"an existing item already exists"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistoUtilizador"}}},"description":"New user to be added"}}},"/utilizadores/{id}":{"get":{"operationId":"obtem_um_utilizador","description":"get an user from its user id","security":[{"BearerAuth":["administrador"]}],"parameters":[{"in":"path","name":"id","description":"id of the registered user","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"object","items":{"$ref":"#/components/schemas/Utilizador"}}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden. UnauthorizedError"},"404":{"description":"Not found"}},"summary":"gets the user with matching id"},"put":{"summary":"updates an user","operationId":"alterar_um_utilizador","description":"Updates user info","security":[{"BearerAuth":["administrator"]}],"parameters":[{"in":"path","name":"id","description":"id of the registered user to be updated","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"item updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Utilizador"}}}},"400":{"description":"invalid input, object invalid"},"403":{"description":"Forbidden. UnauthorizedError"},"404":{"description":"Not found"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistoUtilizador"}}},"description":"New user data"}},"delete":{"description":"deletes an user","operationId":"eliminar_um_utilizador","security":[{"BearerAuth":["administrator"]}],"parameters":[{"in":"path","name":"id","description":"id of the registered user to be deleted","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"user deleted"},"403":{"description":"Forbidden. UnauthorizedError"}}}},"/aprovaregisto/{id}":{"get":{"operationId":"aprovaregisto/{id}","description":"Aprova um registo de um utilizador","security":[{"BearerAuth":["administrador"]}],"parameters":[{"in":"path","name":"id","description":"id of the register to approve","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Registo aprovado","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Utilizador"}}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden. UnauthorizedError"},"404":{"description":"Not found"}},"summary":"approves the user registration"}},"/veiculos":{"get":{"operationId":"lista_todos_veiculos","description":"Lista todos os veiculos registados na base de dados","security":[{"BearerAuth":["administrador","funcionario"]}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Veiculo"}}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden. UnauthorizedError"}},"summary":"gets all registered vehicles"},"post":{"summary":"register a new vehicle","operationId":"novo_veiculo","description":"Adds a new vehicle to the system","responses":{"201":{"description":"vehicle created"},"400":{"description":"invalid input, object invalid"},"409":{"description":"an existing vehicle already exists"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistoVeiculo"}}},"description":"New vehicle to be added"}}},"/veiculos/{matricula}":{"get":{"operationId":"obtem_um_veiculo_por_codigo","description":"get an vehicle from its vehicle plate","security":[{"BearerAuth":["administrador","funcionario"]}],"parameters":[{"in":"path","name":"matricula","description":"identification plate of the registered vehicle","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"object","items":{"$ref":"#/components/schemas/Veiculo"}}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden. UnauthorizedError"},"404":{"description":"Not found"}},"summary":"gets the vehicle with matching id"}},"/veiculos/{matricula}/malestacionado":{"get":{"operationId":"veiculo_mal_estacionado","description":"register an incorrect parking","security":[{"BearerAuth":["administrador","funcionario"]}],"parameters":[{"in":"path","name":"matricula","description":"identification plate of the registered vehicle","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"information registered sucessfully"},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden. UnauthorizedError"},"404":{"description":"Not found"}},"summary":"indicates that the vehicles is not correcly parked"}},"/veiculos/{lat}/{long}":{"get":{"operationId":"obtem_um_veiculo_por_localizacao","description":"get the list of vehicles within an location radio","security":[{"BearerAuth":["administrador","funcionario"]}],"parameters":[{"in":"path","name":"lat","description":"GPS latitude","required":true,"schema":{"type":"number"}},{"in":"path","name":"long","description":"GPS longitude","required":true,"schema":{"type":"number"}},{"in":"query","name":"raio","description":"raio","required":true,"schema":{"type":"number"}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Veiculo"}}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden. UnauthorizedError"},"404":{"description":"Not found"}},"summary":"gets the vehicle with matching id"}},"/veiculos/{id}":{"get":{"operationId":"obtem_um_veiculo","description":"get an vehicle from its vehicle id","security":[{"BearerAuth":["administrador","funcionario"]}],"parameters":[{"in":"path","name":"id","description":"id of the registered vehicle","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"object","items":{"$ref":"#/components/schemas/Veiculo"}}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden. UnauthorizedError"},"404":{"description":"Not found"}},"summary":"gets the vehicle with matching id"},"put":{"summary":"updates an vehicle","operationId":"alterar_um_veiculo","description":"Updates vehicle info","security":[{"BearerAuth":["administrator"]}],"parameters":[{"in":"path","name":"id","description":"id of the registered vehicle to be updated","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"item updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Veiculo"}}}},"400":{"description":"invalid input, object invalid"},"403":{"description":"Forbidden. UnauthorizedError"},"404":{"description":"Not found"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistoVeiculo"}}},"description":"New vehicle data"}},"delete":{"description":"deletes an vehicle","operationId":"eliminar_um_veiculo","security":[{"BearerAuth":["administrator"]}],"parameters":[{"in":"path","name":"id","description":"id of the registered vehicle to be deleted","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"vehicle deleted"},"403":{"description":"Forbidden. UnauthorizedError"}}}},"/estacionamentos":{"get":{"operationId":"lista_todos_estacionamentos","description":"Lista todos os estacionamentos registados na base de dados","security":[{"BearerAuth":["administrador","funcionario"]}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Estacionamento"}}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden. UnauthorizedError"}},"summary":"gets all regestered parkings"},"post":{"summary":"register a new parking","operationId":"novo_estacionamento","description":"Adds a new parking to the system","responses":{"201":{"description":"parking created"},"400":{"description":"invalid input, object invalid"},"409":{"description":"an existing parking already exists"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistoEstacionamento"}}},"description":"New parking to be added"}}},"/estacionamentos/{matricula}":{"get":{"operationId":"obtem_um_estacionamento_por_codigo","description":"get an parking from its parking plate","security":[{"BearerAuth":["administrador","funcionario"]}],"parameters":[{"in":"path","name":"matricula","description":"identification plate of the registered parking","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"object","items":{"$ref":"#/components/schemas/Estacionamento"}}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden. UnauthorizedError"},"404":{"description":"Not found"}},"summary":"gets the parking with matching id"}},"/estacionamentos/{lat}/{long}":{"get":{"operationId":"obtem_um_estacionamento_por_localizacao","description":"get the list of parkings within an location radio","security":[{"BearerAuth":["administrador","funcionario"]}],"parameters":[{"in":"path","name":"lat","description":"GPS latitude","required":true,"schema":{"type":"number"}},{"in":"path","name":"long","description":"GPS longitude","required":true,"schema":{"type":"number"}},{"in":"query","name":"raio","description":"raio","required":true,"schema":{"type":"number"}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Estacionamento"}}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden. UnauthorizedError"},"404":{"description":"Not found"}},"summary":"gets the parking with matching id"}},"/estacionamentos/{id}":{"get":{"operationId":"obtem_um_estacionamento","description":"get an parking from its parking id","security":[{"BearerAuth":["administrador","funcionario"]}],"parameters":[{"in":"path","name":"id","description":"id of the registered parking","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"object","items":{"$ref":"#/components/schemas/Estacionamento"}}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden. UnauthorizedError"},"404":{"description":"Not found"}},"summary":"gets the parking with matching id"},"put":{"summary":"updates an parking","operationId":"alterar_um_estacionamento","description":"Updates parking info","security":[{"BearerAuth":["administrator"]}],"parameters":[{"in":"path","name":"id","description":"id of the registered parking to be updated","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"item updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Estacionamento"}}}},"400":{"description":"invalid input, object invalid"},"403":{"description":"Forbidden. UnauthorizedError"},"404":{"description":"Not found"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistoEstacionamento"}}},"description":"New parking data"}},"delete":{"description":"deletes an parking","operationId":"eliminar_um_estacionamento","security":[{"BearerAuth":["administrator"]}],"parameters":[{"in":"path","name":"id","description":"id of the registered parking to be deleted","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"parking deleted"},"403":{"description":"Forbidden. UnauthorizedError"}}}},"/minhasreservas":{"get":{"operationId":"lista_todas_reservas_por_utilizador","description":"Lista todas as reservas registadas na base de dados para o utilizador autenticado","security":[{"BearerAuth":["utilizador"]}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Reserva"}}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden. UnauthorizedError"}},"summary":"gets all regestered reservations"}},"/reservas":{"get":{"operationId":"lista_todas_reservas","description":"Lista todas as reservas registadas na base de dados","security":[{"BearerAuth":["administrador"]}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Reserva"}}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden. UnauthorizedError"}},"summary":"gets all regestered reservations"},"post":{"summary":"register a new reservation","operationId":"nova_reserva","description":"Adds a new reservation to the system","security":[{"BearerAuth":["utilizador"]}],"responses":{"201":{"description":"reservation created"},"400":{"description":"invalid input, object invalid"},"409":{"description":"an existing reservation already exists"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistoReserva"}}},"description":"New reservation to be added"}}},"/reservas/{id}/checkout":{"get":{"operationId":"checkout","description":"checkout the reservation","security":[{"BearerAuth":["administrador","utilizador"]}],"parameters":[{"in":"path","name":"id","description":"id of the registered reservation","required":true,"schema":{"type":"string"}}],"responses":{"203":{"description":"Checkout successful"},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden. UnauthorizedError"},"404":{"description":"Not found"}},"summary":"Do the checkou to the selected reservation"}},"/reservas/{id}/custoatual":{"get":{"operationId":"custoAtualAluguer","description":"gets the calculated cost for the reservation","security":[{"BearerAuth":["administrador","utilizador"]}],"parameters":[{"in":"path","name":"id","description":"id of the registered reservation","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"object","items":{"$ref":"#/components/schemas/CustoReserva"}}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden. UnauthorizedError"},"404":{"description":"Not found"}},"summary":"gets the current reservation cost"}},"/reservas/{id}":{"get":{"operationId":"obtem_um_reserva","description":"get an reservation from its reservation id","security":[{"BearerAuth":["administrador","utilizador"]}],"parameters":[{"in":"path","name":"id","description":"id of the registered reservation","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"object","items":{"$ref":"#/components/schemas/Reserva"}}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden. UnauthorizedError"},"404":{"description":"Not found"}},"summary":"gets the reservation with matching id"},"put":{"summary":"updates an reservation","operationId":"alterar_um_reserva","description":"Updates reservation info","security":[{"BearerAuth":["administrator"]}],"parameters":[{"in":"path","name":"id","description":"id of the registered reservation to be updated","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"item updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reserva"}}}},"400":{"description":"invalid input, object invalid"},"403":{"description":"Forbidden. UnauthorizedError"},"404":{"description":"Not found"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistoReserva"}}},"description":"New reservation data"}},"delete":{"description":"deletes an reservation","operationId":"eliminar_um_reserva","security":[{"BearerAuth":["administrator"]}],"parameters":[{"in":"path","name":"id","description":"id of the registered reservation to be deleted","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"reservation deleted"},"403":{"description":"Forbidden. UnauthorizedError"}}}}},"components":{"schemas":{"Utilizador":{"type":"object","required":["_id","nome","username","email","estadoRegisto","role"],"properties":{"_id":{"type":"object","format":"uuid","example":"5e077c144de4214f407d42c9"},"nome":{"type":"string","example":"Rui Rodrigues"},"username":{"type":"string","example":"a10212"},"email":{"type":"string","example":"a10212@alunos.ipca.pt"},"estadoRegisto":{"type":"array","items":{"type":"object","format":"string","example":"ativo"}},"role":{"type":"string","enum":["cliente","functionario","administrador"]},"manufacturer":{"$ref":"#/components/schemas/Utilizador"}}},"RegistoUtilizador":{"type":"object","required":["nome","username","email","role","dadosPassword"],"properties":{"nome":{"type":"string","example":"Rui Rodrigues"},"username":{"type":"string","example":"a10212"},"email":{"type":"string","example":"a10212@alunos.ipca.pt"},"role":{"type":"array","items":{"type":"object","format":"string","example":"administrador"}},"password":{"type":"string","example":"THE_PASSWORD"},"manufacturer":{"$ref":"#/components/schemas/RegistoUtilizador"}}},"Veiculo":{"type":"object","required":["_id","designacao","codigo","SOCBateria","localizacao"],"properties":{"_id":{"type":"object","format":"uuid","example":"5e077c144de4214f407d42c9"},"designacao":{"type":"string","example":"Trotinete"},"codigo":{"type":"string","example":"56-HA-00"},"SOCBateria":{"type":"number","example":85},"localizacao":{"$ref":"#/components/schemas/Coordinates"},"manufacturer":{"$ref":"#/components/schemas/Veiculo"}}},"RegistoVeiculo":{"type":"object","required":["designacao","codigo","SOCBateria","localizacao"],"properties":{"designacao":{"type":"string","example":"Trotinete"},"codigo":{"type":"string","example":"56-HA-00"},"SOCBateria":{"type":"number","example":85},"localizacao":{"$ref":"#/components/schemas/Coordinates"},"manufacturer":{"$ref":"#/components/schemas/RegistoVeiculo"}}},"Estacionamento":{"type":"object","required":["_id","nome","capacidade","localizacao"],"properties":{"_id":{"type":"object","format":"uuid","example":"5e077c144de4214f407d42c9"},"nome":{"type":"string","example":"IPCA"},"capacidade":{"type":"number","example":85},"localizacao":{"$ref":"#/components/schemas/Coordinates"},"manufacturer":{"$ref":"#/components/schemas/Estacionamento"}}},"RegistoEstacionamento":{"type":"object","required":["nome","capacidade","localizacao"],"properties":{"nome":{"type":"string","example":"IPCA"},"capacidade":{"type":"number","example":85},"localizacao":{"$ref":"#/components/schemas/Coordinates"},"manufacturer":{"$ref":"#/components/schemas/RegistoEstacionamento"}}},"Reserva":{"type":"object","required":["_id","dataCheckin","dataCheckout","codVeiculo","userId","metodoAluguer"],"properties":{"_id":{"type":"object","format":"uuid","example":"5e077c144de4214f407d42c9"},"dataCheckin":{"type":"string","example":"02/02/2020 08:50"},"dataCheckout":{"type":"string","example":"02/02/2020 09:50"},"codVeiculo":{"type":"string","example":"56-HA-00"},"userId":{"type":"object","format":"uuid","example":"5e077c144de4214f407d42c9"},"metodoAluguer":{"type":"string","enum":["minuto","hora","prePago1Hora","prePago2Horas","prePagoDia"],"default":["hora"]},"manufacturer":{"$ref":"#/components/schemas/Reserva"}}},"RegistoReserva":{"type":"object","required":["dataCheckin","dataCheckout","codVeiculo","metodoAluguer"],"properties":{"dataCheckin":{"type":"string","example":"02/02/2020 08:50"},"dataCheckout":{"type":"string","example":"02/02/2020 09:50"},"codVeiculo":{"type":"string","example":"56-HA-00"},"metodoAluguer":{"type":"string","enum":["minuto","hora","prePago1Hora","prePago2Horas","prePagoDia"],"default":["hora"]},"manufacturer":{"$ref":"#/components/schemas/RegistoReserva"}}},"CustoReserva":{"type":"object","required":["aluguerId","checkin","checkout","timeElapsed","metodoAluguer","custoAtualAluguer"],"properties":{"aluguerId":{"type":"object","format":"uuid","example":"5e077c144de4214f407d42c9"},"checkin":{"type":"string","example":"02/02/2020 08:50"},"checkout":{"type":"string","example":"02/02/2020 09:50"},"timeElapsed":{"type":"number","example":503},"metodoAluguer":{"type":"string","enum":["minuto","hora","prePago1Hora","prePago2Horas","prePagoDia"]},"custoAtualAluguer":{"type":"number","example":5.3},"manufacturer":{"$ref":"#/components/schemas/CustoReserva"}}},"Coordinates":{"type":"object","required":["lat","long"],"properties":{"lat":{"type":"number","example":41.536578},"long":{"type":"number","example":-8.627915},"manufacturer":{"$ref":"#/components/schemas/Coordinates"}}}}}}