refactor(types): improved security scheme

[xTCry]

PR Checklist

Please check if your PR fulfills the following requirements:

• The commit message follows our guidelines: https://github.com/nestjs/nest/blob/master/CONTRIBUTING.md
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

• Bugfix
• Feature
• Code style update (formatting, local variables)
• Refactoring (no functional changes, no api changes)
• Build related changes
• CI related changes
• Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

• Yes
• No

Other information

[jmcdo29]

This would make it a breaking change, but would it make more sense to bring the name to be the first parameter instead of the options?

[xTCry]

@jmcdo29 , yep, you're right. Fixed

[jmcdo29]

Making the change I mentioned above here so it would be

Suggested change

	options: Partial<Omit<HttpSchemeObject, 'type'>> = {},
	name = 'basic'
	name = 'basic',
	options: Partial<Omit<HttpSchemeObject, 'type'>> = {}

[xTCry]

@jmcdo29, Yes, this can also be added, but is it better in a minor update?..

[xTCry]

@jmcdo29 Yes, I agree. But this is likely to be a breaking change

[micalevisk]

@xTCry I guess we could keep both and mark the old one as deprecated

[kamilmysliwiec]

What's the reason for this change?

[xTCry]

I apologize for the long answer.

What's the reason for this change?
@kamilmysliwiec

This is a typing improvement, based on the official Swagger documentation. It is also simplified to access some methods without specifying unnecessary parameters.

For example, why write .addApiKey({ type: 'apiKey'}, 'key1'), if the name of the method speaks for itself that it accepts only the type apiKey.
Also, HttpSchemaObject accepts bearerFormat, OpenIdConnectSchemeObject can use openIdConnectUrl. But they are not used in other ways