Enunciate Spring Request param

Question

Я хотел бы документировать мой Spring API с Enuncate. Работает нормально, но в некоторых конечных точках есть параметры запроса. Они не будут задокументированы enunciate.

/**
 * Does some magic.
 *
 * @HTTP 201 Successful Request.
 */
@PostMapping(value = "/{id}", params = "action=doMagic")
@RolesAllowed("ADMIN")
public User restoreUser(@PathVariable Long id) {
    User user = userService.restore(id);
    return ResponseEntity.ok(project);
}

Документ enunciate документирует идентификатор как параметр, но не "действие" requestParameter. Как это можно решить?

Answer 1

Добавьте @param в javadoc

/**
 * Does some magic.
 * 
 * @param action description of this parameter
 * @param id and you can describe id here too
 * 
 * @HTTP 201 Successful Request.
 */