Skip to content

Commit

Permalink
Remove keySize override from createRsaKeyOptions (#13684)
Browse files Browse the repository at this point in the history
We define `keySize` in `createRsaKeyOptions` but we don't have to since it's already
defined in `createKeyOptions` which this inherits from. Having it defined in two places
adds confusion (see #13522 (comment) as an example).

This commit just removes the redefined parameter and updates the base parameter's
doc comment to be clearer.

Fixes #13589
  • Loading branch information
maorleger authored Feb 10, 2021
1 parent 5fbd6cd commit 41104c5
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 6 deletions.
1 change: 0 additions & 1 deletion sdk/keyvault/keyvault-keys/review/keyvault-keys.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@ export interface CreateOctKeyOptions extends CreateKeyOptions {
// @public
export interface CreateRsaKeyOptions extends CreateKeyOptions {
hsm?: boolean;
keySize?: number;
publicExponent?: number;
}

Expand Down
6 changes: 1 addition & 5 deletions sdk/keyvault/keyvault-keys/src/keysModels.ts
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ export interface CreateKeyOptions extends coreHttp.OperationOptions {
*/
readonly expiresOn?: Date;
/**
* Size of the key
* The key size in bits. For example: 2048, 3072, or 4096 for RSA.
*/
keySize?: number;
}
Expand Down Expand Up @@ -345,10 +345,6 @@ export interface CreateEcKeyOptions extends CreateKeyOptions {
* passed to {@link createRsaKey}
*/
export interface CreateRsaKeyOptions extends CreateKeyOptions {
/**
* The key size in bits. For example: 2048, 3072, or 4096 for RSA.
*/
keySize?: number;
/**
* Whether to import as a hardware key (HSM) or software key.
*/
Expand Down

0 comments on commit 41104c5

Please sign in to comment.