docs: update return type in jsdoc for Buffers (#176)

googleapis · Jun 12, 2019 · 18fb2c7 · 18fb2c7
1 parent 4d5cf63
commit 18fb2c7
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 26 deletions.
diff --git a/packages/google-cloud-kms/src/v1/doc/google/cloud/kms/v1/doc_resources.js b/packages/google-cloud-kms/src/v1/doc/google/cloud/kms/v1/doc_resources.js
@@ -225,7 +225,7 @@ const CryptoKeyVersionTemplate = {
  *
  *   The number should be among the values of [AttestationFormat]{@link google.cloud.kms.v1.AttestationFormat}
  *
- * @property {string} content
+ * @property {Buffer} content
  *   Output only. The attestation data provided by the HSM when the key
  *   operation was performed.
  *

diff --git a/packages/google-cloud-kms/src/v1/doc/google/cloud/kms/v1/doc_service.js b/packages/google-cloud-kms/src/v1/doc/google/cloud/kms/v1/doc_service.js
@@ -388,7 +388,7 @@ const UpdateCryptoKeyVersionRequest = {
  *   If a CryptoKey is specified, the server
  *   will use its primary version.
  *
- * @property {string} plaintext
+ * @property {Buffer} plaintext
  *   Required. The data to encrypt. Must be no larger than 64KiB.
  *
  *   The maximum size depends on the key version's
@@ -399,7 +399,7 @@ const UpdateCryptoKeyVersionRequest = {
  *   the plaintext and additional_authenticated_data fields must be no larger
  *   than 8KiB.
  *
- * @property {string} additionalAuthenticatedData
+ * @property {Buffer} additionalAuthenticatedData
  *   Optional data that, if specified, must also be provided during decryption
  *   through
  *   DecryptRequest.additional_authenticated_data.
@@ -429,11 +429,11 @@ const EncryptRequest = {
  *   CryptoKey to use for decryption. The
  *   server will choose the appropriate version.
  *
- * @property {string} ciphertext
+ * @property {Buffer} ciphertext
  *   Required. The encrypted data originally returned in
  *   EncryptResponse.ciphertext.
  *
- * @property {string} additionalAuthenticatedData
+ * @property {Buffer} additionalAuthenticatedData
  *   Optional data that must match the data originally supplied in
  *   EncryptRequest.additional_authenticated_data.
  *
@@ -478,7 +478,7 @@ const AsymmetricSignRequest = {
  *   CryptoKeyVersion to use for
  *   decryption.
  *
- * @property {string} ciphertext
+ * @property {Buffer} ciphertext
  *   Required. The data encrypted with the named
  *   CryptoKeyVersion's public key using
  *   OAEP.
@@ -495,7 +495,7 @@ const AsymmetricDecryptRequest = {
  * Response message for
  * KeyManagementService.Decrypt.
  *
- * @property {string} plaintext
+ * @property {Buffer} plaintext
  *   The decrypted data originally supplied in
  *   EncryptRequest.plaintext.
  *
@@ -516,7 +516,7 @@ const DecryptResponse = {
  *   CryptoKeyVersion used in
  *   encryption.
  *
- * @property {string} ciphertext
+ * @property {Buffer} ciphertext
  *   The encrypted data.
  *
  * @typedef EncryptResponse
@@ -531,7 +531,7 @@ const EncryptResponse = {
  * Response message for
  * KeyManagementService.AsymmetricSign.
  *
- * @property {string} signature
+ * @property {Buffer} signature
  *   The created signature.
  *
  * @typedef AsymmetricSignResponse
@@ -546,7 +546,7 @@ const AsymmetricSignResponse = {
  * Response message for
  * KeyManagementService.AsymmetricDecrypt.
  *
- * @property {string} plaintext
+ * @property {Buffer} plaintext
  *   The decrypted data originally encrypted with the matching public key.
  *
  * @typedef AsymmetricDecryptResponse
@@ -612,13 +612,13 @@ const RestoreCryptoKeyVersionRequest = {
 /**
  * A Digest holds a cryptographic message digest.
  *
- * @property {string} sha256
+ * @property {Buffer} sha256
  *   A message digest produced with the SHA-256 algorithm.
  *
- * @property {string} sha384
+ * @property {Buffer} sha384
  *   A message digest produced with the SHA-384 algorithm.
  *
- * @property {string} sha512
+ * @property {Buffer} sha512
  *   A message digest produced with the SHA-512 algorithm.
  *
  * @typedef Digest

diff --git a/packages/google-cloud-kms/src/v1/key_management_service_client.js b/packages/google-cloud-kms/src/v1/key_management_service_client.js
@@ -1338,7 +1338,7 @@ class KeyManagementServiceClient {
    *
    *   If a CryptoKey is specified, the server
    *   will use its primary version.
-   * @param {string} request.plaintext
+   * @param {Buffer} request.plaintext
    *   Required. The data to encrypt. Must be no larger than 64KiB.
    *
    *   The maximum size depends on the key version's
@@ -1348,7 +1348,7 @@ class KeyManagementServiceClient {
    *   HSM keys, the combined length of
    *   the plaintext and additional_authenticated_data fields must be no larger
    *   than 8KiB.
-   * @param {string} [request.additionalAuthenticatedData]
+   * @param {Buffer} [request.additionalAuthenticatedData]
    *   Optional data that, if specified, must also be provided during decryption
    *   through
    *   DecryptRequest.additional_authenticated_data.
@@ -1380,7 +1380,7 @@ class KeyManagementServiceClient {
    * });
    *
    * const formattedName = client.cryptoKeyPathPath('[PROJECT]', '[LOCATION]', '[KEY_RING]', '[CRYPTO_KEY_PATH]');
-   * const plaintext = '';
+   * const plaintext = Buffer.from('');
    * const request = {
    *   name: formattedName,
    *   plaintext: plaintext,
@@ -1423,10 +1423,10 @@ class KeyManagementServiceClient {
    *   Required. The resource name of the
    *   CryptoKey to use for decryption. The
    *   server will choose the appropriate version.
-   * @param {string} request.ciphertext
+   * @param {Buffer} request.ciphertext
    *   Required. The encrypted data originally returned in
    *   EncryptResponse.ciphertext.
-   * @param {string} [request.additionalAuthenticatedData]
+   * @param {Buffer} [request.additionalAuthenticatedData]
    *   Optional data that must match the data originally supplied in
    *   EncryptRequest.additional_authenticated_data.
    * @param {Object} [options]
@@ -1449,7 +1449,7 @@ class KeyManagementServiceClient {
    * });
    *
    * const formattedName = client.cryptoKeyPath('[PROJECT]', '[LOCATION]', '[KEY_RING]', '[CRYPTO_KEY]');
-   * const ciphertext = '';
+   * const ciphertext = Buffer.from('');
    * const request = {
    *   name: formattedName,
    *   ciphertext: ciphertext,
@@ -1763,7 +1763,7 @@ class KeyManagementServiceClient {
    *   Required. The resource name of the
    *   CryptoKeyVersion to use for
    *   decryption.
-   * @param {string} request.ciphertext
+   * @param {Buffer} request.ciphertext
    *   Required. The data encrypted with the named
    *   CryptoKeyVersion's public key using
    *   OAEP.
@@ -1787,7 +1787,7 @@ class KeyManagementServiceClient {
    * });
    *
    * const formattedName = client.cryptoKeyVersionPath('[PROJECT]', '[LOCATION]', '[KEY_RING]', '[CRYPTO_KEY]', '[CRYPTO_KEY_VERSION]');
-   * const ciphertext = '';
+   * const ciphertext = Buffer.from('');
    * const request = {
    *   name: formattedName,
    *   ciphertext: ciphertext,

diff --git a/packages/google-cloud-kms/synth.metadata b/packages/google-cloud-kms/synth.metadata
@@ -1,19 +1,19 @@
 {
-  "updateTime": "2019-06-05T14:19:24.011735Z",
+  "updateTime": "2019-06-12T11:17:31.164765Z",
   "sources": [
     {
       "generator": {
         "name": "artman",
-        "version": "0.23.1",
-        "dockerImage": "googleapis/artman@sha256:9d5cae1454da64ac3a87028f8ef486b04889e351c83bb95e83b8fab3959faed0"
+        "version": "0.24.1",
+        "dockerImage": "googleapis/artman@sha256:6018498e15310260dc9b03c9d576608908ed9fbabe42e1494ff3d827fea27b19"
       }
     },
     {
       "git": {
         "name": "googleapis",
         "remote": "https://github.com/googleapis/googleapis.git",
-        "sha": "47c142a7cecc6efc9f6f8af804b8be55392b795b",
-        "internalRef": "251635729"
+        "sha": "f117dac435e96ebe58d85280a3faf2350c4d4219",
+        "internalRef": "252714985"
       }
     },
     {