Cleanup event registry REST Swagger doc naming

flowable · Aug 18, 2023 · b08c908 · b08c908
1 parent 8eadc25
commit b08c908
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 21 deletions.
diff --git a/modules/flowable-app-rest/src/main/resources/static/docs/index.html b/modules/flowable-app-rest/src/main/resources/static/docs/index.html
@@ -53,12 +53,6 @@
           case "specfile/eventregistry/flowable-swagger-eventregistry.json":
               api = "eventregistry";
               break;
-          case "specfile/form/flowable-swagger-form.json":
-              api = "form";
-              break;
-          case "specfile/content/flowable-swagger-content.json":
-              api = "content";
-              break;
           case "specfile/app/flowable-swagger-app.json":
               api = "app";
               break;
@@ -129,12 +123,6 @@
               case "eventregistry":
                   specFile = "specfile/eventregistry/flowable-swagger-eventregistry.json";
                   break;
-              case "form":
-                  specFile = "specfile/form/flowable-swagger-form.json";
-                  break;
-              case "content":
-                  specFile = "specfile/content/flowable-swagger-content.json";
-                  break;
               case "app":
                   specFile = "specfile/app/flowable-swagger-app.json";
                   break;
@@ -167,8 +155,6 @@
           <option value="dmn">DMN</option>
           <option value="cmmn">CMMN</option>
           <option value="eventregistry">Event Registry</option>
-          <option value="form">Form</option>
-          <option value="content">Content</option>
           <option value="app">App</option>
           <option value="external-worker">External Worker</option>
         </select>

diff --git a/...ava/org/flowable/eventregistry/rest/service/api/repository/ChannelDefinitionResource.java b/...ava/org/flowable/eventregistry/rest/service/api/repository/ChannelDefinitionResource.java
@@ -41,10 +41,10 @@ public class ChannelDefinitionResource extends BaseEventDefinitionResource {
     @Autowired(required=false)
     protected EventRepositoryService eventRepositoryService;
 
-    @ApiOperation(value = "Get a channel definition", tags = { "Case Definitions" })
+    @ApiOperation(value = "Get a channel definition", tags = { "Channel Definitions" })
     @ApiResponses(value = {
             @ApiResponse(code = 200, message = "Indicates request was successful and the channel definitions are returned"),
-            @ApiResponse(code = 404, message = "Indicates the requested event definition was not found.")
+            @ApiResponse(code = 404, message = "Indicates the requested channel definition was not found.")
     })
     @GetMapping(value = "/event-registry-repository/channel-definitions/{channelDefinitionId}", produces = "application/json")
     public ChannelDefinitionResponse getChannelDefinition(@ApiParam(name = "channelDefinitionId") @PathVariable String channelDefinitionId) {

diff --git a/...able/eventregistry/rest/service/api/repository/ChannelDefinitionResourceDataResource.java b/...able/eventregistry/rest/service/api/repository/ChannelDefinitionResourceDataResource.java
@@ -35,10 +35,10 @@
 @Api(tags = { "Channel Definitions" }, description = "Manage Channel Definitions", authorizations = { @Authorization(value = "basicAuth") })
 public class ChannelDefinitionResourceDataResource extends BaseDeploymentResourceDataResource {
 
-    @ApiOperation(value = "Get a channel definition resource content", tags = { "Case Definitions" })
+    @ApiOperation(value = "Get a channel definition resource content", tags = { "Channel Definitions" })
     @ApiResponses(value = {
             @ApiResponse(code = 200, message = "Indicates both channel definition and resource have been found and the resource data has been returned."),
-            @ApiResponse(code = 404, message = "Indicates the requested channel definition was not found or there is no resource with the given id present in the case definition. The status-description contains additional information.")
+            @ApiResponse(code = 404, message = "Indicates the requested channel definition was not found or there is no resource with the given id present in the channel definition. The status-description contains additional information.")
     })
     @GetMapping(value = "/event-registry-repository/channel-definitions/{channelDefinitionId}/resourcedata")
     public byte[] getChannelDefinitionResource(@ApiParam(name = "channelDefinitionId") @PathVariable String channelDefinitionId, HttpServletResponse response) {

diff --git a/.../java/org/flowable/eventregistry/rest/service/api/repository/EventDefinitionResource.java b/.../java/org/flowable/eventregistry/rest/service/api/repository/EventDefinitionResource.java
@@ -41,7 +41,7 @@ public class EventDefinitionResource extends BaseEventDefinitionResource {
     @Autowired(required=false)
     protected EventRepositoryService eventRepositoryService;
 
-    @ApiOperation(value = "Get an event definition", tags = { "Case Definitions" })
+    @ApiOperation(value = "Get an event definition", tags = { "Event Definitions" })
     @ApiResponses(value = {
             @ApiResponse(code = 200, message = "Indicates request was successful and the event definitions are returned"),
             @ApiResponse(code = 404, message = "Indicates the requested event definition was not found.")

diff --git a/...owable/eventregistry/rest/service/api/repository/EventDefinitionResourceDataResource.java b/...owable/eventregistry/rest/service/api/repository/EventDefinitionResourceDataResource.java
@@ -35,10 +35,10 @@
 @Api(tags = { "Event Definitions" }, description = "Manage Event Definitions", authorizations = { @Authorization(value = "basicAuth") })
 public class EventDefinitionResourceDataResource extends BaseDeploymentResourceDataResource {
 
-    @ApiOperation(value = "Get an event definition resource content", tags = { "Case Definitions" })
+    @ApiOperation(value = "Get an event definition resource content", tags = { "Event Definitions" })
     @ApiResponses(value = {
             @ApiResponse(code = 200, message = "Indicates both event definition and resource have been found and the resource data has been returned."),
-            @ApiResponse(code = 404, message = "Indicates the requested event definition was not found or there is no resource with the given id present in the case definition. The status-description contains additional information.")
+            @ApiResponse(code = 404, message = "Indicates the requested event definition was not found or there is no resource with the given id present in the event definition. The status-description contains additional information.")
     })
     @GetMapping(value = "/event-registry-repository/event-definitions/{eventDefinitionId}/resourcedata")
     public byte[] getEventDefinitionResource(@ApiParam(name = "eventDefinitionId") @PathVariable String eventDefinitionId, HttpServletResponse response) {