MIME based responses in OpenAPI/Swagger

[js-lowes]

Sorting

• I'm submitting a ...

  • [ ] bug report
  • [ ] feature request
  • [X] support request

• I confirm that I

  • [X] used the search to make sure that a similar issue hasn't already been submit
  • I looked into the examples here: https://github.com/lukeautry/tsoa/blob/b0cd9533821a7ed76111665ef01b655b62a775e3/tests/fixtures/controllers/mediaTypeController.ts
  • I also looked at the discussion here and the test cases provided: https://github.com/lukeautry/tsoa/pull/1140/files#diff-51253bc4a60fd1efb67a29ed0ea89f18f674dfb7e713f211e5cb4001361bf696

Expected Behavior

Wish (but unable to generate b/c of error):

{
    ...
    "/base-path/{id}": {
        "get": {
            "tags": [],
            "summary": "Get Detailed Data",
            "operationId": "Foo_bar_v1",
            "parameters": [],
            "responses": {
                "200": {
                    "description": "Successfully retrieved list",
                    "content": {
                        "application/vnd.foo.bar.v1+json": {
                            "schema": {
                                "type": "#/components/schemas/Something1"
                            }
                        },
                        "application/vnd.moo.boo.v1+json": {
                            "schema": {
                                "$ref": "#/components/schemas/Something2"
                            }
                        }
                    }
                },
            }
        }
    }
    ...
}

Current Behavior

My code looks like the following:

import { Consumes, Controller, Get, Path, Produces, Route } from 'tsoa';

@Route('base-path')
class FooBarController extends Controller {
    @Get('{id}')
    @Consumes('application/vnd.foo.bar.v1+json')
    @Produces('application/vnd.foo.bar.v1+json')
    public getFooBar(@Path() id: string): object {
        this.setStatus(200);
        this.setHeader('Content-Type', 'application/vnd.foo.bar.v1+json');
        return { fooBar: id };
    }
    @Get('{id}')
    @Consumes('application/vnd.moo.boo.v1+json')
    @Produces('application/vnd.moo.boo.v1+json')
    public getMooBoo(@Path() id: string): object {
        this.setStatus(200);
        this.setHeader('Content-Type', 'application/vnd.moo.boo.v1+json');
        return { mooBoo: id };
    }
}
export { FooBarController };

And I get the following error:

$ tsoa -c tsoaConfig.json spec-and-routes
Generate routes error.
 GenerateMetadataError: Duplicate method signature @get(base-path/{id}) found in controllers: FooBarController#getFooBar, FooBarController#getMooBoo

Possible Solution

I am not sure if this is already supported and I cannot find the example or if this type of swagger response is not supported. @mrl5 was the original author, so maybe they can provide some more insight?

Steps to Reproduce

Copy the code, it should work fine on your machine.

Context (Environment)

Version of the library: 5.1.1 Version of NodeJS: v18.15.0

• Confirm you were using yarn not npm: [X]

Detailed Description

At this moment, I am unsure if a change is required.

Breaking change?

At this moment, I am unsure if a change is required.

[github-actions[bot]]

Hello there js-lowes 👋

Thank you for opening your very first issue in this project.

We will try to get back to you as soon as we can.👀

[github-actions[bot]]

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days