ManifestReloadTaskController.kt
/*
Copyright (C) 2026 Sber
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
In any derivative products, you must retain the information of
owner of the original code and provide clear attribution to the project
https://dochub.info
The use of this product or its derivatives for any purpose cannot be a secret.
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Maintainers:
Alexander Romashin <romashin.a.va@sberbank.ru>, Sber - 2026
Contributors:
Alexander Romashin <romashin.a.va@sberbank.ru>, Sber - 2026
*/
package org.archtool.controller
import io.swagger.v3.oas.annotations.Operation
import io.swagger.v3.oas.annotations.Parameter
import io.swagger.v3.oas.annotations.media.Content
import io.swagger.v3.oas.annotations.media.Schema
import io.swagger.v3.oas.annotations.responses.ApiResponse
import io.swagger.v3.oas.annotations.responses.ApiResponses
import io.swagger.v3.oas.annotations.security.SecurityRequirement
import io.swagger.v3.oas.annotations.tags.Tag
import org.archtool.data.dto.TaskStatusResponseDto
import org.springframework.http.ResponseEntity
import org.springframework.web.bind.annotation.GetMapping
import org.springframework.web.bind.annotation.RequestMapping
import org.springframework.web.bind.annotation.RequestParam
@Tag(name = "Контроллер перезагрузки манифеста", description = "Отвечает за управление задачей перезагрузки манифестов на бэкендах портала SEAF")
@SecurityRequirement(name = "bearerAuth")
@RequestMapping("/tasks/reload")
interface ManifestReloadTaskController {
@Operation(
summary = "Запустить перезагрузку манифеста",
description = "Запускает асинхронный процесс перезагрузки манифеста для указанного бэкенда портала SEAF. " +
"Если процесс уже выполняется, возвращает текущий статус."
)
@ApiResponses(
value = [
ApiResponse(
responseCode = "200",
description = "Статус операции перезагрузки",
content = [Content(schema = Schema(implementation = TaskStatusResponseDto::class))]
)
]
)
@GetMapping("/manifest")
fun reload(
@Parameter(description = "Идентификатор бэкенда портала SEAF (ключ в конфигурации базовых URL бэкендов)")
@RequestParam("backend") backend: String,
@Parameter(description = "Секрет для авторизации запроса перезагрузки на стороне бэкенда, если требуется")
@RequestParam("secret") secret: String? = null,
@Parameter(description = "Признак необходимости перезагрузки корневого манифеста бэкенда")
@RequestParam("reloadRoot") reloadRoot: Boolean?,
@Parameter(description = "Режим перезагрузки манифеста на стороне бэкенда")
@RequestParam("mode") mode: String? = null,
@Parameter(description = "Список алиасов порталов, для которых требуется перезагрузка манифеста (при мультипортальной конфигурации)")
@RequestParam("alias") aliases: List<String>? = null
): ResponseEntity<TaskStatusResponseDto>
@Operation(
summary = "Получить статус перезагрузки манифеста",
description = "Возвращает текущий статус выполнения задачи перезагрузки манифеста по каждому бэкенду, " +
"известному из конфигурации базовых URL бэкендов (ключ ответа — идентификатор бэкенда)."
)
@ApiResponses(
value = [
ApiResponse(
responseCode = "200",
description = "Статус задачи перезагрузки манифеста по бэкендам"
)
]
)
@GetMapping("/status")
fun status(): ResponseEntity<Map<String, TaskStatusResponseDto>>
}