You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openmeetings.apache.org by so...@apache.org on 2026/04/06 11:40:07 UTC
(openmeetings-site) branch master updated: Swagger generated JSON is added
This is an automated email from the ASF dual-hosted git repository.
solomax pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/openmeetings-site.git
The following commit(s) were added to refs/heads/master by this push:
new a84e179d Swagger generated JSON is added
a84e179d is described below
commit a84e179de2fa30bfb6f5afd306eda58cc24cb22b
Author: Maxim Solodovnik <so...@apache.org>
AuthorDate: Mon Apr 6 18:39:57 2026 +0700
Swagger generated JSON is added
---
...json => apache-openmeetings-9.0.0-swagger.json} | 2213 ++++++++++----------
swagger/index.html | 2 +-
2 files changed, 1083 insertions(+), 1132 deletions(-)
diff --git a/swagger/apache-openmeetings-7.2.0-swagger.json b/swagger/apache-openmeetings-9.0.0-swagger.json
similarity index 96%
rename from swagger/apache-openmeetings-7.2.0-swagger.json
rename to swagger/apache-openmeetings-9.0.0-swagger.json
index fae0a26d..6a6647ea 100644
--- a/swagger/apache-openmeetings-7.2.0-swagger.json
+++ b/swagger/apache-openmeetings-9.0.0-swagger.json
@@ -1,63 +1,11 @@
{
"openapi" : "3.0.1",
- "info" : {
- "title" : "Apache OpenMeetings API",
- "description" : "Integration API enables to connect to an OpenMeetings instance, eg for generating users, create links to directly access conference rooms.<br/><br/>\n\t\t\t\t\t\t\t\t<b>It is mainly designed for Server2Server integration, for example to integrate into your website, CMS or 3rd party application</b><br/><br/>\n\t\t\t\t\t\t\t\tFor examples how to use the Rest API see <a href=\"https://openmeetings.apache.org/RestAPISample.html\" target=\"_BLANK\">https://openmeetings.ap [...]
- "contact" : {
- "name" : "Apache OpenMeetings Rest Examples and Documentation",
- "url" : "https://openmeetings.apache.org/RestAPISample.html",
- "email" : "dev@openmeetings.apache.org"
- },
- "license" : {
- "name" : "The Apache Software License, Version 2.0",
- "url" : "https://www.apache.org/licenses/LICENSE-2.0"
- },
- "version" : "7.2.0"
- },
- "servers" : [ {
- "url" : "http://localhost:5080/openmeetings/services",
- "description" : "Your local OpenMeetings Server"
- }, {
- "url" : "https://om.alteametasoft.com/openmeetings/services",
- "description" : "Om Demo Server"
- } ],
- "tags" : [ {
- "name" : "UserService",
- "description" : "The Service contains methods to login and create hash to directly enter conference rooms, recordings or the application in general"
- }, {
- "name" : "RoomService",
- "description" : "RoomService contains methods to manipulate rooms and create invitation hash"
- }, {
- "name" : "FileService",
- "description" : "Contains methods to import and upload files into the Files section of the conference room and the personal drive of any USER"
- }, {
- "name" : "WbService",
- "description" : "WbService contains methods to manipulate whiteboard contents"
- }, {
- "name" : "CalendarService",
- "description" : "CalendarService contains methods to create, edit delete calendar meetings"
- }, {
- "name" : "GroupService",
- "description" : "The Service contains methods to login and create hash to directly enter conference rooms, recordings or the application in general"
- }, {
- "name" : "NetTestService",
- "description" : "The Service contains methods to trigger a network test"
- }, {
- "name" : "RecordingService",
- "description" : "The Service contains methods to work with recordings"
- }, {
- "name" : "InfoService",
- "description" : "The Service contains methods to get info about the system"
- }, {
- "name" : "ErrorService",
- "description" : "The Service contains methods to get localized errors"
- } ],
"paths" : {
- "/calendar" : {
- "post" : {
+ "/calendar/{id}" : {
+ "delete" : {
"tags" : [ "CalendarService" ],
- "description" : "Create an appointment",
- "operationId" : "save",
+ "description" : "Delete a calendar event\n\n If the given sid is from an Administrator or Web-Service USER, the USER\n can delete any appointment.\n If the sid is assigned to a regular USER, he can only delete appointments\n where he is also the owner/creator of the appointment",
+ "operationId" : "delete",
"parameters" : [ {
"name" : "sid",
"in" : "query",
@@ -66,60 +14,23 @@
"schema" : {
"type" : "string"
}
- } ],
- "requestBody" : {
- "content" : {
- "*/*" : {
- "schema" : {
- "required" : [ "appointment" ],
- "type" : "object",
- "properties" : {
- "appointment" : {
- "$ref" : "#/components/schemas/AppointmentDTO"
- }
- }
- }
- }
- }
- },
- "responses" : {
- "200" : {
- "description" : "appointment saved",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/AppointmentDTOWrapper"
- }
- }
- }
- },
- "500" : {
- "description" : "Error in case of invalid credentials or server error"
- }
- }
- }
- },
- "/calendar/next" : {
- "get" : {
- "tags" : [ "CalendarService" ],
- "description" : "Get the next Calendar event for the current USER of the SID",
- "operationId" : "next",
- "parameters" : [ {
- "name" : "sid",
- "in" : "query",
- "description" : "The SID of the User. This SID must be marked as Loggedin",
+ }, {
+ "name" : "id",
+ "in" : "path",
+ "description" : "the id to delete",
"required" : true,
"schema" : {
- "type" : "string"
+ "type" : "integer",
+ "format" : "int64"
}
} ],
"responses" : {
"200" : {
- "description" : "next Calendar event",
+ "description" : "ServiceResult with result type",
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/AppointmentDTOWrapper"
+ "$ref" : "#/components/schemas/ServiceResultWrapper"
}
}
}
@@ -130,11 +41,11 @@
}
}
},
- "/calendar/next/{userid}" : {
+ "/calendar/room/{roomid}" : {
"get" : {
"tags" : [ "CalendarService" ],
- "description" : "Get the next Calendar event for userId",
- "operationId" : "nextForUser",
+ "description" : "Load a calendar event by its room id",
+ "operationId" : "getByRoom",
"parameters" : [ {
"name" : "sid",
"in" : "query",
@@ -144,9 +55,9 @@
"type" : "string"
}
}, {
- "name" : "userid",
+ "name" : "roomid",
"in" : "path",
- "description" : "the userId the calendar events should be loaded",
+ "description" : "id of appointment special room",
"required" : true,
"schema" : {
"type" : "integer",
@@ -155,7 +66,7 @@
} ],
"responses" : {
"200" : {
- "description" : "next Calendar event",
+ "description" : "calendar event by its room id",
"content" : {
"application/json" : {
"schema" : {
@@ -170,11 +81,11 @@
}
}
},
- "/calendar/room/{roomid}" : {
+ "/calendar/title/{title}" : {
"get" : {
"tags" : [ "CalendarService" ],
- "description" : "Load a calendar event by its room id",
- "operationId" : "getByRoom",
+ "description" : "Search a calendar event for the current SID",
+ "operationId" : "getByTitle",
"parameters" : [ {
"name" : "sid",
"in" : "query",
@@ -184,22 +95,21 @@
"type" : "string"
}
}, {
- "name" : "roomid",
+ "name" : "title",
"in" : "path",
- "description" : "id of appointment special room",
+ "description" : "the search string",
"required" : true,
"schema" : {
- "type" : "integer",
- "format" : "int64"
+ "type" : "string"
}
} ],
"responses" : {
"200" : {
- "description" : "calendar event by its room id",
+ "description" : "calendar event list",
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/AppointmentDTOWrapper"
+ "$ref" : "#/components/schemas/AppointmentDTOListWrapper"
}
}
}
@@ -210,11 +120,11 @@
}
}
},
- "/calendar/title/{title}" : {
+ "/calendar/next" : {
"get" : {
"tags" : [ "CalendarService" ],
- "description" : "Search a calendar event for the current SID",
- "operationId" : "getByTitle",
+ "description" : "Get the next Calendar event for the current USER of the SID",
+ "operationId" : "next",
"parameters" : [ {
"name" : "sid",
"in" : "query",
@@ -223,22 +133,14 @@
"schema" : {
"type" : "string"
}
- }, {
- "name" : "title",
- "in" : "path",
- "description" : "the search string",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
} ],
"responses" : {
"200" : {
- "description" : "calendar event list",
+ "description" : "next Calendar event",
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/AppointmentDTOListWrapper"
+ "$ref" : "#/components/schemas/AppointmentDTOWrapper"
}
}
}
@@ -249,11 +151,11 @@
}
}
},
- "/calendar/{id}" : {
- "delete" : {
+ "/calendar/next/{userid}" : {
+ "get" : {
"tags" : [ "CalendarService" ],
- "description" : "Delete a calendar event\n\n If the given sid is from an Administrator or Web-Service USER, the USER\n can delete any appointment.\n If the sid is assigned to a regular USER, he can only delete appointments\n where he is also the owner/creator of the appointment",
- "operationId" : "delete",
+ "description" : "Get the next Calendar event for userId",
+ "operationId" : "nextForUser",
"parameters" : [ {
"name" : "sid",
"in" : "query",
@@ -263,9 +165,9 @@
"type" : "string"
}
}, {
- "name" : "id",
+ "name" : "userid",
"in" : "path",
- "description" : "the id to delete",
+ "description" : "the userId the calendar events should be loaded",
"required" : true,
"schema" : {
"type" : "integer",
@@ -274,11 +176,11 @@
} ],
"responses" : {
"200" : {
- "description" : "ServiceResult with result type",
+ "description" : "next Calendar event",
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/ServiceResultWrapper"
+ "$ref" : "#/components/schemas/AppointmentDTOWrapper"
}
}
}
@@ -396,11 +298,11 @@
}
}
},
- "/error/report" : {
+ "/calendar" : {
"post" : {
- "tags" : [ "ErrorService" ],
- "description" : "Logs an error to the log file for reporting",
- "operationId" : "report",
+ "tags" : [ "CalendarService" ],
+ "description" : "Create an appointment",
+ "operationId" : "save",
"parameters" : [ {
"name" : "sid",
"in" : "query",
@@ -409,18 +311,32 @@
"schema" : {
"type" : "string"
}
- }, {
- "name" : "message",
- "in" : "query",
- "description" : "The message to log",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
} ],
+ "requestBody" : {
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "required" : [ "appointment" ],
+ "type" : "object",
+ "properties" : {
+ "appointment" : {
+ "$ref" : "#/components/schemas/AppointmentDTO"
+ }
+ }
+ }
+ }
+ }
+ },
"responses" : {
"200" : {
- "description" : "Success"
+ "description" : "appointment saved",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/AppointmentDTOWrapper"
+ }
+ }
+ }
},
"500" : {
"description" : "Error in case of invalid credentials or server error"
@@ -468,6 +384,38 @@
}
}
},
+ "/error/report" : {
+ "post" : {
+ "tags" : [ "ErrorService" ],
+ "description" : "Logs an error to the log file for reporting",
+ "operationId" : "report",
+ "parameters" : [ {
+ "name" : "sid",
+ "in" : "query",
+ "description" : "The SID of the User. This SID must be marked as Loggedin",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "message",
+ "in" : "query",
+ "description" : "The message to log",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Success"
+ },
+ "500" : {
+ "description" : "Error in case of invalid credentials or server error"
+ }
+ }
+ }
+ },
"/file" : {
"post" : {
"tags" : [ "FileService" ],
@@ -510,11 +458,11 @@
}
}
},
- "/file/move/{roomid}/{id}/{parentid}" : {
- "post" : {
+ "/file/{id}" : {
+ "delete" : {
"tags" : [ "FileService" ],
- "description" : "move a file or folder",
- "operationId" : "move",
+ "description" : "deletes files or folders based on it id",
+ "operationId" : "delete_1",
"parameters" : [ {
"name" : "sid",
"in" : "query",
@@ -526,25 +474,7 @@
}, {
"name" : "id",
"in" : "path",
- "description" : "current file or folder id to be moved",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "format" : "int64"
- }
- }, {
- "name" : "roomid",
- "in" : "path",
- "description" : "room this file need to be moved",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "format" : "int64"
- }
- }, {
- "name" : "parentid",
- "in" : "path",
- "description" : "new parent folder id",
+ "description" : "the id of the file or folder",
"required" : true,
"schema" : {
"type" : "integer",
@@ -553,11 +483,11 @@
} ],
"responses" : {
"200" : {
- "description" : "resulting file object",
+ "description" : "ServiceResult with result type",
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/FileItemDTOWrapper"
+ "$ref" : "#/components/schemas/ServiceResultWrapper"
}
}
}
@@ -568,11 +498,11 @@
}
}
},
- "/file/rename/{id}/{name}" : {
- "post" : {
+ "/file/{externaltype}/{externalid}" : {
+ "delete" : {
"tags" : [ "FileService" ],
- "description" : "update a file or folder name",
- "operationId" : "rename",
+ "description" : "deletes a file by its external Id and type",
+ "operationId" : "deleteExternal",
"parameters" : [ {
"name" : "sid",
"in" : "query",
@@ -582,18 +512,17 @@
"type" : "string"
}
}, {
- "name" : "id",
+ "name" : "externaltype",
"in" : "path",
- "description" : "file or folder id",
+ "description" : "the externalType",
"required" : true,
"schema" : {
- "type" : "integer",
- "format" : "int64"
+ "type" : "string"
}
}, {
- "name" : "name",
+ "name" : "externalid",
"in" : "path",
- "description" : "new file or folder name",
+ "description" : "the id of the file or folder",
"required" : true,
"schema" : {
"type" : "string"
@@ -601,11 +530,11 @@
} ],
"responses" : {
"200" : {
- "description" : "resulting file object",
+ "description" : "ServiceResult with result type",
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/FileItemDTOWrapper"
+ "$ref" : "#/components/schemas/ServiceResultWrapper"
}
}
}
@@ -616,11 +545,11 @@
}
}
},
- "/file/room/{id}" : {
+ "/file/{externaltype}" : {
"get" : {
"tags" : [ "FileService" ],
- "description" : "Get a File Explorer Object by a given ROOM",
- "operationId" : "getRoom",
+ "description" : "Get all files by external type",
+ "operationId" : "getAllExternal",
"parameters" : [ {
"name" : "sid",
"in" : "query",
@@ -630,22 +559,21 @@
"type" : "string"
}
}, {
- "name" : "id",
+ "name" : "externaltype",
"in" : "path",
- "description" : "ROOM Id",
+ "description" : "External type for file listing",
"required" : true,
"schema" : {
- "type" : "integer",
- "format" : "int64"
+ "type" : "string"
}
} ],
"responses" : {
"200" : {
- "description" : "File Explorer Object by a given ROOM",
+ "description" : "the list of files for given external type",
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/FileExplorerObjectWrapper"
+ "$ref" : "#/components/schemas/FileItemDTOListWrapper"
}
}
}
@@ -656,11 +584,11 @@
}
}
},
- "/file/room/{id}/{parent}" : {
+ "/file/room/{id}" : {
"get" : {
"tags" : [ "FileService" ],
- "description" : "Get list of FileItemDTO by parent",
- "operationId" : "getRoomByParent",
+ "description" : "Get a File Explorer Object by a given ROOM",
+ "operationId" : "getRoom",
"parameters" : [ {
"name" : "sid",
"in" : "query",
@@ -672,16 +600,7 @@
}, {
"name" : "id",
"in" : "path",
- "description" : "the parent folder id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "format" : "int64"
- }
- }, {
- "name" : "parent",
- "in" : "path",
- "description" : "the room id",
+ "description" : "ROOM Id",
"required" : true,
"schema" : {
"type" : "integer",
@@ -690,11 +609,11 @@
} ],
"responses" : {
"200" : {
- "description" : "list of file explorer items",
+ "description" : "File Explorer Object by a given ROOM",
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/FileItemDTOListWrapper"
+ "$ref" : "#/components/schemas/FileExplorerObjectWrapper"
}
}
}
@@ -705,11 +624,11 @@
}
}
},
- "/file/{externaltype}" : {
+ "/file/room/{id}/{parent}" : {
"get" : {
"tags" : [ "FileService" ],
- "description" : "Get all files by external type",
- "operationId" : "getAllExternal",
+ "description" : "Get list of FileItemDTO by parent",
+ "operationId" : "getRoomByParent",
"parameters" : [ {
"name" : "sid",
"in" : "query",
@@ -719,17 +638,27 @@
"type" : "string"
}
}, {
- "name" : "externaltype",
+ "name" : "id",
"in" : "path",
- "description" : "External type for file listing",
+ "description" : "the parent folder id",
"required" : true,
"schema" : {
- "type" : "string"
+ "type" : "integer",
+ "format" : "int64"
+ }
+ }, {
+ "name" : "parent",
+ "in" : "path",
+ "description" : "the room id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "format" : "int64"
}
} ],
"responses" : {
"200" : {
- "description" : "the list of files for given external type",
+ "description" : "list of file explorer items",
"content" : {
"application/json" : {
"schema" : {
@@ -744,11 +673,11 @@
}
}
},
- "/file/{externaltype}/{externalid}" : {
- "delete" : {
+ "/file/move/{roomid}/{id}/{parentid}" : {
+ "post" : {
"tags" : [ "FileService" ],
- "description" : "deletes a file by its external Id and type",
- "operationId" : "deleteExternal",
+ "description" : "move a file or folder",
+ "operationId" : "move",
"parameters" : [ {
"name" : "sid",
"in" : "query",
@@ -758,29 +687,40 @@
"type" : "string"
}
}, {
- "name" : "externaltype",
+ "name" : "id",
"in" : "path",
- "description" : "the externalType",
+ "description" : "current file or folder id to be moved",
"required" : true,
"schema" : {
- "type" : "string"
+ "type" : "integer",
+ "format" : "int64"
}
}, {
- "name" : "externalid",
+ "name" : "roomid",
"in" : "path",
- "description" : "the id of the file or folder",
+ "description" : "room this file need to be moved",
"required" : true,
"schema" : {
- "type" : "string"
+ "type" : "integer",
+ "format" : "int64"
+ }
+ }, {
+ "name" : "parentid",
+ "in" : "path",
+ "description" : "new parent folder id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "format" : "int64"
}
} ],
"responses" : {
"200" : {
- "description" : "ServiceResult with result type",
+ "description" : "resulting file object",
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/ServiceResultWrapper"
+ "$ref" : "#/components/schemas/FileItemDTOWrapper"
}
}
}
@@ -791,11 +731,11 @@
}
}
},
- "/file/{id}" : {
- "delete" : {
+ "/file/rename/{id}/{name}" : {
+ "post" : {
"tags" : [ "FileService" ],
- "description" : "deletes files or folders based on it id",
- "operationId" : "delete_1",
+ "description" : "update a file or folder name",
+ "operationId" : "rename",
"parameters" : [ {
"name" : "sid",
"in" : "query",
@@ -807,20 +747,28 @@
}, {
"name" : "id",
"in" : "path",
- "description" : "the id of the file or folder",
+ "description" : "file or folder id",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
+ }, {
+ "name" : "name",
+ "in" : "path",
+ "description" : "new file or folder name",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
} ],
"responses" : {
"200" : {
- "description" : "ServiceResult with result type",
+ "description" : "resulting file object",
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/ServiceResultWrapper"
+ "$ref" : "#/components/schemas/FileItemDTOWrapper"
}
}
}
@@ -899,11 +847,11 @@
}
}
},
- "/group/users/{id}" : {
- "get" : {
+ "/group/{id}/rooms/add/{roomid}" : {
+ "post" : {
"tags" : [ "GroupService" ],
- "description" : "Search users and return them",
- "operationId" : "getUsers",
+ "description" : "Adds a room to an group",
+ "operationId" : "addRoom",
"parameters" : [ {
"name" : "sid",
"in" : "query",
@@ -915,54 +863,29 @@
}, {
"name" : "id",
"in" : "path",
- "description" : "the group id",
+ "description" : "Id of group that the room is being paired with",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
}, {
- "name" : "start",
- "in" : "query",
- "description" : "first record",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "format" : "int32"
- }
- }, {
- "name" : "max",
- "in" : "query",
- "description" : "max records",
+ "name" : "roomid",
+ "in" : "path",
+ "description" : "Id of room to be added",
"required" : true,
"schema" : {
"type" : "integer",
- "format" : "int32"
- }
- }, {
- "name" : "orderby",
- "in" : "query",
- "description" : "orderby clause",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "name" : "asc",
- "in" : "query",
- "description" : "asc or desc",
- "required" : true,
- "schema" : {
- "type" : "boolean"
+ "format" : "int64"
}
} ],
"responses" : {
"200" : {
- "description" : "users found",
+ "description" : "ServiceResult with result type",
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/UserSearchResultWrapper"
+ "$ref" : "#/components/schemas/ServiceResultWrapper"
}
}
}
@@ -973,11 +896,11 @@
}
}
},
- "/group/{id}" : {
- "delete" : {
+ "/group/{id}/users/{userid}" : {
+ "post" : {
"tags" : [ "GroupService" ],
- "description" : "Deletes a group",
- "operationId" : "delete_2",
+ "description" : "Add USER to a certain group",
+ "operationId" : "addUser",
"parameters" : [ {
"name" : "sid",
"in" : "query",
@@ -989,7 +912,16 @@
}, {
"name" : "id",
"in" : "path",
- "description" : "the id of the group",
+ "description" : "the USER id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "format" : "int64"
+ }
+ }, {
+ "name" : "userid",
+ "in" : "path",
+ "description" : "the group id",
"required" : true,
"schema" : {
"type" : "integer",
@@ -998,7 +930,7 @@
} ],
"responses" : {
"200" : {
- "description" : "ServiceResult with result type",
+ "description" : "ServiceResult with result type, and id of the USER added, or error id in case of the error as text",
"content" : {
"application/json" : {
"schema" : {
@@ -1011,13 +943,11 @@
"description" : "Error in case of invalid credentials or server error"
}
}
- }
- },
- "/group/{id}/rooms/add/{roomid}" : {
- "post" : {
+ },
+ "delete" : {
"tags" : [ "GroupService" ],
- "description" : "Adds a room to an group",
- "operationId" : "addRoom",
+ "description" : "Remove USER from a certain group",
+ "operationId" : "removeUser",
"parameters" : [ {
"name" : "sid",
"in" : "query",
@@ -1029,16 +959,16 @@
}, {
"name" : "id",
"in" : "path",
- "description" : "Id of group that the room is being paired with",
+ "description" : "the USER id",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
}, {
- "name" : "roomid",
+ "name" : "userid",
"in" : "path",
- "description" : "Id of room to be added",
+ "description" : "the group id",
"required" : true,
"schema" : {
"type" : "integer",
@@ -1047,7 +977,7 @@
} ],
"responses" : {
"200" : {
- "description" : "ServiceResult with result type",
+ "description" : "ServiceResult with result type, and id of the USER removed, or error id in case of the error as text",
"content" : {
"application/json" : {
"schema" : {
@@ -1062,11 +992,11 @@
}
}
},
- "/group/{id}/users/{userid}" : {
- "post" : {
+ "/group/{id}" : {
+ "delete" : {
"tags" : [ "GroupService" ],
- "description" : "Add USER to a certain group",
- "operationId" : "addUser",
+ "description" : "Deletes a group",
+ "operationId" : "delete_2",
"parameters" : [ {
"name" : "sid",
"in" : "query",
@@ -1078,16 +1008,7 @@
}, {
"name" : "id",
"in" : "path",
- "description" : "the USER id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "format" : "int64"
- }
- }, {
- "name" : "userid",
- "in" : "path",
- "description" : "the group id",
+ "description" : "the id of the group",
"required" : true,
"schema" : {
"type" : "integer",
@@ -1096,7 +1017,7 @@
} ],
"responses" : {
"200" : {
- "description" : "ServiceResult with result type, and id of the USER added, or error id in case of the error as text",
+ "description" : "ServiceResult with result type",
"content" : {
"application/json" : {
"schema" : {
@@ -1109,11 +1030,13 @@
"description" : "Error in case of invalid credentials or server error"
}
}
- },
- "delete" : {
+ }
+ },
+ "/group/users/{id}" : {
+ "get" : {
"tags" : [ "GroupService" ],
- "description" : "Remove USER from a certain group",
- "operationId" : "removeUser",
+ "description" : "Search users and return them",
+ "operationId" : "getUsers",
"parameters" : [ {
"name" : "sid",
"in" : "query",
@@ -1125,33 +1048,58 @@
}, {
"name" : "id",
"in" : "path",
- "description" : "the USER id",
+ "description" : "the group id",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
}, {
- "name" : "userid",
- "in" : "path",
- "description" : "the group id",
+ "name" : "start",
+ "in" : "query",
+ "description" : "first record",
"required" : true,
"schema" : {
"type" : "integer",
- "format" : "int64"
+ "format" : "int32"
}
- } ],
- "responses" : {
- "200" : {
- "description" : "ServiceResult with result type, and id of the USER removed, or error id in case of the error as text",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/ServiceResultWrapper"
- }
- }
- }
- },
+ }, {
+ "name" : "max",
+ "in" : "query",
+ "description" : "max records",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ }, {
+ "name" : "orderby",
+ "in" : "query",
+ "description" : "orderby clause",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "asc",
+ "in" : "query",
+ "description" : "asc or desc",
+ "required" : true,
+ "schema" : {
+ "type" : "boolean"
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "users found",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/UserSearchResultWrapper"
+ }
+ }
+ }
+ },
"500" : {
"description" : "Error in case of invalid credentials or server error"
}
@@ -1293,11 +1241,11 @@
}
}
},
- "/record/room/{roomid}" : {
- "get" : {
+ "/record/{id}" : {
+ "delete" : {
"tags" : [ "RecordingService" ],
- "description" : "Gets a list of recordings",
- "operationId" : "getExternalByRoom",
+ "description" : "Deletes a recording",
+ "operationId" : "delete_3",
"parameters" : [ {
"name" : "sid",
"in" : "query",
@@ -1307,9 +1255,9 @@
"type" : "string"
}
}, {
- "name" : "roomid",
+ "name" : "id",
"in" : "path",
- "description" : "the room id",
+ "description" : "the id of the recording",
"required" : true,
"schema" : {
"type" : "integer",
@@ -1318,11 +1266,11 @@
} ],
"responses" : {
"200" : {
- "description" : "list of recordings",
+ "description" : "serviceResult object with the result",
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/RecordingDTOListWrapper"
+ "$ref" : "#/components/schemas/ServiceResultWrapper"
}
}
}
@@ -1333,11 +1281,11 @@
}
}
},
- "/record/{externaltype}" : {
+ "/record/{externaltype}/{externalid}" : {
"get" : {
"tags" : [ "RecordingService" ],
- "description" : "Gets a list of recordings",
- "operationId" : "getExternalByType",
+ "description" : "Gets a list of recordings created by particular external USER",
+ "operationId" : "getExternal",
"parameters" : [ {
"name" : "sid",
"in" : "query",
@@ -1349,7 +1297,15 @@
}, {
"name" : "externaltype",
"in" : "path",
- "description" : "externalType specified when creating the room",
+ "description" : "the externalUserId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "externalid",
+ "in" : "path",
+ "description" : "the externalUserType",
"required" : true,
"schema" : {
"type" : "string"
@@ -1372,11 +1328,11 @@
}
}
},
- "/record/{externaltype}/{externalid}" : {
+ "/record/room/{roomid}" : {
"get" : {
"tags" : [ "RecordingService" ],
- "description" : "Gets a list of recordings created by particular external USER",
- "operationId" : "getExternal",
+ "description" : "Gets a list of recordings",
+ "operationId" : "getExternalByRoom",
"parameters" : [ {
"name" : "sid",
"in" : "query",
@@ -1386,20 +1342,13 @@
"type" : "string"
}
}, {
- "name" : "externaltype",
- "in" : "path",
- "description" : "the externalUserId",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "name" : "externalid",
+ "name" : "roomid",
"in" : "path",
- "description" : "the externalUserType",
+ "description" : "the room id",
"required" : true,
"schema" : {
- "type" : "string"
+ "type" : "integer",
+ "format" : "int64"
}
} ],
"responses" : {
@@ -1419,11 +1368,11 @@
}
}
},
- "/record/{id}" : {
- "delete" : {
+ "/record/{externaltype}" : {
+ "get" : {
"tags" : [ "RecordingService" ],
- "description" : "Deletes a recording",
- "operationId" : "delete_3",
+ "description" : "Gets a list of recordings",
+ "operationId" : "getExternalByType",
"parameters" : [ {
"name" : "sid",
"in" : "query",
@@ -1433,22 +1382,21 @@
"type" : "string"
}
}, {
- "name" : "id",
+ "name" : "externaltype",
"in" : "path",
- "description" : "the id of the recording",
+ "description" : "externalType specified when creating the room",
"required" : true,
"schema" : {
- "type" : "integer",
- "format" : "int64"
+ "type" : "string"
}
} ],
"responses" : {
"200" : {
- "description" : "serviceResult object with the result",
+ "description" : "list of recordings",
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/ServiceResultWrapper"
+ "$ref" : "#/components/schemas/RecordingDTOListWrapper"
}
}
}
@@ -1585,11 +1533,11 @@
}
}
},
- "/room/hash" : {
- "post" : {
+ "/room/{id}" : {
+ "get" : {
"tags" : [ "RoomService" ],
- "description" : "Method to get invitation hash with given parameters",
- "operationId" : "hash",
+ "description" : "Returns a conference room object",
+ "operationId" : "getRoomById",
"parameters" : [ {
"name" : "sid",
"in" : "query",
@@ -1599,29 +1547,22 @@
"type" : "string"
}
}, {
- "name" : "invite",
- "in" : "query",
- "description" : "parameters of the invitation",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/InvitationDTO"
- }
- }, {
- "name" : "sendmail",
- "in" : "query",
- "description" : "flag to determine if email should be sent or not",
+ "name" : "id",
+ "in" : "path",
+ "description" : "the room id",
"required" : true,
"schema" : {
- "type" : "boolean"
+ "type" : "integer",
+ "format" : "int64"
}
} ],
"responses" : {
"200" : {
- "description" : "serviceResult object with the result",
+ "description" : "room with the id given",
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/ServiceResultWrapper"
+ "$ref" : "#/components/schemas/RoomDTOWrapper"
}
}
}
@@ -1630,13 +1571,11 @@
"description" : "Error in case of invalid credentials or server error"
}
}
- }
- },
- "/room/kick/{id}" : {
- "get" : {
+ },
+ "delete" : {
"tags" : [ "RoomService" ],
- "description" : "Kick all uses of a certain room",
- "operationId" : "kickAll",
+ "description" : "Delete a room by its room id",
+ "operationId" : "delete_4",
"parameters" : [ {
"name" : "sid",
"in" : "query",
@@ -1648,7 +1587,7 @@
}, {
"name" : "id",
"in" : "path",
- "description" : "the room id",
+ "description" : "The id of the room",
"required" : true,
"schema" : {
"type" : "integer",
@@ -1657,7 +1596,7 @@
} ],
"responses" : {
"200" : {
- "description" : "true if USER was kicked, false otherwise",
+ "description" : "id of the room deleted",
"content" : {
"application/json" : {
"schema" : {
@@ -1672,11 +1611,11 @@
}
}
},
- "/room/kick/{id}/{externalType}/{externalId}" : {
+ "/room/{type}/{externaltype}/{externalid}" : {
"get" : {
"tags" : [ "RoomService" ],
- "description" : "kick external USER from given room",
- "operationId" : "kick",
+ "description" : "Checks if a room with this exteralId + externalType does exist,\n if yes it returns the room id if not, it will create the room and then\n return the room id of the newly created room",
+ "operationId" : "getExternal_1",
"parameters" : [ {
"name" : "sid",
"in" : "query",
@@ -1686,78 +1625,45 @@
"type" : "string"
}
}, {
- "name" : "id",
+ "name" : "type",
"in" : "path",
- "description" : "the room id",
+ "description" : "type of the room",
"required" : true,
"schema" : {
- "type" : "integer",
- "format" : "int64"
+ "type" : "string"
}
}, {
- "name" : "externalType",
+ "name" : "externaltype",
"in" : "path",
- "description" : "external type of USER to kick",
+ "description" : "you can specify your system-name or type of room here, for example \"moodle\"",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
- "name" : "externalId",
+ "name" : "externalid",
"in" : "path",
- "description" : "external id of USER to kick",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- } ],
- "responses" : {
- "200" : {
- "description" : "'Kicked' if USER was 'Not kicked' otherwise",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/ServiceResultWrapper"
- }
- }
- }
- },
- "500" : {
- "description" : "Error in case of invalid credentials or server error"
- }
- }
- }
- },
- "/room/open/{id}" : {
- "get" : {
- "tags" : [ "RoomService" ],
- "description" : "Method to remotely open rooms. If a room is closed all users\n inside the room and all users that try to enter it will be redirected to\n the redirectURL that is defined in the ROOM-Object.",
- "operationId" : "open",
- "parameters" : [ {
- "name" : "sid",
- "in" : "query",
- "description" : "The SID of the User. This SID must be marked as Loggedin",
+ "description" : "your external room id may set here",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
- "name" : "id",
- "in" : "path",
- "description" : "the room id",
+ "name" : "room",
+ "in" : "query",
+ "description" : "details of the room to be created if not found",
"required" : true,
"schema" : {
- "type" : "integer",
- "format" : "int64"
+ "$ref" : "#/components/schemas/RoomDTO"
}
} ],
"responses" : {
"200" : {
- "description" : "1 in case of success, -2 otherwise",
+ "description" : "id of the room or error code",
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/ServiceResultWrapper"
+ "$ref" : "#/components/schemas/RoomDTOWrapper"
}
}
}
@@ -1807,11 +1713,11 @@
}
}
},
- "/room/users/{roomid}" : {
- "get" : {
+ "/room/hash" : {
+ "post" : {
"tags" : [ "RoomService" ],
- "description" : "Returns list of users currently in the ROOM with given id",
- "operationId" : "users",
+ "description" : "Method to get invitation hash with given parameters",
+ "operationId" : "hash",
"parameters" : [ {
"name" : "sid",
"in" : "query",
@@ -1821,22 +1727,29 @@
"type" : "string"
}
}, {
- "name" : "roomid",
- "in" : "path",
- "description" : "roomId id of the room to get users",
+ "name" : "invite",
+ "in" : "query",
+ "description" : "parameters of the invitation",
"required" : true,
"schema" : {
- "type" : "integer",
- "format" : "int64"
+ "$ref" : "#/components/schemas/InvitationDTO"
+ }
+ }, {
+ "name" : "sendmail",
+ "in" : "query",
+ "description" : "flag to determine if email should be sent or not",
+ "required" : true,
+ "schema" : {
+ "type" : "boolean"
}
} ],
"responses" : {
"200" : {
- "description" : "List of users in the room",
+ "description" : "serviceResult object with the result",
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/UserDTOListWrapper"
+ "$ref" : "#/components/schemas/ServiceResultWrapper"
}
}
}
@@ -1847,11 +1760,11 @@
}
}
},
- "/room/{id}" : {
+ "/room/kick/{id}/{externalType}/{externalId}" : {
"get" : {
"tags" : [ "RoomService" ],
- "description" : "Returns a conference room object",
- "operationId" : "getRoomById",
+ "description" : "kick external USER from given room",
+ "operationId" : "kick",
"parameters" : [ {
"name" : "sid",
"in" : "query",
@@ -1869,14 +1782,30 @@
"type" : "integer",
"format" : "int64"
}
- } ],
- "responses" : {
- "200" : {
- "description" : "room with the id given",
+ }, {
+ "name" : "externalType",
+ "in" : "path",
+ "description" : "external type of USER to kick",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "externalId",
+ "in" : "path",
+ "description" : "external id of USER to kick",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "'Kicked' if USER was 'Not kicked' otherwise",
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/RoomDTOWrapper"
+ "$ref" : "#/components/schemas/ServiceResultWrapper"
}
}
}
@@ -1885,11 +1814,13 @@
"description" : "Error in case of invalid credentials or server error"
}
}
- },
- "delete" : {
+ }
+ },
+ "/room/kick/{id}" : {
+ "get" : {
"tags" : [ "RoomService" ],
- "description" : "Delete a room by its room id",
- "operationId" : "delete_4",
+ "description" : "Kick all uses of a certain room",
+ "operationId" : "kickAll",
"parameters" : [ {
"name" : "sid",
"in" : "query",
@@ -1901,7 +1832,7 @@
}, {
"name" : "id",
"in" : "path",
- "description" : "The id of the room",
+ "description" : "the room id",
"required" : true,
"schema" : {
"type" : "integer",
@@ -1910,7 +1841,7 @@
} ],
"responses" : {
"200" : {
- "description" : "id of the room deleted",
+ "description" : "true if USER was kicked, false otherwise",
"content" : {
"application/json" : {
"schema" : {
@@ -1925,11 +1856,11 @@
}
}
},
- "/room/{type}/{externaltype}/{externalid}" : {
+ "/room/open/{id}" : {
"get" : {
"tags" : [ "RoomService" ],
- "description" : "Checks if a room with this exteralId + externalType does exist,\n if yes it returns the room id if not, it will create the room and then\n return the room id of the newly created room",
- "operationId" : "getExternal_1",
+ "description" : "Method to remotely open rooms. If a room is closed all users\n inside the room and all users that try to enter it will be redirected to\n the redirectURL that is defined in the ROOM-Object.",
+ "operationId" : "open",
"parameters" : [ {
"name" : "sid",
"in" : "query",
@@ -1939,45 +1870,62 @@
"type" : "string"
}
}, {
- "name" : "type",
+ "name" : "id",
"in" : "path",
- "description" : "type of the room",
+ "description" : "the room id",
"required" : true,
"schema" : {
- "type" : "string"
+ "type" : "integer",
+ "format" : "int64"
}
- }, {
- "name" : "externaltype",
- "in" : "path",
- "description" : "you can specify your system-name or type of room here, for example \"moodle\"",
- "required" : true,
- "schema" : {
- "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "1 in case of success, -2 otherwise",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ServiceResultWrapper"
+ }
+ }
+ }
+ },
+ "500" : {
+ "description" : "Error in case of invalid credentials or server error"
}
- }, {
- "name" : "externalid",
- "in" : "path",
- "description" : "your external room id may set here",
+ }
+ }
+ },
+ "/room/users/{roomid}" : {
+ "get" : {
+ "tags" : [ "RoomService" ],
+ "description" : "Returns list of users currently in the ROOM with given id",
+ "operationId" : "users",
+ "parameters" : [ {
+ "name" : "sid",
+ "in" : "query",
+ "description" : "The SID of the User. This SID must be marked as Loggedin",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
- "name" : "room",
- "in" : "query",
- "description" : "details of the room to be created if not found",
+ "name" : "roomid",
+ "in" : "path",
+ "description" : "roomId id of the room to get users",
"required" : true,
"schema" : {
- "$ref" : "#/components/schemas/RoomDTO"
+ "type" : "integer",
+ "format" : "int64"
}
} ],
"responses" : {
"200" : {
- "description" : "id of the room or error code",
+ "description" : "List of users in the room",
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/RoomDTOWrapper"
+ "$ref" : "#/components/schemas/UserDTOListWrapper"
}
}
}
@@ -2067,11 +2015,11 @@
}
}
},
- "/user/hash" : {
- "post" : {
+ "/user/{id}" : {
+ "delete" : {
"tags" : [ "UserService" ],
- "description" : "Sets the SessionObject for a certain SID, after setting this\n Session-Object you can use the SID + a RoomId to enter any Room. ...\n Session-Hashs are deleted 15 minutes after the creation if not used.",
- "operationId" : "getRoomHash",
+ "description" : "Delete a certain user by its id",
+ "operationId" : "delete_5",
"parameters" : [ {
"name" : "sid",
"in" : "query",
@@ -2080,67 +2028,19 @@
"schema" : {
"type" : "string"
}
- } ],
- "requestBody" : {
- "content" : {
- "*/*" : {
- "schema" : {
- "required" : [ "options", "user" ],
- "type" : "object",
- "properties" : {
- "user" : {
- "$ref" : "#/components/schemas/ExternalUserDTO"
- },
- "options" : {
- "$ref" : "#/components/schemas/RoomOptionsDTO"
- }
- }
- }
- }
- }
- },
- "responses" : {
- "200" : {
- "description" : "secure hash or error code",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/ServiceResultWrapper"
- }
- }
- }
- },
- "500" : {
- "description" : "Error in case of invalid credentials or server error"
- }
- }
- }
- },
- "/user/login" : {
- "get" : {
- "tags" : [ "UserService" ],
- "description" : "Login and create sessionId required for sub-sequent calls",
- "operationId" : "login",
- "parameters" : [ {
- "name" : "user",
- "in" : "query",
- "description" : "login or email of Openmeetings user with admin or SOAP-rights",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
}, {
- "name" : "pass",
- "in" : "query",
- "description" : "password",
+ "name" : "id",
+ "in" : "path",
+ "description" : "the openmeetings user id",
"required" : true,
"schema" : {
- "type" : "string"
+ "type" : "integer",
+ "format" : "int64"
}
} ],
"responses" : {
"200" : {
- "description" : "ServiceResult with error code or SID and userId",
+ "description" : "id of the user deleted, error code otherwise",
"content" : {
"application/json" : {
"schema" : {
@@ -2150,7 +2050,7 @@
}
},
"500" : {
- "description" : "Error of server error"
+ "description" : "Error in case of invalid credentials or server error"
}
}
}
@@ -2202,11 +2102,11 @@
}
}
},
- "/user/{id}" : {
- "delete" : {
+ "/user/hash" : {
+ "post" : {
"tags" : [ "UserService" ],
- "description" : "Delete a certain user by its id",
- "operationId" : "delete_5",
+ "description" : "Sets the SessionObject for a certain SID, after setting this\n Session-Object you can use the SID + a RoomId to enter any Room. ...\n Session-Hashs are deleted 15 minutes after the creation if not used.",
+ "operationId" : "getRoomHash",
"parameters" : [ {
"name" : "sid",
"in" : "query",
@@ -2215,19 +2115,28 @@
"schema" : {
"type" : "string"
}
- }, {
- "name" : "id",
- "in" : "path",
- "description" : "the openmeetings user id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "format" : "int64"
- }
} ],
+ "requestBody" : {
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "required" : [ "options", "user" ],
+ "type" : "object",
+ "properties" : {
+ "user" : {
+ "$ref" : "#/components/schemas/ExternalUserDTO"
+ },
+ "options" : {
+ "$ref" : "#/components/schemas/RoomOptionsDTO"
+ }
+ }
+ }
+ }
+ }
+ },
"responses" : {
"200" : {
- "description" : "id of the user deleted, error code otherwise",
+ "description" : "secure hash or error code",
"content" : {
"application/json" : {
"schema" : {
@@ -2242,6 +2151,48 @@
}
}
},
+ "/user/login" : {
+ "post" : {
+ "tags" : [ "UserService" ],
+ "description" : "Login and create sessionId required for sub-sequent calls",
+ "operationId" : "login",
+ "requestBody" : {
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "required" : [ "pass", "user" ],
+ "type" : "object",
+ "properties" : {
+ "user" : {
+ "type" : "string",
+ "description" : "login or email of Openmeetings user with admin or SOAP-rights"
+ },
+ "pass" : {
+ "type" : "string",
+ "description" : "password"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses" : {
+ "200" : {
+ "description" : "ServiceResult with error code or SID and userId",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ServiceResultWrapper"
+ }
+ }
+ }
+ },
+ "500" : {
+ "description" : "Error of server error"
+ }
+ }
+ }
+ },
"/wb/cleanslide/{roomid}/{wbid}/{slide}" : {
"get" : {
"tags" : [ "WbService" ],
@@ -2447,42 +2398,62 @@
},
"components" : {
"schemas" : {
- "Address" : {
+ "ServiceResult" : {
"type" : "object",
"properties" : {
- "additionalname" : {
- "type" : "string"
- },
- "comment" : {
+ "message" : {
"type" : "string"
},
- "country" : {
+ "type" : {
"type" : "string"
- },
- "deleted" : {
- "type" : "boolean"
- },
- "email" : {
- "type" : "string",
- "xml" : {
- "name" : "mail"
+ }
+ }
+ },
+ "ServiceResultWrapper" : {
+ "type" : "object",
+ "properties" : {
+ "serviceResult" : {
+ "$ref" : "#/components/schemas/ServiceResult"
+ }
+ },
+ "example" : {
+ "serviceResult" : {
+ "message" : "9dbb6907-61fc-42c0-a2b2-5dbfbe053ac6",
+ "type" : "SUCCESS"
+ }
+ }
+ },
+ "Address" : {
+ "type" : "object",
+ "properties" : {
+ "inserted" : {
+ "type" : "string",
+ "format" : "date-time",
+ "xml" : {
+ "name" : "created"
}
},
- "fax" : {
- "type" : "string"
+ "updated" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "deleted" : {
+ "type" : "boolean"
},
"id" : {
"type" : "integer",
"format" : "int64"
},
- "inserted" : {
- "type" : "string",
- "format" : "date-time",
- "xml" : {
- "name" : "created"
- }
+ "additionalname" : {
+ "type" : "string"
},
- "phone" : {
+ "comment" : {
+ "type" : "string"
+ },
+ "fax" : {
+ "type" : "string"
+ },
+ "country" : {
"type" : "string"
},
"street" : {
@@ -2491,11 +2462,16 @@
"town" : {
"type" : "string"
},
- "updated" : {
+ "zip" : {
+ "type" : "string"
+ },
+ "email" : {
"type" : "string",
- "format" : "date-time"
+ "xml" : {
+ "name" : "mail"
+ }
},
- "zip" : {
+ "phone" : {
"type" : "string"
}
},
@@ -2506,35 +2482,49 @@
"AppointmentDTO" : {
"type" : "object",
"properties" : {
- "connectedEvent" : {
- "type" : "boolean"
+ "id" : {
+ "type" : "integer",
+ "format" : "int64"
},
- "deleted" : {
- "type" : "boolean"
+ "title" : {
+ "type" : "string"
},
- "description" : {
+ "location" : {
"type" : "string"
},
+ "start" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
"end" : {
"type" : "string",
"format" : "date-time"
},
- "icalId" : {
+ "description" : {
"type" : "string"
},
- "id" : {
- "type" : "integer",
- "format" : "int64"
+ "owner" : {
+ "$ref" : "#/components/schemas/UserDTO"
},
"inserted" : {
"type" : "string",
"format" : "date-time"
},
- "languageId" : {
- "type" : "integer",
- "format" : "int64"
+ "updated" : {
+ "type" : "string",
+ "format" : "date-time"
},
- "location" : {
+ "deleted" : {
+ "type" : "boolean"
+ },
+ "reminder" : {
+ "type" : "string",
+ "enum" : [ "NONE", "EMAIL", "ICAL" ]
+ },
+ "room" : {
+ "$ref" : "#/components/schemas/RoomDTO"
+ },
+ "icalId" : {
"type" : "string"
},
"meetingMembers" : {
@@ -2543,8 +2533,9 @@
"$ref" : "#/components/schemas/MeetingMemberDTO"
}
},
- "owner" : {
- "$ref" : "#/components/schemas/UserDTO"
+ "languageId" : {
+ "type" : "integer",
+ "format" : "int64"
},
"password" : {
"type" : "string"
@@ -2552,131 +2543,12 @@
"passwordProtected" : {
"type" : "boolean"
},
- "reminder" : {
- "type" : "string",
- "enum" : [ "NONE", "EMAIL", "ICAL" ]
+ "connectedEvent" : {
+ "type" : "boolean"
},
"reminderEmailSend" : {
"type" : "boolean"
- },
- "room" : {
- "$ref" : "#/components/schemas/RoomDTO"
- },
- "start" : {
- "type" : "string",
- "format" : "date-time"
- },
- "title" : {
- "type" : "string"
- },
- "updated" : {
- "type" : "string",
- "format" : "date-time"
- }
- }
- },
- "AppointmentDTOListWrapper" : {
- "type" : "object",
- "properties" : {
- "appointmentDTO" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/AppointmentDTO"
- }
}
- },
- "example" : {
- "appointmentDTO" : [ {
- "connectedEvent" : false,
- "deleted" : false,
- "description" : "Comments",
- "end" : "2021-09-23T12:31:00+1200",
- "icalId" : "7507ab5d-81ec-458a-bdb1-48d102978e49",
- "id" : 1,
- "inserted" : "2021-09-19T11:31:37+1200",
- "meetingMembers" : [ {
- "id" : 1,
- "user" : {
- "address" : {
- "country" : "NZ",
- "deleted" : false,
- "email" : "seba.wagner@gmail.com",
- "id" : 1,
- "inserted" : {
- "date" : 29,
- "day" : 0,
- "hours" : 10,
- "minutes" : 59,
- "month" : 7,
- "ownerField" : 1,
- "seconds" : 49,
- "time" : 1630191589000,
- "timezoneOffset" : -720,
- "year" : 121
- }
- },
- "firstname" : "firstname",
- "id" : 1,
- "languageId" : 1,
- "lastname" : "lastname",
- "login" : "admin",
- "rights" : [ "ROOM", "SOAP", "DASHBOARD", "ADMIN", "LOGIN" ],
- "timeZoneId" : "Europe/Berlin",
- "type" : "USER"
- }
- } ],
- "owner" : {
- "address" : {
- "country" : "NZ",
- "deleted" : false,
- "email" : "seba.wagner@gmail.com",
- "id" : 1,
- "inserted" : {
- "date" : 29,
- "day" : 0,
- "hours" : 10,
- "minutes" : 59,
- "month" : 7,
- "ownerField" : 1,
- "seconds" : 49,
- "time" : 1630191589000,
- "timezoneOffset" : -720,
- "year" : 121
- }
- },
- "firstname" : "firstname",
- "id" : 1,
- "languageId" : 1,
- "lastname" : "lastname",
- "login" : "admin",
- "rights" : [ "ROOM", "SOAP", "DASHBOARD", "ADMIN", "LOGIN" ],
- "timeZoneId" : "Europe/Berlin",
- "type" : "USER"
- },
- "passwordProtected" : false,
- "reminder" : "ICAL",
- "reminderEmailSend" : false,
- "room" : {
- "allowRecording" : true,
- "allowUserQuestions" : false,
- "appointment" : true,
- "audioOnly" : false,
- "capacity" : 50,
- "closed" : false,
- "demo" : false,
- "files" : [ ],
- "hiddenElements" : [ "MICROPHONE_STATUS" ],
- "id" : 11,
- "moderated" : false,
- "name" : "New Event",
- "public" : false,
- "type" : "CONFERENCE",
- "waitModerator" : false,
- "waitRecording" : false
- },
- "start" : "2021-09-23T11:31:00+1200",
- "title" : "New Event"
- } ]
}
},
"AppointmentDTOWrapper" : {
@@ -2780,133 +2652,303 @@
}
}
},
- "ExternalUserDTO" : {
+ "MeetingMemberDTO" : {
"type" : "object",
"properties" : {
- "email" : {
- "type" : "string"
+ "id" : {
+ "type" : "integer",
+ "format" : "int64"
},
- "externalId" : {
- "type" : "string"
+ "user" : {
+ "$ref" : "#/components/schemas/UserDTO"
+ }
+ }
+ },
+ "RoomDTO" : {
+ "type" : "object",
+ "properties" : {
+ "id" : {
+ "type" : "integer",
+ "format" : "int64"
},
- "externalType" : {
+ "name" : {
"type" : "string"
},
- "firstname" : {
+ "tag" : {
"type" : "string"
},
- "lastname" : {
+ "comment" : {
"type" : "string"
},
- "login" : {
+ "type" : {
+ "type" : "string",
+ "enum" : [ "CONFERENCE", "PRESENTATION", "INTERVIEW" ]
+ },
+ "capacity" : {
+ "type" : "integer",
+ "format" : "int64"
+ },
+ "appointment" : {
+ "type" : "boolean"
+ },
+ "confno" : {
"type" : "string"
},
- "profilePictureUrl" : {
+ "demo" : {
+ "type" : "boolean"
+ },
+ "closed" : {
+ "type" : "boolean"
+ },
+ "demoTime" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "externalId" : {
+ "type" : "string"
+ },
+ "externalType" : {
+ "type" : "string"
+ },
+ "redirectUrl" : {
"type" : "string"
+ },
+ "moderated" : {
+ "type" : "boolean"
+ },
+ "waitModerator" : {
+ "type" : "boolean"
+ },
+ "allowUserQuestions" : {
+ "type" : "boolean"
+ },
+ "allowRecording" : {
+ "type" : "boolean"
+ },
+ "waitRecording" : {
+ "type" : "boolean"
+ },
+ "audioOnly" : {
+ "type" : "boolean"
+ },
+ "hiddenElements" : {
+ "uniqueItems" : true,
+ "type" : "array",
+ "items" : {
+ "type" : "string",
+ "enum" : [ "TOP_BAR", "CHAT", "ACTIVITIES", "FILES", "ACTION_MENU", "POLL_MENU", "SCREEN_SHARING", "WHITEBOARD", "MICROPHONE_STATUS", "USER_COUNT" ]
+ }
+ },
+ "files" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/RoomFileDTO"
+ }
+ },
+ "public" : {
+ "type" : "boolean"
}
}
},
- "FileExplorerObject" : {
+ "RoomFileDTO" : {
"type" : "object",
"properties" : {
- "roomHome" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/FileItemDTO"
- }
+ "id" : {
+ "type" : "integer",
+ "format" : "int64"
},
- "roomHomeSize" : {
+ "fileId" : {
"type" : "integer",
"format" : "int64"
},
- "userHome" : {
+ "wbIdx" : {
+ "type" : "integer",
+ "format" : "int64"
+ }
+ }
+ },
+ "UserDTO" : {
+ "type" : "object",
+ "properties" : {
+ "id" : {
+ "type" : "integer",
+ "format" : "int64"
+ },
+ "login" : {
+ "type" : "string"
+ },
+ "password" : {
+ "type" : "string"
+ },
+ "firstname" : {
+ "type" : "string"
+ },
+ "lastname" : {
+ "type" : "string"
+ },
+ "rights" : {
+ "uniqueItems" : true,
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/FileItemDTO"
+ "type" : "string",
+ "enum" : [ "ADMIN", "GROUP_ADMIN", "ADMIN_CONFIG", "ADMIN_CONNECTIONS", "ADMIN_BACKUP", "ADMIN_LABEL", "ROOM", "DASHBOARD", "LOGIN", "SOAP" ]
}
},
- "userHomeSize" : {
+ "languageId" : {
"type" : "integer",
"format" : "int64"
+ },
+ "address" : {
+ "$ref" : "#/components/schemas/Address"
+ },
+ "timeZoneId" : {
+ "type" : "string"
+ },
+ "externalId" : {
+ "type" : "string"
+ },
+ "externalType" : {
+ "type" : "string"
+ },
+ "pictureUri" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string",
+ "enum" : [ "USER", "LDAP", "OAUTH", "EXTERNAL", "CONTACT" ]
}
}
},
- "FileExplorerObjectWrapper" : {
+ "AppointmentDTOListWrapper" : {
"type" : "object",
"properties" : {
- "fileExplorerObject" : {
- "$ref" : "#/components/schemas/FileExplorerObject"
+ "appointmentDTO" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/AppointmentDTO"
+ }
}
},
"example" : {
- "fileExplorerObject" : {
- "userHome" : {
- "id" : 2,
- "name" : "OpenMeetings-NodeJS-Use-Case_preview.jpg",
- "hash" : "f802b727-5bfc-4273-8c90-939ea15bf388",
- "ownerId" : 1,
- "size" : 391449,
- "type" : "IMAGE",
- "width" : 2193,
- "height" : 1823
- },
- "roomHome" : [ {
- "id" : 4,
- "name" : "Folder1",
- "hash" : "fad982f0-2468-4b10-9b6c-be3648f55143",
- "roomId" : 7,
- "type" : "FOLDER"
- }, {
- "id" : 3,
- "name" : "browsers-768x768.png",
- "hash" : "91902c95-9944-435e-a54d-a2b64158758b",
- "roomId" : 7,
- "size" : 325415,
- "type" : "IMAGE",
- "width" : 768,
- "height" : 768
+ "appointmentDTO" : [ {
+ "connectedEvent" : false,
+ "deleted" : false,
+ "description" : "Comments",
+ "end" : "2021-09-23T12:31:00+1200",
+ "icalId" : "7507ab5d-81ec-458a-bdb1-48d102978e49",
+ "id" : 1,
+ "inserted" : "2021-09-19T11:31:37+1200",
+ "meetingMembers" : [ {
+ "id" : 1,
+ "user" : {
+ "address" : {
+ "country" : "NZ",
+ "deleted" : false,
+ "email" : "seba.wagner@gmail.com",
+ "id" : 1,
+ "inserted" : {
+ "date" : 29,
+ "day" : 0,
+ "hours" : 10,
+ "minutes" : 59,
+ "month" : 7,
+ "ownerField" : 1,
+ "seconds" : 49,
+ "time" : 1630191589000,
+ "timezoneOffset" : -720,
+ "year" : 121
+ }
+ },
+ "firstname" : "firstname",
+ "id" : 1,
+ "languageId" : 1,
+ "lastname" : "lastname",
+ "login" : "admin",
+ "rights" : [ "ROOM", "SOAP", "DASHBOARD", "ADMIN", "LOGIN" ],
+ "timeZoneId" : "Europe/Berlin",
+ "type" : "USER"
+ }
} ],
- "userHomeSize" : 1444970,
- "roomHomeSize" : 334311
- }
+ "owner" : {
+ "address" : {
+ "country" : "NZ",
+ "deleted" : false,
+ "email" : "seba.wagner@gmail.com",
+ "id" : 1,
+ "inserted" : {
+ "date" : 29,
+ "day" : 0,
+ "hours" : 10,
+ "minutes" : 59,
+ "month" : 7,
+ "ownerField" : 1,
+ "seconds" : 49,
+ "time" : 1630191589000,
+ "timezoneOffset" : -720,
+ "year" : 121
+ }
+ },
+ "firstname" : "firstname",
+ "id" : 1,
+ "languageId" : 1,
+ "lastname" : "lastname",
+ "login" : "admin",
+ "rights" : [ "ROOM", "SOAP", "DASHBOARD", "ADMIN", "LOGIN" ],
+ "timeZoneId" : "Europe/Berlin",
+ "type" : "USER"
+ },
+ "passwordProtected" : false,
+ "reminder" : "ICAL",
+ "reminderEmailSend" : false,
+ "room" : {
+ "allowRecording" : true,
+ "allowUserQuestions" : false,
+ "appointment" : true,
+ "audioOnly" : false,
+ "capacity" : 50,
+ "closed" : false,
+ "demo" : false,
+ "files" : [ ],
+ "hiddenElements" : [ "MICROPHONE_STATUS" ],
+ "id" : 11,
+ "moderated" : false,
+ "name" : "New Event",
+ "public" : false,
+ "type" : "CONFERENCE",
+ "waitModerator" : false,
+ "waitRecording" : false
+ },
+ "start" : "2021-09-23T11:31:00+1200",
+ "title" : "New Event"
+ } ]
}
},
"FileItemDTO" : {
"type" : "object",
"properties" : {
- "externalId" : {
- "type" : "string"
- },
- "externalType" : {
- "type" : "string"
- },
- "groupId" : {
+ "id" : {
"type" : "integer",
"format" : "int64"
},
- "hash" : {
+ "name" : {
"type" : "string"
},
- "height" : {
- "type" : "integer",
- "format" : "int32"
+ "hash" : {
+ "type" : "string"
},
- "id" : {
+ "parentId" : {
"type" : "integer",
"format" : "int64"
},
- "name" : {
- "type" : "string"
- },
- "ownerId" : {
+ "roomId" : {
"type" : "integer",
"format" : "int64"
},
- "parentId" : {
+ "groupId" : {
"type" : "integer",
"format" : "int64"
},
- "roomId" : {
+ "ownerId" : {
"type" : "integer",
"format" : "int64"
},
@@ -2914,6 +2956,12 @@
"type" : "integer",
"format" : "int64"
},
+ "externalId" : {
+ "type" : "string"
+ },
+ "externalType" : {
+ "type" : "string"
+ },
"type" : {
"type" : "string",
"enum" : [ "FOLDER", "IMAGE", "POLL_CHART", "PRESENTATION", "RECORDING", "VIDEO", "WML_FILE" ]
@@ -2921,21 +2969,22 @@
"width" : {
"type" : "integer",
"format" : "int32"
+ },
+ "height" : {
+ "type" : "integer",
+ "format" : "int32"
}
}
},
- "FileItemDTOListWrapper" : {
+ "FileItemDTOWrapper" : {
"type" : "object",
"properties" : {
"fileItemDTO" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/FileItemDTO"
- }
+ "$ref" : "#/components/schemas/FileItemDTO"
}
},
"example" : {
- "fileItemDTO" : [ {
+ "fileItemDTO" : {
"id" : 2,
"name" : "OpenMeetings-NodeJS-Use-Case_preview.jpg",
"hash" : "f802b727-5bfc-4273-8c90-939ea15bf388",
@@ -2944,18 +2993,21 @@
"type" : "IMAGE",
"width" : 2193,
"height" : 1823
- } ]
+ }
}
},
- "FileItemDTOWrapper" : {
+ "FileItemDTOListWrapper" : {
"type" : "object",
"properties" : {
"fileItemDTO" : {
- "$ref" : "#/components/schemas/FileItemDTO"
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/FileItemDTO"
+ }
}
},
"example" : {
- "fileItemDTO" : {
+ "fileItemDTO" : [ {
"id" : 2,
"name" : "OpenMeetings-NodeJS-Use-Case_preview.jpg",
"hash" : "f802b727-5bfc-4273-8c90-939ea15bf388",
@@ -2964,6 +3016,71 @@
"type" : "IMAGE",
"width" : 2193,
"height" : 1823
+ } ]
+ }
+ },
+ "FileExplorerObject" : {
+ "type" : "object",
+ "properties" : {
+ "userHome" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/FileItemDTO"
+ }
+ },
+ "roomHome" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/FileItemDTO"
+ }
+ },
+ "userHomeSize" : {
+ "type" : "integer",
+ "format" : "int64"
+ },
+ "roomHomeSize" : {
+ "type" : "integer",
+ "format" : "int64"
+ }
+ }
+ },
+ "FileExplorerObjectWrapper" : {
+ "type" : "object",
+ "properties" : {
+ "fileExplorerObject" : {
+ "$ref" : "#/components/schemas/FileExplorerObject"
+ }
+ },
+ "example" : {
+ "fileExplorerObject" : {
+ "userHome" : {
+ "id" : 2,
+ "name" : "OpenMeetings-NodeJS-Use-Case_preview.jpg",
+ "hash" : "f802b727-5bfc-4273-8c90-939ea15bf388",
+ "ownerId" : 1,
+ "size" : 391449,
+ "type" : "IMAGE",
+ "width" : 2193,
+ "height" : 1823
+ },
+ "roomHome" : [ {
+ "id" : 4,
+ "name" : "Folder1",
+ "hash" : "fad982f0-2468-4b10-9b6c-be3648f55143",
+ "roomId" : 7,
+ "type" : "FOLDER"
+ }, {
+ "id" : 3,
+ "name" : "browsers-768x768.png",
+ "hash" : "91902c95-9944-435e-a54d-a2b64158758b",
+ "roomId" : 7,
+ "size" : 325415,
+ "type" : "IMAGE",
+ "width" : 768,
+ "height" : 768
+ } ],
+ "userHomeSize" : 1444970,
+ "roomHomeSize" : 334311
}
}
},
@@ -3002,17 +3119,81 @@
} ]
}
},
- "Health" : {
+ "UserSearchResult" : {
"type" : "object",
"properties" : {
- "dbOk" : {
- "type" : "boolean"
+ "objectName" : {
+ "type" : "string"
+ },
+ "records" : {
+ "type" : "integer",
+ "format" : "int64"
},
+ "result" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/UserDTO"
+ }
+ },
+ "errorKey" : {
+ "type" : "string"
+ }
+ }
+ },
+ "UserSearchResultWrapper" : {
+ "type" : "object",
+ "properties" : {
+ "userSearchResult" : {
+ "$ref" : "#/components/schemas/UserSearchResult"
+ }
+ },
+ "example" : {
+ "userSearchResult" : {
+ "objectName" : "org.apache.openmeetings.db.entity.user.User",
+ "records" : 2,
+ "result" : [ {
+ "address" : {
+ "created" : 1631958373000,
+ "deleted" : false,
+ "country" : "NZ",
+ "mail" : "test@test.com"
+ },
+ "id" : 3,
+ "languageId" : 1,
+ "login" : "soapuser",
+ "rights" : [ "ROOM", "SOAP", "DASHBOARD", "ADMIN", "LOGIN" ],
+ "timeZoneId" : "Europe/Berlin",
+ "type" : "USER"
+ }, {
+ "address" : {
+ "created" : 1630191589000,
+ "deleted" : false,
+ "country" : "NZ",
+ "mail" : "seba.wagner@gmail.com"
+ },
+ "firstname" : "firstname",
+ "id" : 1,
+ "languageId" : 1,
+ "lastname" : "lastname",
+ "login" : "admin",
+ "rights" : [ "ROOM", "SOAP", "DASHBOARD", "ADMIN", "LOGIN" ],
+ "timeZoneId" : "Europe/Berlin",
+ "type" : "USER"
+ } ]
+ }
+ }
+ },
+ "Health" : {
+ "type" : "object",
+ "properties" : {
"inited" : {
"type" : "boolean"
},
"installed" : {
"type" : "boolean"
+ },
+ "dbOk" : {
+ "type" : "boolean"
}
}
},
@@ -3034,13 +3215,13 @@
"Info" : {
"type" : "object",
"properties" : {
- "buildDate" : {
+ "version" : {
"type" : "string"
},
"revision" : {
"type" : "string"
},
- "version" : {
+ "buildDate" : {
"type" : "string"
}
}
@@ -3060,107 +3241,51 @@
}
}
},
- "InvitationDTO" : {
+ "RecordingDTO" : {
"type" : "object",
"properties" : {
- "email" : {
- "type" : "string"
- },
- "firstname" : {
- "type" : "string"
- },
- "languageId" : {
+ "id" : {
"type" : "integer",
"format" : "int64"
},
- "lastname" : {
- "type" : "string"
- },
- "message" : {
+ "name" : {
"type" : "string"
},
- "password" : {
+ "hash" : {
"type" : "string"
},
- "passwordProtected" : {
- "type" : "boolean"
- },
"roomId" : {
"type" : "integer",
"format" : "int64"
},
- "subject" : {
+ "status" : {
"type" : "string"
},
- "valid" : {
- "type" : "string",
- "enum" : [ "ONE_TIME", "PERIOD", "ENDLESS" ]
- },
- "validFrom" : {
- "type" : "string"
+ "interview" : {
+ "type" : "boolean"
},
- "validTo" : {
- "type" : "string"
- }
- }
- },
- "MeetingMemberDTO" : {
- "type" : "object",
- "properties" : {
- "id" : {
- "type" : "integer",
- "format" : "int64"
+ "start" : {
+ "type" : "string",
+ "format" : "date-time"
},
- "user" : {
- "$ref" : "#/components/schemas/UserDTO"
- }
- }
- },
- "RecordingDTO" : {
- "type" : "object",
- "properties" : {
"end" : {
"type" : "string",
"format" : "date-time"
},
- "externalType" : {
- "type" : "string"
- },
- "hash" : {
- "type" : "string"
- },
- "height" : {
+ "width" : {
"type" : "integer",
"format" : "int32"
},
- "id" : {
+ "height" : {
"type" : "integer",
- "format" : "int64"
- },
- "interview" : {
- "type" : "boolean"
- },
- "name" : {
- "type" : "string"
+ "format" : "int32"
},
"ownerId" : {
"type" : "integer",
"format" : "int64"
},
- "roomId" : {
- "type" : "integer",
- "format" : "int64"
- },
- "start" : {
- "type" : "string",
- "format" : "date-time"
- },
- "status" : {
+ "externalType" : {
"type" : "string"
- },
- "width" : {
- "type" : "integer",
- "format" : "int32"
}
}
},
@@ -3190,89 +3315,31 @@
} ]
}
},
- "RoomDTO" : {
- "type" : "object",
- "properties" : {
- "allowRecording" : {
- "type" : "boolean"
- },
- "allowUserQuestions" : {
- "type" : "boolean"
- },
- "appointment" : {
- "type" : "boolean"
- },
- "audioOnly" : {
- "type" : "boolean"
- },
- "capacity" : {
- "type" : "integer",
- "format" : "int64"
- },
- "closed" : {
- "type" : "boolean"
- },
- "comment" : {
- "type" : "string"
- },
- "confno" : {
- "type" : "string"
- },
- "demo" : {
- "type" : "boolean"
- },
- "demoTime" : {
- "type" : "integer",
- "format" : "int32"
- },
- "externalId" : {
- "type" : "string"
- },
- "externalType" : {
- "type" : "string"
- },
- "files" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/RoomFileDTO"
- }
- },
- "hiddenElements" : {
- "uniqueItems" : true,
- "type" : "array",
- "items" : {
- "type" : "string",
- "enum" : [ "TOP_BAR", "CHAT", "ACTIVITIES", "FILES", "ACTION_MENU", "POLL_MENU", "SCREEN_SHARING", "WHITEBOARD", "MICROPHONE_STATUS", "USER_COUNT" ]
- }
- },
- "id" : {
- "type" : "integer",
- "format" : "int64"
- },
- "moderated" : {
- "type" : "boolean"
- },
- "name" : {
- "type" : "string"
- },
- "public" : {
- "type" : "boolean"
- },
- "redirectUrl" : {
- "type" : "string"
- },
- "tag" : {
- "type" : "string"
- },
- "type" : {
- "type" : "string",
- "enum" : [ "CONFERENCE", "PRESENTATION", "INTERVIEW" ]
- },
- "waitModerator" : {
- "type" : "boolean"
- },
- "waitRecording" : {
- "type" : "boolean"
+ "RoomDTOWrapper" : {
+ "type" : "object",
+ "properties" : {
+ "roomDTO" : {
+ "$ref" : "#/components/schemas/RoomDTO"
+ }
+ },
+ "example" : {
+ "roomDTO" : {
+ "id" : 2,
+ "name" : "Public Conference Room [install.room.public.conference]",
+ "comment" : "",
+ "type" : "CONFERENCE",
+ "capacity" : 32,
+ "appointment" : false,
+ "isPublic" : true,
+ "demo" : false,
+ "closed" : false,
+ "moderated" : false,
+ "waitModerator" : false,
+ "allowUserQuestions" : true,
+ "allowRecording" : true,
+ "waitRecording" : false,
+ "audioOnly" : false,
+ "hiddenElements" : "MICROPHONE_STATUS"
}
}
},
@@ -3357,156 +3424,47 @@
} ]
}
},
- "RoomDTOWrapper" : {
- "type" : "object",
- "properties" : {
- "roomDTO" : {
- "$ref" : "#/components/schemas/RoomDTO"
- }
- },
- "example" : {
- "roomDTO" : {
- "id" : 2,
- "name" : "Public Conference Room [install.room.public.conference]",
- "comment" : "",
- "type" : "CONFERENCE",
- "capacity" : 32,
- "appointment" : false,
- "isPublic" : true,
- "demo" : false,
- "closed" : false,
- "moderated" : false,
- "waitModerator" : false,
- "allowUserQuestions" : true,
- "allowRecording" : true,
- "waitRecording" : false,
- "audioOnly" : false,
- "hiddenElements" : "MICROPHONE_STATUS"
- }
- }
- },
- "RoomFileDTO" : {
- "type" : "object",
- "properties" : {
- "fileId" : {
- "type" : "integer",
- "format" : "int64"
- },
- "id" : {
- "type" : "integer",
- "format" : "int64"
- },
- "wbIdx" : {
- "type" : "integer",
- "format" : "int64"
- }
- }
- },
- "RoomOptionsDTO" : {
+ "InvitationDTO" : {
"type" : "object",
"properties" : {
- "allowRecording" : {
- "type" : "boolean"
- },
- "allowSameURLMultipleTimes" : {
- "type" : "boolean"
+ "email" : {
+ "type" : "string"
},
- "externalRoomId" : {
+ "firstname" : {
"type" : "string"
},
- "externalType" : {
+ "lastname" : {
"type" : "string"
},
- "moderator" : {
- "type" : "boolean"
+ "message" : {
+ "type" : "string"
},
- "recordingId" : {
- "type" : "integer",
- "format" : "int64"
+ "subject" : {
+ "type" : "string"
},
"roomId" : {
"type" : "integer",
"format" : "int64"
},
- "showAudioVideoTest" : {
+ "passwordProtected" : {
"type" : "boolean"
- }
- }
- },
- "ServiceResult" : {
- "type" : "object",
- "properties" : {
- "message" : {
- "type" : "string"
},
- "type" : {
+ "password" : {
"type" : "string"
- }
- }
- },
- "ServiceResultWrapper" : {
- "type" : "object",
- "properties" : {
- "serviceResult" : {
- "$ref" : "#/components/schemas/ServiceResult"
- }
- },
- "example" : {
- "serviceResult" : {
- "message" : "9dbb6907-61fc-42c0-a2b2-5dbfbe053ac6",
- "type" : "SUCCESS"
- }
- }
- },
- "UserDTO" : {
- "type" : "object",
- "properties" : {
- "address" : {
- "$ref" : "#/components/schemas/Address"
},
- "externalId" : {
- "type" : "string"
+ "valid" : {
+ "type" : "string",
+ "enum" : [ "ONE_TIME", "PERIOD", "ENDLESS" ]
},
- "externalType" : {
+ "validFrom" : {
"type" : "string"
},
- "firstname" : {
+ "validTo" : {
"type" : "string"
},
- "id" : {
- "type" : "integer",
- "format" : "int64"
- },
"languageId" : {
"type" : "integer",
"format" : "int64"
- },
- "lastname" : {
- "type" : "string"
- },
- "login" : {
- "type" : "string"
- },
- "password" : {
- "type" : "string"
- },
- "pictureUri" : {
- "type" : "string"
- },
- "rights" : {
- "uniqueItems" : true,
- "type" : "array",
- "items" : {
- "type" : "string",
- "enum" : [ "ADMIN", "GROUP_ADMIN", "ADMIN_CONFIG", "ADMIN_CONNECTIONS", "ADMIN_BACKUP", "ADMIN_LABEL", "ROOM", "DASHBOARD", "LOGIN", "SOAP" ]
- }
- },
- "timeZoneId" : {
- "type" : "string"
- },
- "type" : {
- "type" : "string",
- "enum" : [ "USER", "LDAP", "OAUTH", "EXTERNAL", "CONTACT" ]
}
}
},
@@ -3596,67 +3554,60 @@
}
}
},
- "UserSearchResult" : {
+ "ExternalUserDTO" : {
"type" : "object",
"properties" : {
- "errorKey" : {
+ "login" : {
"type" : "string"
},
- "objectName" : {
+ "firstname" : {
"type" : "string"
},
- "records" : {
- "type" : "integer",
- "format" : "int64"
+ "lastname" : {
+ "type" : "string"
},
- "result" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/UserDTO"
- }
+ "profilePictureUrl" : {
+ "type" : "string"
+ },
+ "email" : {
+ "type" : "string"
+ },
+ "externalId" : {
+ "type" : "string"
+ },
+ "externalType" : {
+ "type" : "string"
}
}
},
- "UserSearchResultWrapper" : {
+ "RoomOptionsDTO" : {
"type" : "object",
"properties" : {
- "userSearchResult" : {
- "$ref" : "#/components/schemas/UserSearchResult"
- }
- },
- "example" : {
- "userSearchResult" : {
- "objectName" : "org.apache.openmeetings.db.entity.user.User",
- "records" : 2,
- "result" : [ {
- "address" : {
- "created" : 1631958373000,
- "deleted" : false,
- "country" : "NZ",
- "mail" : "test@test.com"
- },
- "id" : 3,
- "languageId" : 1,
- "login" : "soapuser",
- "rights" : [ "ROOM", "SOAP", "DASHBOARD", "ADMIN", "LOGIN" ],
- "timeZoneId" : "Europe/Berlin",
- "type" : "USER"
- }, {
- "address" : {
- "created" : 1630191589000,
- "deleted" : false,
- "country" : "NZ",
- "mail" : "seba.wagner@gmail.com"
- },
- "firstname" : "firstname",
- "id" : 1,
- "languageId" : 1,
- "lastname" : "lastname",
- "login" : "admin",
- "rights" : [ "ROOM", "SOAP", "DASHBOARD", "ADMIN", "LOGIN" ],
- "timeZoneId" : "Europe/Berlin",
- "type" : "USER"
- } ]
+ "roomId" : {
+ "type" : "integer",
+ "format" : "int64"
+ },
+ "externalRoomId" : {
+ "type" : "string"
+ },
+ "externalType" : {
+ "type" : "string"
+ },
+ "recordingId" : {
+ "type" : "integer",
+ "format" : "int64"
+ },
+ "moderator" : {
+ "type" : "boolean"
+ },
+ "showAudioVideoTest" : {
+ "type" : "boolean"
+ },
+ "allowSameURLMultipleTimes" : {
+ "type" : "boolean"
+ },
+ "allowRecording" : {
+ "type" : "boolean"
}
}
}
diff --git a/swagger/index.html b/swagger/index.html
index c673b997..40f3fdfd 100644
--- a/swagger/index.html
+++ b/swagger/index.html
@@ -39,7 +39,7 @@
window.onload = function() {
// Begin Swagger UI call region
const ui = SwaggerUIBundle({
- url: "apache-openmeetings-7.2.0-swagger.json",
+ url: "apache-openmeetings-9.0.0-swagger.json",
dom_id: '#swagger-ui',
deepLinking: true,
presets: [