Hidden Controller referencing model should not generate model

First of all, we love using tsoa. Thank you!

Today, when a hidden controller references a model / schema, it is included in the final output. This does not seem like it would be intended behavior.

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

When running yarn tsoa spec, you should get this:

components:
    examples: {}
    headers: {}
    parameters: {}
    requestBodies: {}
    responses: {}
    schemas: {}
    securitySchemes:
        basic:
            scheme: basic
            type: http
info:
    title: api
    version: 0.1.0
    contact: {}
openapi: 3.0.0
paths: {}
servers:
    -
        url: /v0

Current Behavior

When running yarn tsoa spec, you get this:

components:
    examples: {}
    headers: {}
    parameters: {}
    requestBodies: {}
    responses: {}
    schemas:
        TestPayload:
            properties:
                key:
                    type: string
            required:
                - key
            type: object
    securitySchemes:
        basic:
            scheme: basic
            type: http
info:
    title: api
    version: 0.1.0
    contact: {}
openapi: 3.0.0
paths: {}
servers:
    -
        url: /v0

Possible Solution

Ideally, it would be possible to use @Hidden on the model or the @ignore jsdoc, but neither seem to work for me.

Steps to Reproduce

Controller example:

import { Hidden, Route, Controller, Get } from 'tsoa';

type TestPayload = {
  key: string;
};

@Hidden()
@Route('test')
export class TestController extends Controller {
  @Get()
  async route(): Promise<TestPayload> {
    return {
      key: 'value',
    };
  }
}

Context (Environment)

Version of the library: Version of NodeJS:

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

Detailed Description

Should not find any metadata from hidden controllers

Breaking change?

[jackey8616]

@marcusglowe The feature you want is, Hiding models which been use in a Hidden controller ?

I’m planning to send a PR about this.
I think we need discuss more detail about this, and find out some way to implement this.

[marcusglowe]

Yes that’s right!