From dc95044fbccf2c590f3a271642f431119846578b Mon Sep 17 00:00:00 2001 From: Athou Date: Fri, 29 Dec 2023 09:11:47 +0100 Subject: [PATCH] group swagger api definitions by endpoint --- .../main/java/com/commafeed/frontend/resource/AdminREST.java | 2 ++ .../main/java/com/commafeed/frontend/resource/CategoryREST.java | 2 ++ .../main/java/com/commafeed/frontend/resource/EntryREST.java | 2 ++ .../src/main/java/com/commafeed/frontend/resource/FeedREST.java | 2 ++ .../main/java/com/commafeed/frontend/resource/ServerREST.java | 2 ++ .../src/main/java/com/commafeed/frontend/resource/UserREST.java | 2 ++ .../java/com/commafeed/frontend/resource/fever/FeverREST.java | 2 ++ 7 files changed, 14 insertions(+) diff --git a/commafeed-server/src/main/java/com/commafeed/frontend/resource/AdminREST.java b/commafeed-server/src/main/java/com/commafeed/frontend/resource/AdminREST.java index 1e446f88..1eccadb7 100644 --- a/commafeed-server/src/main/java/com/commafeed/frontend/resource/AdminREST.java +++ b/commafeed-server/src/main/java/com/commafeed/frontend/resource/AdminREST.java @@ -32,6 +32,7 @@ import io.swagger.v3.oas.annotations.media.ArraySchema; 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.tags.Tag; import jakarta.inject.Inject; import jakarta.inject.Singleton; import jakarta.ws.rs.Consumes; @@ -50,6 +51,7 @@ import lombok.RequiredArgsConstructor; @Consumes(MediaType.APPLICATION_JSON) @RequiredArgsConstructor(onConstructor = @__({ @Inject })) @Singleton +@Tag(name = "Admin") public class AdminREST { private final UserDAO userDAO; diff --git a/commafeed-server/src/main/java/com/commafeed/frontend/resource/CategoryREST.java b/commafeed-server/src/main/java/com/commafeed/frontend/resource/CategoryREST.java index c20b70ea..aabe6d86 100644 --- a/commafeed-server/src/main/java/com/commafeed/frontend/resource/CategoryREST.java +++ b/commafeed-server/src/main/java/com/commafeed/frontend/resource/CategoryREST.java @@ -53,6 +53,7 @@ import io.swagger.v3.oas.annotations.media.ArraySchema; 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.tags.Tag; import jakarta.inject.Inject; import jakarta.inject.Singleton; import jakarta.validation.Valid; @@ -75,6 +76,7 @@ import lombok.extern.slf4j.Slf4j; @Consumes(MediaType.APPLICATION_JSON) @RequiredArgsConstructor(onConstructor = @__({ @Inject })) @Singleton +@Tag(name = "Feed categories") public class CategoryREST { public static final String ALL = "all"; diff --git a/commafeed-server/src/main/java/com/commafeed/frontend/resource/EntryREST.java b/commafeed-server/src/main/java/com/commafeed/frontend/resource/EntryREST.java index b9f2e0b8..7de964ce 100644 --- a/commafeed-server/src/main/java/com/commafeed/frontend/resource/EntryREST.java +++ b/commafeed-server/src/main/java/com/commafeed/frontend/resource/EntryREST.java @@ -17,6 +17,7 @@ import com.google.common.base.Preconditions; import io.dropwizard.hibernate.UnitOfWork; import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.Parameter; +import io.swagger.v3.oas.annotations.tags.Tag; import jakarta.inject.Inject; import jakarta.inject.Singleton; import jakarta.validation.Valid; @@ -34,6 +35,7 @@ import lombok.RequiredArgsConstructor; @Consumes(MediaType.APPLICATION_JSON) @RequiredArgsConstructor(onConstructor = @__({ @Inject })) @Singleton +@Tag(name = "Feed entries") public class EntryREST { private final FeedEntryTagDAO feedEntryTagDAO; diff --git a/commafeed-server/src/main/java/com/commafeed/frontend/resource/FeedREST.java b/commafeed-server/src/main/java/com/commafeed/frontend/resource/FeedREST.java index b70693fa..10b15e48 100644 --- a/commafeed-server/src/main/java/com/commafeed/frontend/resource/FeedREST.java +++ b/commafeed-server/src/main/java/com/commafeed/frontend/resource/FeedREST.java @@ -69,6 +69,7 @@ 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.tags.Tag; import jakarta.inject.Inject; import jakarta.inject.Singleton; import jakarta.validation.Valid; @@ -95,6 +96,7 @@ import lombok.extern.slf4j.Slf4j; @Consumes(MediaType.APPLICATION_JSON) @RequiredArgsConstructor(onConstructor = @__({ @Inject })) @Singleton +@Tag(name = "Feeds") public class FeedREST { private static final FeedEntry TEST_ENTRY = initTestEntry(); diff --git a/commafeed-server/src/main/java/com/commafeed/frontend/resource/ServerREST.java b/commafeed-server/src/main/java/com/commafeed/frontend/resource/ServerREST.java index 7847f155..eb213f50 100644 --- a/commafeed-server/src/main/java/com/commafeed/frontend/resource/ServerREST.java +++ b/commafeed-server/src/main/java/com/commafeed/frontend/resource/ServerREST.java @@ -17,6 +17,7 @@ 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.tags.Tag; import jakarta.inject.Inject; import jakarta.inject.Singleton; import jakarta.ws.rs.Consumes; @@ -34,6 +35,7 @@ import lombok.RequiredArgsConstructor; @Consumes(MediaType.APPLICATION_JSON) @RequiredArgsConstructor(onConstructor = @__({ @Inject })) @Singleton +@Tag(name = "Server") public class ServerREST { private final HttpGetter httpGetter; diff --git a/commafeed-server/src/main/java/com/commafeed/frontend/resource/UserREST.java b/commafeed-server/src/main/java/com/commafeed/frontend/resource/UserREST.java index df3c0280..87fc554b 100644 --- a/commafeed-server/src/main/java/com/commafeed/frontend/resource/UserREST.java +++ b/commafeed-server/src/main/java/com/commafeed/frontend/resource/UserREST.java @@ -43,6 +43,7 @@ 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.tags.Tag; import jakarta.inject.Inject; import jakarta.inject.Singleton; import jakarta.validation.Valid; @@ -66,6 +67,7 @@ import lombok.extern.slf4j.Slf4j; @Slf4j @RequiredArgsConstructor(onConstructor = @__({ @Inject })) @Singleton +@Tag(name = "Users") public class UserREST { private final UserDAO userDAO; diff --git a/commafeed-server/src/main/java/com/commafeed/frontend/resource/fever/FeverREST.java b/commafeed-server/src/main/java/com/commafeed/frontend/resource/fever/FeverREST.java index 4b3189ef..0eb64fed 100644 --- a/commafeed-server/src/main/java/com/commafeed/frontend/resource/fever/FeverREST.java +++ b/commafeed-server/src/main/java/com/commafeed/frontend/resource/fever/FeverREST.java @@ -39,6 +39,7 @@ import com.commafeed.frontend.resource.fever.FeverResponse.FeverGroup; import com.commafeed.frontend.resource.fever.FeverResponse.FeverItem; import io.dropwizard.hibernate.UnitOfWork; +import io.swagger.v3.oas.annotations.Hidden; import jakarta.inject.Inject; import jakarta.inject.Singleton; import jakarta.ws.rs.Consumes; @@ -68,6 +69,7 @@ import lombok.RequiredArgsConstructor; @Produces(MediaType.APPLICATION_JSON) @RequiredArgsConstructor(onConstructor = @__({ @Inject })) @Singleton +@Hidden public class FeverREST { private static final String PATH = "/user/{userId}{optionalTrailingFever : (/fever)?}{optionalTrailingSlash : (/)?}";