added generated swagger file (#1407)

* added generated swagger file

* trying to change the name

* added tags

* fixed tags

* prettier fix

Author: Deepak Prabhakara

.prettierignore

@@ -2,3 +2,4 @@
 *.hbs
 src/_processor/services/templates/**
 postman/Retraced.postman_collection.json
+swagger.json

deploy/Dockerfile-slim

@@ -1,4 +1,4 @@
-ARG NODEJS_IMAGE=node:20.13.0-alpine3.19
+ARG NODEJS_IMAGE=node:20.13.1-alpine3.19
 ARG ALPINE_IMAGE=alpine:3.19
 
 # # #

package.json

@@ -83,7 +83,7 @@
     "typescript": "5.4.5"
   },
   "scripts": {
-    "swagger": "tsoa spec",
+    "swagger": "tsoa spec && cp build/swagger.json .",
     "routes": "tsoa routes",
     "prebuild": "rimraf build",
     "build": "npm run swagger && npm run routes && tsc && cp build/src/retracedctl.js build/src/retracedctl && chmod +x build/src/retracedctl",

src/controllers/AdminController.ts

@@ -11,6 +11,7 @@ import {
   Controller,
   Put,
   Request,
+  Tags,
 } from "tsoa";
 import express from "express";
 
@@ -42,6 +43,7 @@ import { checkAdminAccessUnwrapped } from "../security/helpers";
 import uniqueId from "../models/uniqueId";
 
 @Route("admin/v1")
+@Tags("Admin API")
 export class AdminAPI extends Controller {
   private readonly adminTokenStore: AdminTokenStore;
 

src/controllers/EnterpriseController.ts

@@ -1,4 +1,4 @@
-import { Body, Controller, Request, Example, Header, Post, Route, SuccessResponse } from "tsoa";
+import { Body, Controller, Request, Example, Header, Post, Route, SuccessResponse, Tags } from "tsoa";
 import { Request as Req } from "express";
 
 import {
@@ -56,6 +56,7 @@ import enterpriseSearchAdHoc from "../handlers/enterprise/searchAdHoc";
 */
 
 @Route("enterprise/v1")
+@Tags("Enterprise API")
 export class EnterpriseAPI extends Controller {
   /**
    * Query events with GraphQL

src/controllers/PublisherController.ts

@@ -11,6 +11,7 @@ import {
   SuccessResponse,
   Controller,
   Example,
+  Tags,
 } from "tsoa";
 import {
   defaultEventCreater,
@@ -34,6 +35,7 @@ import { graphQL } from "../handlers/graphql";
 import { GraphQLRequest, GraphQLResp } from "../handlers/graphql/index";
 
 @Route("publisher/v1")
+@Tags("Publisher API")
 export class PublisherAPI extends Controller {
   private readonly eventCreater: EventCreater;