Add OpenAPI description
This commit is contained in:
@@ -3,8 +3,10 @@ package be.seeseepuff.pcinv.controllers;
|
|||||||
import be.seeseepuff.pcinv.meta.AssetDescriptor;
|
import be.seeseepuff.pcinv.meta.AssetDescriptor;
|
||||||
import be.seeseepuff.pcinv.models.Asset;
|
import be.seeseepuff.pcinv.models.Asset;
|
||||||
import be.seeseepuff.pcinv.services.AssetService;
|
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.Operation;
|
||||||
import io.swagger.v3.oas.annotations.Parameter;
|
import io.swagger.v3.oas.annotations.Parameter;
|
||||||
|
import io.swagger.v3.oas.annotations.info.Info;
|
||||||
import lombok.RequiredArgsConstructor;
|
import lombok.RequiredArgsConstructor;
|
||||||
import org.springframework.web.bind.annotation.*;
|
import org.springframework.web.bind.annotation.*;
|
||||||
|
|
||||||
@@ -13,6 +15,13 @@ import java.util.List;
|
|||||||
@RequiredArgsConstructor
|
@RequiredArgsConstructor
|
||||||
@RequestMapping("/api")
|
@RequestMapping("/api")
|
||||||
@RestController
|
@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 {
|
public class ApiController {
|
||||||
private final AssetService assetService;
|
private final AssetService assetService;
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user