Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

support: how to set correct content type in generated oas3

See original GitHub issue

Endpoint returning text/plain has a corresponding tsoa generated oas3 content set as application/json.

Is there any way to have a accurate content in generated swagger.json?

Sorting

I’m submitting a …
- bug report
- feature request
- support request
I confirm that I
- used the search to make sure that a similar issue hasn’t already been submit

Expected Behavior

                                        "200": {
                                                "description": "Ok",
                                                "content": {
-                                                       "application/json": {
+                                                       "text/plain": {
                                                                "schema": {
-                                                                       "type": "number",
-                                                                       "enum": [
-                                                                               null
-                                                                       ],
-                                                                       "nullable": true
+                                                                       "type": "string"
                                                                }
                                                        }
                                                }

Current Behavior

                        }
+               },
+               "/.well-known/security.txt": {
+                       "get": {
+                               "operationId": "GetSecurityTxt",
+                               "responses": {
+                                       "200": {
+                                               "description": "Ok",
+                                               "content": {
+                                                       "application/json": {
+                                                               "schema": {
+                                                                       "type": "number",
+                                                                       "enum": [
+                                                                               null
+                                                                       ],
+                                                                       "nullable": true
+                                                               }
+                                                       }
+                                               }
+                                       }
+                               },
+                               "security": [],
+                               "parameters": []
+                       }
                }

Possible Solution

No idea

Steps to Reproduce

--- /dev/null
+++ b/src/well-known/wellKnownController.ts
@@ -0,0 +1,16 @@
+import { Response as ExResponse, Request as ExRequest } from 'express';
+import { Controller, Get, Request, Route } from 'tsoa';
+import { WellKnownService } from './wellKnownService';
+
+@Route('/.well-known')
+export class WellKnownController extends Controller {
+    @Get('/security.txt')
+    async getSecurityTxt(@Request() request: ExRequest): Promise<null> {
+        const securityTxt = await new WellKnownService().getSecurityTxt();
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const res = (<any>request).res as ExResponse;
+        res.type('.txt');
+        res.send(securityTxt);
+        return null;
+    }
+}