Merge pull request #110 from skyflowapi/SK-353/update-readme-redaction

SK-353 update readme and samples for redaction in detokenize.
skyflowapi · Jun 9, 2023 · 503a20e · 503a20e
2 parents c1d42fd + 936452b
commit 503a20e
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,11 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.10.0] - 2023-06-08
+### Added
+- `redaction` in detokenize interface.
+### Changed
+- Removed grace period logic for bearer token generation.
 ## [1.9.3] - 2023-03-17
 ### Changed
 - Removed grace period logic for bearer token generation.

diff --git a/README.md b/README.md
@@ -577,18 +577,28 @@ In order to retrieve data from your vault using tokens that you have previously
 ```javascript
 data = {
   records: [{
-    // Token for the record to be fetched.
-    token: 'string'
+    token: 'string',                 // Required, token for the record to be fetched.
+    redaction: Skyflow.RedactionType // Optional, redaction type to be applied to retrieved data, ex: Skyflow.RedactionType.PLAIN_TEXT
   }]
 }
 ```
+`Skyflow.RedactionType` accept four values:
+* `PLAIN_TEXT`
+* `MASKED`
+* `REDACTED`
+* `DEFAULT`
+
+Note:
+- `redaction` defaults to Skyflow.RedactionType.PLAIN_TEXT.
+
 An [example](https://github.com/skyflowapi/skyflow-node/blob/master/samples/vault-api/Detokenize.ts) of a detokenize call:
 
 ```javascript
 const result = client.detokenize({
   records: [
     {
       token: '4017-f72b-4f5c-9b-8e719',
+      redaction: Skyflow.RedactionType.PLAIN_TEXT
     },
   ],
 });
@@ -629,7 +639,7 @@ data = {
     }]
 };
 ```
-`Skyflow.RedactionTypes` accept four values:
+`Skyflow.RedactionType` accept four values:
 * `PLAIN_TEXT`
 * `MASKED`
 * `REDACTED`

diff --git a/samples/vault-api/Detokenize.ts b/samples/vault-api/Detokenize.ts
@@ -38,12 +38,15 @@ const result = skyflow.detokenize({
   records: [
     {
       token: '<TOKEN1>',
+      redaction: Skyflow.RedactionType.DEFAULT  // optional
     },
     {
       token: '<TOKEN2>',
+      redaction: Skyflow.RedactionType.MASKED  // optional
     },
     {
       token: '<TOKEN3>',
+      redaction: Skyflow.RedactionType.REDACTED // optional
     },
     {
       token: '<TOKEN4>',