Add description for jobs and rest methods

This commit is contained in:
kashiuno 2025-03-20 22:04:44 +03:00
parent 4007e9d86d
commit 105508c67f
2 changed files with 13 additions and 2 deletions

View File

@ -15,4 +15,16 @@
## Сборка приложения
`gradle jar`
`gradle jar`
## Задания по расписанию
- EmailOutboxSendJob - задание формирования и отправки QR-кода
- CleanExpiredNotPayedRentJob - задание по расписанию для опроса платежного шлюза и удаления просроченных не оплаченных бронирований
## Http методы
- POST /public/book - метод бронирования двери
- POST /public/book/callback - метод для обратного вызова шлюза
- GET /qr - метод получения QR-кодов для определенного устройства(информация об устройстве берется из токена)
- POST /qr-used/{qrId} - метод пометки о том, что qr-код был использован(для сбора метрик)

View File

@ -11,7 +11,6 @@ import ru.vyatsu.qr_access_api.booking.request.BookResponse
@RestController
class BookingController(private val service: BookingService) {
// TODO: Убрать /public, так как эти методы должны быть закрыты авторизацией client_credential и корсами
// TODO: Для общего процесса бронирования нужно сделать альтернативный путь для шлюза с опросом.
@PostMapping("/public/book")
fun book(@RequestBody request: BookRequest): BookResponse {
return BookResponse(service.book(request))