Не подтверждена Коммит 8df6745f создал по автору Vitaly.Smirnov's avatar Vitaly.Smirnov Зафиксировано автором GitHub
Просмотр файлов

docs: Update Swagger documentation with latest API changes

владелец 4a95bf88
Скрыть пробелы
Построчно Рядом
backend/app/src/main/resources/application.yml
Просмотр файла @ 8df6745f
server: server:
port: 8080 port: 8080
address: 0.0.0.0 address: 0.0.0.0
forward-headers-strategy: FRAMEWORK
servlet: servlet:
context-path: /api context-path: /api
......
backend/feature/booking/core/src/main/kotlin/band/effective/office/backend/feature/booking/core/controller/BookingController.kt
Просмотр файла @ 8df6745f
...@@ -99,9 +99,9 @@ class BookingController( ...@@ -99,9 +99,9 @@ class BookingController(
@RequestParam(required = false) userId: String?, @RequestParam(required = false) userId: String?,
@Parameter(description = "Filter by workspace ID") @Parameter(description = "Filter by workspace ID")
@RequestParam(required = false) workspaceId: String?, @RequestParam(required = false) workspaceId: String?,
@Parameter(description = "Start of the time range in milliseconds since epoch", example = "1672531200000") @Parameter(description = "Start of the time range in milliseconds since epoch", example = "1755734400000")
@RequestParam(required = false) from: Long? = null, @RequestParam(required = false) from: Long? = null,
@Parameter(description = "End of the time range in milliseconds since epoch", example = "1675209599000") @Parameter(description = "End of the time range in milliseconds since epoch", example = "1761091199000")
@RequestParam(required = false) to: Long? = null, @RequestParam(required = false) to: Long? = null,
@Parameter(description = "Whether to return recurring bookings as non-recurrent instances", example = "true") @Parameter(description = "Whether to return recurring bookings as non-recurrent instances", example = "true")
@RequestParam(required = false, defaultValue = "true") returnInstances: Boolean @RequestParam(required = false, defaultValue = "true") returnInstances: Boolean
......
backend/feature/booking/core/src/main/kotlin/band/effective/office/backend/feature/booking/core/dto/BookingDto.kt
Просмотр файла @ 8df6745f
...@@ -31,10 +31,10 @@ data class BookingDto( ...@@ -31,10 +31,10 @@ data class BookingDto(
@Schema(description = "Booking ID", example = "123e4567-e89b-12d3-a456-426614174000") @Schema(description = "Booking ID", example = "123e4567-e89b-12d3-a456-426614174000")
val id: String, val id: String,
@Schema(description = "Start time of the booking in milliseconds since epoch", example = "1672531200000") @Schema(description = "Start time of the booking in milliseconds since epoch", example = "1755734400000")
val beginBooking: Long, val beginBooking: Long,
@Schema(description = "End time of the booking in milliseconds since epoch", example = "1672534800000") @Schema(description = "End time of the booking in milliseconds since epoch", example = "1761091199000")
val endBooking: Long, val endBooking: Long,
@Schema(description = "Recurrence pattern for the booking") @Schema(description = "Recurrence pattern for the booking")
......
backend/feature/booking/core/src/main/kotlin/band/effective/office/backend/feature/booking/core/dto/CreateUpdateBookingDto.kt
Просмотр файла @ 8df6745f
...@@ -24,15 +24,15 @@ data class CreateBookingDto( ...@@ -24,15 +24,15 @@ data class CreateBookingDto(
val workspaceId: String, val workspaceId: String,
@field:NotNull(message = "Begin booking time is required") @field:NotNull(message = "Begin booking time is required")
@Schema(description = "Start time of the booking in milliseconds since epoch", example = "1672531200000") @Schema(description = "Start time of the booking in milliseconds since epoch", example = "1755823500000")
val beginBooking: Long, val beginBooking: Long,
@field:NotNull(message = "End booking time is required") @field:NotNull(message = "End booking time is required")
@Schema(description = "End time of the booking in milliseconds since epoch", example = "1672534800000") @Schema(description = "End time of the booking in milliseconds since epoch", example = "1758499500000")
val endBooking: Long, val endBooking: Long,
@Valid @Valid
@Schema(description = "Recurrence pattern for the booking") @Schema(description = "Recurrence pattern for the booking", example = "null")
val recurrence: RecurrenceDto? = null val recurrence: RecurrenceDto? = null
) { ) {
/** /**
...@@ -71,14 +71,14 @@ data class UpdateBookingDto( ...@@ -71,14 +71,14 @@ data class UpdateBookingDto(
@Schema(description = "Emails of users participating in the booking", example = "[\"jane.doe@example.com\"]") @Schema(description = "Emails of users participating in the booking", example = "[\"jane.doe@example.com\"]")
val participantEmails: List<String> = emptyList(), val participantEmails: List<String> = emptyList(),
@Schema(description = "Start time of the booking in milliseconds since epoch", example = "1672531200000") @Schema(description = "Start time of the booking in milliseconds since epoch", example = "1755734400000")
val beginBooking: Long? = null, val beginBooking: Long? = null,
@Schema(description = "End time of the booking in milliseconds since epoch", example = "1672534800000") @Schema(description = "End time of the booking in milliseconds since epoch", example = "1756734400000")
val endBooking: Long? = null, val endBooking: Long? = null,
@Valid @Valid
@Schema(description = "Recurrence pattern for the booking") @Schema(description = "Recurrence pattern for the booking", example = "null")
val recurrence: RecurrenceDto? = null val recurrence: RecurrenceDto? = null
) { ) {
/** /**
......
backend/feature/workspace/src/main/kotlin/band/effective/office/backend/feature/workspace/core/controller/WorkspaceController.kt
Просмотр файла @ 8df6745f
...@@ -76,10 +76,10 @@ class WorkspaceController( ...@@ -76,10 +76,10 @@ class WorkspaceController(
@Parameter(description = "Workspace tag", required = true, example = "meeting") @Parameter(description = "Workspace tag", required = true, example = "meeting")
@RequestParam(name = "workspace_tag") tag: String, @RequestParam(name = "workspace_tag") tag: String,
@Parameter(description = "Start of the time range for workspaces with bookings", example = "1751565600000") @Parameter(description = "Start of the time range for workspaces with bookings", example = "1755734400000")
@RequestParam(name = "with_bookings_from", required = false) withBookingsFrom: Long?, @RequestParam(name = "with_bookings_from", required = false) withBookingsFrom: Long?,
@Parameter(description = "End of the time range for workspaces with bookings", example = "1752824530612") @Parameter(description = "End of the time range for workspaces with bookings", example = "1761091199000")
@RequestParam(name = "with_bookings_until", required = false) withBookingsUntil: Long? @RequestParam(name = "with_bookings_until", required = false) withBookingsUntil: Long?
): ResponseEntity<List<WorkspaceDTO>> { ): ResponseEntity<List<WorkspaceDTO>> {
val workspaces = workspaceService.findAllByTag(tag) val workspaces = workspaceService.findAllByTag(tag)
......
Поддерживает Markdown
0% или .
You are about to add 0 people to the discussion. Proceed with caution.
Сначала завершите редактирование этого сообщения!
Пожалуйста, зарегистрируйтесь или чтобы прокомментировать