docs: Fix references

pull/1/head
Lunix-420 2024-11-08 10:19:49 +01:00
parent 93a01cb462
commit 607208bdd9
4 changed files with 32 additions and 29 deletions

View File

@ -16,7 +16,6 @@ import com.maradona.backend.dto.SkillPrototype;
import com.maradona.backend.entities.Employee;
import com.maradona.backend.entities.SecondarySkill;
import com.maradona.backend.services.EmployeeService;
import com.maradona.backend.services.SecondarySkillService;
/**
* Controller for handling employee related requests.
@ -30,8 +29,7 @@ import com.maradona.backend.services.SecondarySkillService;
* - PUT /api/employee/skill/level
* - DELETE /api/employee/skill
*
* @see EmployeeService
* @see SecondarySkillService
* @see com.maradona.backend.entities.Employee
*/
@Controller
@RequestMapping("/api/employee")
@ -49,7 +47,7 @@ public class EmployeeController {
*
* @param id The ID of the requested employee.
* @param model The model with the requested data.
* @see Employee
* @see com.maradona.backend.entities.Employee
*/
@GetMapping({ "/", "" })
public ResponseEntity<Employee> get(@RequestParam Long id) {
@ -62,7 +60,7 @@ public class EmployeeController {
* Returns all employees from the database.
*
* @param model The model with the requested data.
* @see Employee
* @see com.maradona.backend.entities.Employee
*/
@GetMapping("/all")
public ResponseEntity<Iterable<Employee>> getAll() {
@ -75,7 +73,8 @@ public class EmployeeController {
* @param skillId ID of the secondary skill
* @param level Level of the secondary skill
* @return list of employees
* @see Employee
* @see com.maradona.backend.entities.Employee
* @see com.maradona.backend.entities.SecondarySkill
*/
@GetMapping("/from-skill")
public ResponseEntity<Iterable<Employee>> getFromSkill(@RequestParam Long skillId, @RequestParam Integer level) {
@ -87,7 +86,9 @@ public class EmployeeController {
*
* @param skillPrototype The skillPrototype object containing the secondary
* skill ID and level
* @see SkillPrototype
* @see com.maradona.backend.entities.Employee
* @see com.maradona.backend.entities.SecondarySkill
* @see com.maradona.backend.dto.SkillPrototype
*/
@PostMapping("/skill/protoype")
public ResponseEntity<Void> postSkillProtoype(@RequestBody SkillPrototype skillPrototype) {
@ -100,7 +101,9 @@ public class EmployeeController {
*
* @param skillId ID of the secondary skill
* @param level Level of the secondary skill
* @see SecondarySkill
* @see com.maradona.backend.entities.Employee
* @see com.maradona.backend.entities.SecondarySkill
* @see com.maradona.backend.entities.EmployeeSkill
*/
@PutMapping("/skill/level")
public ResponseEntity<Void> putSkillLevel(@RequestParam Long skillId, @RequestParam Integer level) {

View File

@ -27,7 +27,7 @@ import com.maradona.backend.services.SecondarySkillService;
* - PUT /api/primary-skill
* - DELETE /api/primary-skill
*
* @see PrimarySkill
* @see com.maradona.backend.entities.PrimarySkill
*/
@RestController
@RequestMapping("/api/primary-skill")
@ -44,7 +44,7 @@ public class PrimarySkillController {
*
* @param id The ID of the requested primary skill.
* @return The primary skill with the requested ID.
* @see PrimarySkill
* @see com.maradona.backend.entities.PrimarySkill
*/
@GetMapping({ "/", "" })
public ResponseEntity<PrimarySkill> get(@RequestParam Long id) {
@ -57,7 +57,7 @@ public class PrimarySkillController {
* Returns all primary skills from the database.
*
* @return A list of all primary skills.
* @see PrimarySkill
* @see com.maradona.backend.entities.PrimarySkill
*/
@GetMapping("/all")
public ResponseEntity<Iterable<PrimarySkill>> getAll() {
@ -69,7 +69,7 @@ public class PrimarySkillController {
*
* @param primarySkill The primary skill to be added.
* @return The added primary skill.
* @see PrimarySkill
* @see com.maradona.backend.entities.PrimarySkill
*/
@PostMapping({ "/", "" })
public ResponseEntity<PrimarySkill> post(@RequestBody PrimarySkill primarySkill) {
@ -82,7 +82,7 @@ public class PrimarySkillController {
*
* @param primarySkill The primary skill to be updated.
* @return The updated primary skill.
* @see PrimarySkill
* @see com.maradona.backend.entities.PrimarySkill
*/
@PutMapping({ "/", "" })
public ResponseEntity<PrimarySkill> put(@RequestBody PrimarySkill primarySkill) {

View File

@ -29,8 +29,7 @@ import com.maradona.backend.services.ProjectService;
* - DELETE /api/project
*
* @warning The ProjectService is not accounting for the user yet.
* @see Project
* @see ProjectService
* @see com.maradona.backend.entities.Project
*/
@Controller
@RequestMapping("/api/project")
@ -52,7 +51,7 @@ public class ProjectController {
*
* @param id The ID of the requested project.
* @param model The model with the requested data.
* @see Project
* @see com.maradona.backend.entities.Project
*/
@GetMapping({ "/", "" })
public ResponseEntity<Project> get(@RequestParam Long id) {
@ -64,7 +63,7 @@ public class ProjectController {
* Returns all projects from the database.
*
* @param model The model with the requested data.
* @see Project
* @see com.maradona.backend.entities.Project
*/
@GetMapping("/all")
public ResponseEntity<Iterable<Project>> getAll() {
@ -77,7 +76,7 @@ public class ProjectController {
*
* @param project
* @param model
* @see Project
* @see com.maradona.backend.entities.Project
*/
@GetMapping("/from-user")
public ResponseEntity<Iterable<Project>> getFromUser(@RequestParam Long userId) {
@ -88,7 +87,7 @@ public class ProjectController {
* Creates a new project in the database.
*
* @param project The project to be created.
* @see Project
* @see com.maradona.backend.entities.Project
*/
@PostMapping({ "/", "" })
public ResponseEntity<Project> post(@RequestBody Project project) {
@ -100,7 +99,7 @@ public class ProjectController {
* Updates an existing project in the database.
*
* @param project The project to be updated.
* @see Project
* @see com.maradona.backend.entities.Project
*/
@PutMapping({ "/", "" })
public ResponseEntity<Project> put(@RequestBody Project project) {
@ -112,6 +111,7 @@ public class ProjectController {
* Deletes a project from the database.
*
* @param id The ID of the project to be deleted.
* @see com.maradona.backend.entities.Project
*/
@DeleteMapping({ "/", "" })
public ResponseEntity<Void> delete(@RequestParam Long id) {

View File

@ -15,7 +15,6 @@ import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import com.maradona.backend.entities.SecondarySkill;
import com.maradona.backend.entities.PrimarySkill;
import com.maradona.backend.services.SecondarySkillService;
/**
@ -29,7 +28,7 @@ import com.maradona.backend.services.SecondarySkillService;
* - PUT /api/secondary-skill
* - DELETE /api/secondary-skill
*
* @see SecondarySkill
* @see com.maradona.backend.entities.SecondarySkill
*/
@Controller
@RequestMapping("/api/secondary-skill")
@ -51,7 +50,7 @@ public class SecondarySkillController {
*
* @param id The ID of the requested secondary skill.
* @param model The model with the requested data.
* @see SecondarySkill
* @see com.maradona.backend.entities.SecondarySkill
*/
@GetMapping({ "/", "" })
public ResponseEntity<SecondarySkill> get(@RequestParam Long id) {
@ -63,7 +62,7 @@ public class SecondarySkillController {
* Returns all secondary skills from the database.
*
* @param model The model with the requested data.
* @see SecondarySkill
* @see com.maradona.backend.entities.SecondarySkill
*/
@GetMapping("/all")
public ResponseEntity<Iterable<SecondarySkill>> getAll() {
@ -75,8 +74,8 @@ public class SecondarySkillController {
*
* @param primarySkillId ID of the primary skill
* @return list of secondary skills
* @see SecondarySkill
* @see PrimarySkill
* @see com.maradona.backend.entities.SecondarySkill
* @see com.maradona.backend.entities.PrimarySkill
*/
@GetMapping("/from-primary-skill")
public ResponseEntity<Iterable<SecondarySkill>> getSecondarySkills(@RequestParam Long primarySkillId) {
@ -88,8 +87,8 @@ public class SecondarySkillController {
* If the associated primary skill does not exist, it will be created.
*
* @param secondarySkill The secondary skill to be saved
* @see SecondarySkill
* @see PrimarySkill
* @see com.maradona.backend.entities.SecondarySkill
* @see com.maradona.backend.entities.PrimarySkill
*/
@PostMapping({ "/", "" })
public ResponseEntity<SecondarySkill> post(@RequestBody SecondarySkill secondarySkill) {
@ -101,7 +100,7 @@ public class SecondarySkillController {
* Modifies an existing secondary skill in the database.
*
* @param secondarySkill The secondary skill to be modified
* @see SecondarySkill
* @see com.maradona.backend.entities.SecondarySkill
*/
@PutMapping({ "/", "" })
public ResponseEntity<SecondarySkill> put(@RequestBody SecondarySkill secondarySkill) {
@ -113,6 +112,7 @@ public class SecondarySkillController {
* Deletes a specific secondary skill from the database.
*
* @param id The ID of the secondary skill to be deleted
* @see com.maradona.backend.entities.SecondarySkill
*/
@DeleteMapping({ "/", "" })
public ResponseEntity<Void> delete(@RequestParam Long id) {