Add support for using @Hidden() decorator on controllers #498
Conversation
…of its endpoints
| const parameterMetadata = new MetadataGenerator('./tests/fixtures/controllers/hiddenController.ts').Generate(); | ||
| const controller = parameterMetadata.controllers[0]; | ||
|
|
||
| it('should generate hidden methods', () => { |
There was a problem hiding this comment.
I'm a little confused by the message 'should generate hidden methods'. Do you mean 'should generate metadata for the hidden methods even though it won't generate swagger definitions'?
Speaking of which, can you add a unit test that confirms that the swagger output does not contain the methods of the hidden controller?
I'm asking because I believe that is the primary goal of the @Hidden decorator, right?
You'll need to do those in two places:
- For Swagger (i.e. OpenAPI v2)
tests\unit\swagger\definitionsGeneration\definitions.spec.ts - For OpenAPI 3:
tests\unit\swagger\schemaDetails3.spec.ts
Other than that, this is a great PR. Thank you for adding to the readme. Well done! :)
There was a problem hiding this comment.
Sure thing, I can make those changes. The test message was just a victim of copy & paste from the existing @Hidden tests.
There was a problem hiding this comment.
For Swagger (i.e. OpenAPI v2)
tests\unit\swagger\definitionsGeneration\definitions.spec.ts
Can you provide a little more guidance on this? I don't see any paths tests in that file.
There was a problem hiding this comment.
You're correct. I just checked and there are not any path tests in that file. So I'm not sure where it's best to put those tests, but we do need to make sure that this decorator works for both Swagger 2.0 and Open API 3.0
| expect(specHiddenMethod.paths).to.have.keys(['/Controller/normalGetMethod']); | ||
| }); | ||
|
|
||
| it('should not contain paths for hidden controller', () => { |
There was a problem hiding this comment.
So basically the same thing you did here but with SpecGenerator2 instead. And just put it anywhere other than this file.
|
@dgreene1 should be all set now |
Adds support for the
@Hidden()decorator to controllers which will hide all of its endpoints.All Submissions:
If this is a new feature submission:
Potential Problems With The Approach
None that I can think of.