Add decorator to allow specification of the schema type name

[zroadhouse-rigup]

I'm submitting a...

[ ] Regression 
[ ] Bug report
[X] Feature request
[ ] Documentation issue or request
[ ] Support request => Please do not submit support request here, instead post your question on Stack Overflow.

Current behavior

The Open API schema type name is the same as the type name.

Expected behavior

Add a decorator to allow specification of a schema type name that is different from the type name.

For example:

@ApiSchema({ name: 'MyType' })
class MyTypeDto {
}

Minimal reproduction of the problem with instructions

What is the motivation / use case for changing the behavior?

Type names often have suffixes such as Entity or Dto that represent internal
implementation choices. Allowing explicit specification of the schema type name
would avoid leaking these choices into the public interface.

Environment

Nest swagger version: 4.5.12

 
For Tooling issues:
- Node version: 12.13  
- Platform: Mac 

Others:

[kamilmysliwiec]

Would you like to create a PR for this?

[libertysoftware]

Would you like to create a PR for this?

May I try?

[zroadhouse-rigup]

@libertysoftware - go for it! I likely won't have time to get to it in the near future.

[radacovsky]

See the PR here
#983

[zroadhouse-rigup]

On review, I'm thinking name should actually be title to be consistent with both the OpenAPI and JSON schema specifications. EDIT: there are other places in the annotations such as enumName so perhaps name is fine?)

And as we're adding that, we should add the other properties that are tied to the schema object that can't be set via annotations on the properties:

• description
• externalDocs
• deprecated

After creating this issue, I found that I really wanted at least description where now I can only provide documentation comments on the type.

[pbn4]

Hello, what's the status of this issue?

[radacovsky]

The original feature is implemented in my fork but the additional requested features not. I think my PR is still not merged.

[zroadhouse-rigup]

Removed my comment from #983 in case it was blocking getting your change merged @radacovsky . Makes sense that we could file separate tickets for the other requested features.

[kamilmysliwiec]

Let's track this here #983