You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openmeetings.apache.org by se...@apache.org on 2021/09/04 22:40:10 UTC
[openmeetings] 01/01: OPENMEETINGS-2660 Update specs generated so
that ordering in generated docs is defined.
This is an automated email from the ASF dual-hosted git repository.
sebawagner pushed a commit to branch feature/OPENMEETINGS-2660-fix-api-docs-generated-API-order
in repository https://gitbox.apache.org/repos/asf/openmeetings.git
commit 7ea970615ac128bc06afd4d55d034ca8f697dafe
Author: Sebastian Wagner <se...@gmail.com>
AuthorDate: Sun Sep 5 10:39:53 2021 +1200
OPENMEETINGS-2660 Update specs generated so that ordering in generated docs is defined.
---
openmeetings-webservice/pom.xml | 42 ++++++++++++++++++++++
.../webservice/CalendarWebService.java | 2 +-
.../openmeetings/webservice/ErrorWebService.java | 2 +-
.../openmeetings/webservice/FileWebService.java | 3 +-
.../openmeetings/webservice/GroupWebService.java | 3 +-
.../openmeetings/webservice/InfoWebService.java | 2 +-
.../openmeetings/webservice/NetTestWebService.java | 2 +-
.../webservice/RecordingWebService.java | 2 +-
.../openmeetings/webservice/RoomWebService.java | 2 +-
.../openmeetings/webservice/UserWebService.java | 3 +-
.../openmeetings/webservice/WbWebService.java | 2 +-
11 files changed, 52 insertions(+), 13 deletions(-)
diff --git a/openmeetings-webservice/pom.xml b/openmeetings-webservice/pom.xml
index 0c41b43..d9e94a0 100644
--- a/openmeetings-webservice/pom.xml
+++ b/openmeetings-webservice/pom.xml
@@ -81,6 +81,48 @@
<name>The Apache Software License, Version 2.0</name>
</license>
</info>
+ <tags>
+ <tag>
+ <name>UserService</name>
+ <description>The Service contains methods to login and create hash to directly enter conference rooms, recordings or the application in general</description>
+ </tag>
+ <tag>
+ <name>RoomService</name>
+ <description>RoomService contains methods to manipulate rooms and create invitation hash</description>
+ </tag>
+ <tag>
+ <name>FileService</name>
+ <description>Contains methods to import and upload files into the Files section of the conference room and the personal drive of any USER</description>
+ </tag>
+ <tag>
+ <name>WbService</name>
+ <description>WbService contains methods to manipulate whiteboard contents</description>
+ </tag>
+ <tag>
+ <name>CalendarService</name>
+ <description>CalendarService contains methods to create, edit delete calendar meetings</description>
+ </tag>
+ <tag>
+ <name>GroupService</name>
+ <description>The Service contains methods to login and create hash to directly enter conference rooms, recordings or the application in general</description>
+ </tag>
+ <tag>
+ <name>NetTestService</name>
+ <description>The Service contains methods to trigger a network test</description>
+ </tag>
+ <tag>
+ <name>RecordingService</name>
+ <description>The Service contains methods to work with recordings</description>
+ </tag>
+ <tag>
+ <name>InfoService</name>
+ <description>The Service contains methods to get info about the system</description>
+ </tag>
+ <tag>
+ <name>ErrorService</name>
+ <description>The Service contains methods to get localized errors</description>
+ </tag>
+ </tags>
<servers>
<server>
<description>Your local OpenMeetings Server</description>
diff --git a/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/CalendarWebService.java b/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/CalendarWebService.java
index f10cdac..e10b5f6 100644
--- a/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/CalendarWebService.java
+++ b/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/CalendarWebService.java
@@ -73,7 +73,7 @@ import io.swagger.v3.oas.annotations.tags.Tag;
@WebService(serviceName="org.apache.openmeetings.webservice.CalendarWebService", targetNamespace = TNS)
@Features(features = "org.apache.cxf.ext.logging.LoggingFeature")
@Produces({MediaType.APPLICATION_JSON})
-@Tag(name = "CalendarService", description = "CalendarService contains methods to create, edit delete calendar meetings")
+@Tag(name = "CalendarService")
@Path("/calendar")
public class CalendarWebService extends BaseWebService {
private static final Logger log = LoggerFactory.getLogger(CalendarWebService.class);
diff --git a/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/ErrorWebService.java b/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/ErrorWebService.java
index 6fc9f1a..849afc2 100644
--- a/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/ErrorWebService.java
+++ b/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/ErrorWebService.java
@@ -58,7 +58,7 @@ import io.swagger.v3.oas.annotations.tags.Tag;
@WebService(serviceName="org.apache.openmeetings.webservice.ErrorWebService", targetNamespace = TNS)
@Features(features = "org.apache.cxf.ext.logging.LoggingFeature")
@Produces({MediaType.APPLICATION_JSON})
-@Tag(name = "ErrorService", description = "The Service contains methods to get localized errors")
+@Tag(name = "ErrorService")
@Path("/error")
public class ErrorWebService extends BaseWebService {
private static final Logger log = LoggerFactory.getLogger(ErrorWebService.class);
diff --git a/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/FileWebService.java b/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/FileWebService.java
index 2a6755a..9f2bdea 100644
--- a/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/FileWebService.java
+++ b/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/FileWebService.java
@@ -77,8 +77,7 @@ import io.swagger.v3.oas.annotations.tags.Tag;
@WebService(serviceName="org.apache.openmeetings.webservice.FileWebService", targetNamespace = TNS)
@Features(features = "org.apache.cxf.ext.logging.LoggingFeature")
@Produces({MediaType.APPLICATION_JSON})
-@Tag(name = "FileService", description = "Contains methods to import and upload files into the Files section of the\n"
- + " conference room and the personal drive of any USER")
+@Tag(name = "FileService")
@Path("/file")
public class FileWebService extends BaseWebService {
private static final Logger log = LoggerFactory.getLogger(FileWebService.class);
diff --git a/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/GroupWebService.java b/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/GroupWebService.java
index 04a586c..19eb3b3 100644
--- a/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/GroupWebService.java
+++ b/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/GroupWebService.java
@@ -76,8 +76,7 @@ import io.swagger.v3.oas.annotations.tags.Tag;
@WebService(serviceName="org.apache.openmeetings.webservice.GroupWebService", targetNamespace = TNS)
@Features(features = "org.apache.cxf.ext.logging.LoggingFeature")
@Produces({MediaType.APPLICATION_JSON})
-@Tag(name = "GroupService", description = "The Service contains methods to login and create hash to directly enter\n"
- + " conference rooms, recordings or the application in general")
+@Tag(name = "GroupService")
@Path("/group")
public class GroupWebService extends BaseWebService {
private static final Logger log = LoggerFactory.getLogger(GroupWebService.class);
diff --git a/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/InfoWebService.java b/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/InfoWebService.java
index 918dc1c..4a5a7f9 100644
--- a/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/InfoWebService.java
+++ b/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/InfoWebService.java
@@ -49,7 +49,7 @@ import io.swagger.v3.oas.annotations.tags.Tag;
@WebService(serviceName="org.apache.openmeetings.webservice.InfoWebService", targetNamespace = TNS)
@Features(features = "org.apache.cxf.ext.logging.LoggingFeature")
@Produces({MediaType.APPLICATION_JSON})
-@Tag(name = "InfoService", description = "The Service contains methods to get info about the system")
+@Tag(name = "InfoService")
@Path("/info")
public class InfoWebService {
/**
diff --git a/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/NetTestWebService.java b/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/NetTestWebService.java
index a83839a..7a5ca8d 100644
--- a/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/NetTestWebService.java
+++ b/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/NetTestWebService.java
@@ -53,7 +53,7 @@ import io.swagger.v3.oas.annotations.tags.Tag;
*
*/
@Service("netTestWebService")
-@Tag(name = "NetTestService", description = "The Service contains methods to trigger a network test")
+@Tag(name = "NetTestService")
@Path("/networktest")
public class NetTestWebService {
private static final Logger log = LoggerFactory.getLogger(NetTestWebService.class);
diff --git a/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/RecordingWebService.java b/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/RecordingWebService.java
index 6a259de..3f5e90a 100644
--- a/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/RecordingWebService.java
+++ b/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/RecordingWebService.java
@@ -64,7 +64,7 @@ import io.swagger.v3.oas.annotations.tags.Tag;
@WebService(serviceName="org.apache.openmeetings.webservice.RecordingWebService", targetNamespace = TNS)
@Features(features = "org.apache.cxf.ext.logging.LoggingFeature")
@Produces({MediaType.APPLICATION_JSON})
-@Tag(name = "RecordingService", description = "The Service contains methods to work with recordings")
+@Tag(name = "RecordingService")
@Path("/record")
public class RecordingWebService extends BaseWebService {
private static final Logger log = LoggerFactory.getLogger(RecordingWebService.class);
diff --git a/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/RoomWebService.java b/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/RoomWebService.java
index cd629d8..6d9b9fe 100644
--- a/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/RoomWebService.java
+++ b/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/RoomWebService.java
@@ -82,7 +82,7 @@ import io.swagger.v3.oas.annotations.responses.ApiResponse;
@WebService(serviceName="org.apache.openmeetings.webservice.RoomWebService", targetNamespace = TNS)
@Features(features = "org.apache.cxf.ext.logging.LoggingFeature")
@Produces({MediaType.APPLICATION_JSON})
-@Tag(name = "RoomService", description = "RoomService contains methods to manipulate rooms and create invitation hash")
+@Tag(name = "RoomService")
@Path("/room")
public class RoomWebService extends BaseWebService {
private static final Logger log = LoggerFactory.getLogger(RoomWebService.class);
diff --git a/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/UserWebService.java b/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/UserWebService.java
index 1b279fa..0481a2c 100644
--- a/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/UserWebService.java
+++ b/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/UserWebService.java
@@ -92,8 +92,7 @@ import org.springframework.stereotype.Service;
@WebService(serviceName = USER_SERVICE_NAME, targetNamespace = TNS, portName = USER_SERVICE_PORT_NAME)
@Features(features = "org.apache.cxf.ext.logging.LoggingFeature")
@Produces({MediaType.APPLICATION_JSON})
-@Tag(name = "UserService", description = "The Service contains methods to login and create hash to directly enter\n"
- + " conference rooms, recordings or the application in general")
+@Tag(name = "UserService")
@Path("/user")
public class UserWebService extends BaseWebService {
private static final Logger log = LoggerFactory.getLogger(UserWebService.class);
diff --git a/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/WbWebService.java b/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/WbWebService.java
index 25333d0..d34ae39 100644
--- a/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/WbWebService.java
+++ b/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/WbWebService.java
@@ -82,7 +82,7 @@ import io.swagger.v3.oas.annotations.tags.Tag;
@WebService(serviceName="org.apache.openmeetings.webservice.WbWebService", targetNamespace = TNS)
@Features(features = "org.apache.cxf.ext.logging.LoggingFeature")
@Produces({MediaType.APPLICATION_JSON})
-@Tag(name = "WbService", description = "WbService contains methods to manipulate whiteboard contents")
+@Tag(name = "WbService")
@Path("/wb")
public class WbWebService extends BaseWebService {
private static final Logger log = LoggerFactory.getLogger(WbWebService.class);