From d702544f2cd0a361fbfcf25d3b5f6f7a6c6632d9 Mon Sep 17 00:00:00 2001 From: Sebastiaan de Schaetzen Date: Tue, 10 Jun 2025 10:05:47 +0200 Subject: [PATCH] Add OpenAPI description --- .../be/seeseepuff/pcinv/controllers/ApiController.java | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/main/java/be/seeseepuff/pcinv/controllers/ApiController.java b/src/main/java/be/seeseepuff/pcinv/controllers/ApiController.java index 63907de..60a0619 100644 --- a/src/main/java/be/seeseepuff/pcinv/controllers/ApiController.java +++ b/src/main/java/be/seeseepuff/pcinv/controllers/ApiController.java @@ -3,8 +3,10 @@ package be.seeseepuff.pcinv.controllers; import be.seeseepuff.pcinv.meta.AssetDescriptor; import be.seeseepuff.pcinv.models.Asset; import be.seeseepuff.pcinv.services.AssetService; +import io.swagger.v3.oas.annotations.OpenAPIDefinition; import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.Parameter; +import io.swagger.v3.oas.annotations.info.Info; import lombok.RequiredArgsConstructor; import org.springframework.web.bind.annotation.*; @@ -13,6 +15,13 @@ import java.util.List; @RequiredArgsConstructor @RequestMapping("/api") @RestController +@OpenAPIDefinition( + info = @Info( + title = "PC Inventory API", + version = "1.0", + description = "API for managing PC inventory assets. Assets are identified by QR or ID codes." + ) +) public class ApiController { private final AssetService assetService;