@google-cloud/kms - npm Package Compare versions

Comparing version 1.6.0 to 1.6.1

CHANGELOG.md

@@ -7,2 +7,9 @@ # Changelog
 
+### [1.6.1](https://www.github.com/googleapis/nodejs-kms/compare/v1.6.0...v1.6.1) (2020-01-05)
+
+
+### Bug Fixes
+
+* updated proto annotations ([#258](https://www.github.com/googleapis/nodejs-kms/issues/258)) ([b05916b](https://www.github.com/googleapis/nodejs-kms/commit/b05916b35b9f280ba8cbfea5044d52137bd9081c))
+
 ## [1.6.0](https://www.github.com/googleapis/nodejs-kms/compare/v1.5.3...v1.6.0) (2019-12-31)
@@ -9,0 +16,0 @@

package.json

 {
   "name": "@google-cloud/kms",
   "description": "Google Cloud Key Management Service (KMS) API client for Node.js",
-  "version": "1.6.0",
+  "version": "1.6.1",
   "license": "Apache-2.0",
@@ -6,0 +6,0 @@ "author": "Google LLC",

src/v1/doc/google/cloud/kms/v1/doc_resources.js

@@ -57,4 +57,4 @@ // Copyright 2019 Google LLC
  *
- *   All keys with purpose
- *   ENCRYPT_DECRYPT have a
+ *   Keys with purpose
+ *   ENCRYPT_DECRYPT may have a
  *   primary. For other keys, this field will be omitted.
@@ -65,3 +65,3 @@ *
  * @property {number} purpose
- *   The immutable purpose of this CryptoKey.
+ *   Immutable. The immutable purpose of this CryptoKey.
  *
@@ -94,3 +94,4 @@ *   The number should be among the values of [CryptoKeyPurpose]{@link google.cloud.kms.v1.CryptoKeyPurpose}
  *   next_rotation_time will be advanced by this period when the service
- *   automatically rotates a key. Must be at least one day.
+ *   automatically rotates a key. Must be at least 24 hours and at most
+ *   876,000 hours.
  *
@@ -597,4 +598,3 @@ *   If rotation_period is set, next_rotation_time must also be set.
  * @property {number} importMethod
- *   Required and immutable. The wrapping method to be used for incoming
- *   key material.
+ *   Required. Immutable. The wrapping method to be used for incoming key material.
  *
@@ -604,4 +604,3 @@ *   The number should be among the values of [ImportMethod]{@link google.cloud.kms.v1.ImportMethod}
  * @property {number} protectionLevel
- *   Required and immutable. The protection level of the ImportJob. This
- *   must match the
+ *   Required. Immutable. The protection level of the ImportJob. This must match the
  *   protection_level of the
@@ -776,3 +775,8 @@ *   version_template on the CryptoKey you
    */
-  HSM: 2
+  HSM: 2,
+
+  /**
+   * Crypto operations are performed by an external key manager.
+   */
+  EXTERNAL: 3
 };

src/v1/doc/google/cloud/kms/v1/doc_service.js

@@ -26,3 +26,3 @@ // Copyright 2019 Google LLC
  * @property {number} pageSize
- *   Optional limit on the number of KeyRings to include in the
+ *   Optional. Optional limit on the number of KeyRings to include in the
  *   response.  Further KeyRings can subsequently be obtained by
@@ -33,11 +33,16 @@ *   including the ListKeyRingsResponse.next_page_token in a subsequent
  * @property {string} pageToken
- *   Optional pagination token, returned earlier via
+ *   Optional. Optional pagination token, returned earlier via
  *   ListKeyRingsResponse.next_page_token.
  *
  * @property {string} filter
- *   Optional. Only include resources that match the filter in the response.
+ *   Optional. Only include resources that match the filter in the response. For
+ *   more information, see
+ *   [Sorting and filtering list
+ *   results](https://cloud.google.com/kms/docs/sorting-and-filtering).
  *
  * @property {string} orderBy
  *   Optional. Specify how the results should be sorted. If not specified, the
- *   results will be sorted in the default order.
+ *   results will be sorted in the default order.  For more information, see
+ *   [Sorting and filtering list
+ *   results](https://cloud.google.com/kms/docs/sorting-and-filtering).
  *
@@ -60,3 +65,3 @@ * @typedef ListKeyRingsRequest
  * @property {number} pageSize
- *   Optional limit on the number of CryptoKeys to include in the
+ *   Optional. Optional limit on the number of CryptoKeys to include in the
  *   response.  Further CryptoKeys can subsequently be obtained by
@@ -67,3 +72,3 @@ *   including the ListCryptoKeysResponse.next_page_token in a subsequent
  * @property {string} pageToken
- *   Optional pagination token, returned earlier via
+ *   Optional. Optional pagination token, returned earlier via
  *   ListCryptoKeysResponse.next_page_token.
@@ -77,7 +82,12 @@ *
  * @property {string} filter
- *   Optional. Only include resources that match the filter in the response.
+ *   Optional. Only include resources that match the filter in the response. For
+ *   more information, see
+ *   [Sorting and filtering list
+ *   results](https://cloud.google.com/kms/docs/sorting-and-filtering).
  *
  * @property {string} orderBy
  *   Optional. Specify how the results should be sorted. If not specified, the
- *   results will be sorted in the default order.
+ *   results will be sorted in the default order. For more information, see
+ *   [Sorting and filtering list
+ *   results](https://cloud.google.com/kms/docs/sorting-and-filtering).
  *
@@ -100,3 +110,3 @@ * @typedef ListCryptoKeysRequest
  * @property {number} pageSize
- *   Optional limit on the number of CryptoKeyVersions to
+ *   Optional. Optional limit on the number of CryptoKeyVersions to
  *   include in the response. Further CryptoKeyVersions can
@@ -108,3 +118,3 @@ *   subsequently be obtained by including the
  * @property {string} pageToken
- *   Optional pagination token, returned earlier via
+ *   Optional. Optional pagination token, returned earlier via
  *   ListCryptoKeyVersionsResponse.next_page_token.
@@ -118,7 +128,12 @@ *
  * @property {string} filter
- *   Optional. Only include resources that match the filter in the response.
+ *   Optional. Only include resources that match the filter in the response. For
+ *   more information, see
+ *   [Sorting and filtering list
+ *   results](https://cloud.google.com/kms/docs/sorting-and-filtering).
  *
  * @property {string} orderBy
  *   Optional. Specify how the results should be sorted. If not specified, the
- *   results will be sorted in the default order.
+ *   results will be sorted in the default order. For more information, see
+ *   [Sorting and filtering list
+ *   results](https://cloud.google.com/kms/docs/sorting-and-filtering).
  *
@@ -141,3 +156,3 @@ * @typedef ListCryptoKeyVersionsRequest
  * @property {number} pageSize
- *   Optional limit on the number of ImportJobs to include in the
+ *   Optional. Optional limit on the number of ImportJobs to include in the
  *   response. Further ImportJobs can subsequently be obtained by
@@ -148,11 +163,16 @@ *   including the ListImportJobsResponse.next_page_token in a subsequent
  * @property {string} pageToken
- *   Optional pagination token, returned earlier via
+ *   Optional. Optional pagination token, returned earlier via
  *   ListImportJobsResponse.next_page_token.
  *
  * @property {string} filter
- *   Optional. Only include resources that match the filter in the response.
+ *   Optional. Only include resources that match the filter in the response. For
+ *   more information, see
+ *   [Sorting and filtering list
+ *   results](https://cloud.google.com/kms/docs/sorting-and-filtering).
  *
  * @property {string} orderBy
  *   Optional. Specify how the results should be sorted. If not specified, the
- *   results will be sorted in the default order.
+ *   results will be sorted in the default order. For more information, see
+ *   [Sorting and filtering list
+ *   results](https://cloud.google.com/kms/docs/sorting-and-filtering).
  *
@@ -265,3 +285,3 @@ * @typedef ListImportJobsRequest
  * @property {string} name
- *   The name of the KeyRing to get.
+ *   Required. The name of the KeyRing to get.
  *
@@ -280,3 +300,3 @@ * @typedef GetKeyRingRequest
  * @property {string} name
- *   The name of the CryptoKey to get.
+ *   Required. The name of the CryptoKey to get.
  *
@@ -295,3 +315,3 @@ * @typedef GetCryptoKeyRequest
  * @property {string} name
- *   The name of the CryptoKeyVersion to get.
+ *   Required. The name of the CryptoKeyVersion to get.
  *
@@ -310,3 +330,3 @@ * @typedef GetCryptoKeyVersionRequest
  * @property {string} name
- *   The name of the CryptoKeyVersion public key to
+ *   Required. The name of the CryptoKeyVersion public key to
  *   get.
@@ -326,3 +346,3 @@ *
  * @property {string} name
- *   The name of the ImportJob to get.
+ *   Required. The name of the ImportJob to get.
  *
@@ -349,3 +369,3 @@ * @typedef GetImportJobRequest
  * @property {Object} keyRing
- *   A KeyRing with initial field values.
+ *   Required. A KeyRing with initial field values.
  *
@@ -374,3 +394,3 @@ *   This object should have the same structure as [KeyRing]{@link google.cloud.kms.v1.KeyRing}
  * @property {Object} cryptoKey
- *   A CryptoKey with initial field values.
+ *   Required. A CryptoKey with initial field values.
  *
@@ -402,3 +422,3 @@ *   This object should have the same structure as [CryptoKey]{@link google.cloud.kms.v1.CryptoKey}
  * @property {Object} cryptoKeyVersion
- *   A CryptoKeyVersion with initial field values.
+ *   Required. A CryptoKeyVersion with initial field values.
  *
@@ -451,2 +471,7 @@ *   This object should have the same structure as [CryptoKeyVersion]{@link google.cloud.kms.v1.CryptoKeyVersion}
  *
+ *   If importing symmetric key material, it is expected that the unwrapped
+ *   key contains plain bytes. If importing asymmetric key material, it is
+ *   expected that the unwrapped key is in PKCS#8-encoded DER format (the
+ *   PrivateKeyInfo structure from RFC 5208).
+ *
  *   This format is the same as the format produced by PKCS#11 mechanism
@@ -491,3 +516,3 @@ *   CKM_RSA_AES_KEY_WRAP.
  * @property {Object} cryptoKey
- *   CryptoKey with updated values.
+ *   Required. CryptoKey with updated values.
  *
@@ -497,3 +522,3 @@ *   This object should have the same structure as [CryptoKey]{@link google.cloud.kms.v1.CryptoKey}
  * @property {Object} updateMask
- *   Required list of fields to be updated in this request.
+ *   Required. List of fields to be updated in this request.
  *
@@ -514,3 +539,3 @@ *   This object should have the same structure as [FieldMask]{@link google.protobuf.FieldMask}
  * @property {Object} cryptoKeyVersion
- *   CryptoKeyVersion with updated values.
+ *   Required. CryptoKeyVersion with updated values.
  *
@@ -520,3 +545,3 @@ *   This object should have the same structure as [CryptoKeyVersion]{@link google.cloud.kms.v1.CryptoKeyVersion}
  * @property {Object} updateMask
- *   Required list of fields to be updated in this request.
+ *   Required. List of fields to be updated in this request.
  *
@@ -554,3 +579,3 @@ *   This object should have the same structure as [FieldMask]{@link google.protobuf.FieldMask}
  * @property {Buffer} additionalAuthenticatedData
- *   Optional data that, if specified, must also be provided during decryption
+ *   Optional. Optional data that, if specified, must also be provided during decryption
  *   through DecryptRequest.additional_authenticated_data.
@@ -585,3 +610,3 @@ *
  * @property {Buffer} additionalAuthenticatedData
- *   Optional data that must match the data originally supplied in
+ *   Optional. Optional data that must match the data originally supplied in
  *   EncryptRequest.additional_authenticated_data.
@@ -655,3 +680,4 @@ *
  * @property {string} name
- *   The resource name of the CryptoKeyVersion used in encryption.
+ *   The resource name of the CryptoKeyVersion used in encryption. Check
+ *   this field to verify that the intended resource was used for encryption.
  *
@@ -701,6 +727,6 @@ * @property {Buffer} ciphertext
  * @property {string} name
- *   The resource name of the CryptoKey to update.
+ *   Required. The resource name of the CryptoKey to update.
  *
  * @property {string} cryptoKeyVersionId
- *   The id of the child CryptoKeyVersion to use as primary.
+ *   Required. The id of the child CryptoKeyVersion to use as primary.
  *
@@ -719,3 +745,3 @@ * @typedef UpdateCryptoKeyPrimaryVersionRequest
  * @property {string} name
- *   The resource name of the CryptoKeyVersion to destroy.
+ *   Required. The resource name of the CryptoKeyVersion to destroy.
  *
@@ -734,3 +760,3 @@ * @typedef DestroyCryptoKeyVersionRequest
  * @property {string} name
- *   The resource name of the CryptoKeyVersion to restore.
+ *   Required. The resource name of the CryptoKeyVersion to restore.
  *
@@ -737,0 +763,0 @@ * @typedef RestoreCryptoKeyVersionRequest

No alert changes

Improved metrics

Total package byte prevSize

2339557

increased by3.93%

Lines of code

39158

increased by3.76%

No dependency changes