Skip to content

Commit 3406eaa

Browse files
docs: update README for v2.1 public interface changes
- Replace deprecated credential key names in examples: clientID→clientId, keyID→keyId, TokenURI→tokenUri - Update Insert, Get, and Query response examples to use skyflowId (the SDK has always returned skyflowId for Insert; Get/Query now return skyflowId as the primary key) - Add deprecation note after each affected response block: skyflow_id is deprecated and will be removed in an upcoming release Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 975dfba commit 3406eaa

1 file changed

Lines changed: 27 additions & 15 deletions

File tree

README.md

Lines changed: 27 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -164,10 +164,10 @@ public class InitSkyflowClient {
164164
// Step 3: Create credentials as a JSON object (if a Bearer Token is not provided).
165165
// Demonstrates an alternate approach to authenticate with Skyflow using a credentials object.
166166
JsonObject credentialsObject = new JsonObject();
167-
credentialsObject.addProperty("clientID", "<YOUR_CLIENT_ID>"); // Replace with your Client ID.
167+
credentialsObject.addProperty("clientId", "<YOUR_CLIENT_ID>"); // Replace with your Client ID.
168168
credentialsObject.addProperty("clientName", "<YOUR_CLIENT_NAME>"); // Replace with your Client Name.
169-
credentialsObject.addProperty("TokenURI", "<YOUR_TOKEN_URI>"); // Replace with the Token URI.
170-
credentialsObject.addProperty("keyID", "<YOUR_KEY_ID>"); // Replace with your Key ID.
169+
credentialsObject.addProperty("tokenUri", "<YOUR_TOKEN_URI>"); // Replace with the Token URI.
170+
credentialsObject.addProperty("keyId", "<YOUR_KEY_ID>"); // Replace with your Key ID.
171171
credentialsObject.addProperty("privateKey", "<YOUR_PRIVATE_KEY>"); // Replace with your Private Key.
172172

173173
// Step 4: Convert the JSON object to a string and use it as credentials.
@@ -291,14 +291,16 @@ Skyflow returns tokens for the record that was just inserted.
291291
{
292292
"card_number": "5484-7829-1702-9110",
293293
"request_index": "0",
294-
"skyflow_id": "9fac9201-7b8a-4446-93f8-5244e1213bd1",
294+
"skyflowId": "9fac9201-7b8a-4446-93f8-5244e1213bd1",
295295
"cardholder_name": "b2308e2a-c1f5-469b-97b7-1f193159399b"
296296
}
297297
],
298298
"errors": []
299299
}
300300
```
301301

302+
> **Note:** The response key is `skyflowId`. The legacy `skyflow_id` key is deprecated and will be removed in an upcoming release.
303+
302304
# Vault
303305

304306
The [Vault](https://github.com/skyflowapi/skyflow-java/tree/main/samples/src/main/java/com/example/vault) module performs operations on the vault, including inserting records, detokenizing tokens, and retrieving tokens associated with a `skyflow_id`.
@@ -436,7 +438,7 @@ Sample response:
436438
{
437439
"card_number": "5484-7829-1702-9110",
438440
"request_index": "0",
439-
"skyflow_id": "9fac9201-7b8a-4446-93f8-5244e1213bd1",
441+
"skyflowId": "9fac9201-7b8a-4446-93f8-5244e1213bd1",
440442
"cardholder_name": "b2308e2a-c1f5-469b-97b7-1f193159399b"
441443
}
442444
],
@@ -449,6 +451,8 @@ Sample response:
449451
}
450452
```
451453

454+
> **Note:** The response key is `skyflowId`. The legacy `skyflow_id` key is deprecated and will be removed in an upcoming release.
455+
452456
### Insert call example with `upsert` option
453457

454458
An upsert operation checks for a record based on a unique column's value. If a match exists, the record is updated; otherwise, a new record is inserted.
@@ -974,19 +978,21 @@ Sample response:
974978
"card_number": "4555555555555553",
975979
"email": "john.doe@gmail.com",
976980
"name": "john doe",
977-
"skyflow_id": "a581d205-1969-4350-acbe-a2a13eb871a6"
981+
"skyflowId": "a581d205-1969-4350-acbe-a2a13eb871a6"
978982
},
979983
{
980984
"card_number": "4555555555555559",
981985
"email": "jane.doe@gmail.com",
982986
"name": "jane doe",
983-
"skyflow_id": "5ff887c3-b334-4294-9acc-70e78ae5164a"
987+
"skyflowId": "5ff887c3-b334-4294-9acc-70e78ae5164a"
984988
}
985989
],
986990
"errors": []
987991
}
988992
```
989993

994+
> **Note:** The response key is `skyflowId`. The legacy `skyflow_id` key is deprecated and will be removed in an upcoming release.
995+
990996
### Get tokens
991997

992998
Return tokens for records. Ideal for securely processing sensitive data while maintaining data privacy.
@@ -1050,19 +1056,21 @@ Sample response:
10501056
"card_number": "3998-2139-0328-0697",
10511057
"email": "c9a6c9555060@82c092e7.bd52",
10521058
"name": "82c092e7-74c0-4e60-bd52-c9a6c9555060",
1053-
"skyflow_id": "a581d205-1969-4350-acbe-a2a13eb871a6"
1059+
"skyflowId": "a581d205-1969-4350-acbe-a2a13eb871a6"
10541060
},
10551061
{
10561062
"card_number": "3562-0140-8820-7499",
10571063
"email": "6174366e2bc6@59f82e89.93fc",
10581064
"name": "59f82e89-138e-4f9b-93fc-6174366e2bc6",
1059-
"skyflow_id": "5ff887c3-b334-4294-9acc-70e78ae5164a"
1065+
"skyflowId": "5ff887c3-b334-4294-9acc-70e78ae5164a"
10601066
}
10611067
],
10621068
"errors": []
10631069
}
10641070
```
10651071

1072+
> **Note:** The response key is `skyflowId`. The legacy `skyflow_id` key is deprecated and will be removed in an upcoming release.
1073+
10661074
### Get By column name and column values
10671075

10681076
Retrieve records by unique column values. Ideal for querying data without knowing Skyflow IDs, using alternate unique identifiers.
@@ -1128,19 +1136,21 @@ Sample response:
11281136
"card_number": "4555555555555553",
11291137
"email": "john.doe@gmail.com",
11301138
"name": "john doe",
1131-
"skyflow_id": "a581d205-1969-4350-acbe-a2a13eb871a6"
1139+
"skyflowId": "a581d205-1969-4350-acbe-a2a13eb871a6"
11321140
},
11331141
{
11341142
"card_number": "4555555555555559",
11351143
"email": "jane.doe@gmail.com",
11361144
"name": "jane doe",
1137-
"skyflow_id": "5ff887c3-b334-4294-9acc-70e78ae5164a"
1145+
"skyflowId": "5ff887c3-b334-4294-9acc-70e78ae5164a"
11381146
}
11391147
],
11401148
"errors": []
11411149
}
11421150
```
11431151

1152+
> **Note:** The response key is `skyflowId`. The legacy `skyflow_id` key is deprecated and will be removed in an upcoming release.
1153+
11441154
### Redaction types
11451155

11461156
Redaction types determine how sensitive data is displayed when retrieved from the vault.
@@ -1495,13 +1505,15 @@ Sample response:
14951505
{
14961506
"card_number": "XXXXXXXXXXXX1112",
14971507
"name": "S***ar",
1498-
"skyflow_id": "3ea3861-x107-40w8-la98-106sp08ea83f",
1508+
"skyflowId": "3ea3861-x107-40w8-la98-106sp08ea83f",
14991509
"tokenizedData": null
15001510
}
15011511
]
15021512
}
15031513
```
15041514

1515+
> **Note:** The response key is `skyflowId`. The legacy `skyflow_id` key is deprecated and will be removed in an upcoming release.
1516+
15051517
## Upload File
15061518

15071519
To upload files to a Skyflow vault, use the `uploadFile` method. The `UploadFileRequest` class accepts parameters such as the file path, table name, and file name.
@@ -2829,10 +2841,10 @@ public class ChangeLogLevel {
28292841
// Step 3: Define additional Skyflow credentials (optional, if needed for credentials string)
28302842
// Create a JSON object to hold your Skyflow credentials
28312843
JsonObject credentialsObject = new JsonObject();
2832-
credentialsObject.addProperty("clientID", "<YOUR_CLIENT_ID>"); // Replace with your client ID
2844+
credentialsObject.addProperty("clientId", "<YOUR_CLIENT_ID>"); // Replace with your client ID
28332845
credentialsObject.addProperty("clientName", "<YOUR_CLIENT_NAME>"); // Replace with your client name
2834-
credentialsObject.addProperty("TokenURI", "<YOUR_TOKEN_URI>"); // Replace with your token URI
2835-
credentialsObject.addProperty("keyID", "<YOUR_KEY_ID>"); // Replace with your key ID
2846+
credentialsObject.addProperty("tokenUri", "<YOUR_TOKEN_URI>"); // Replace with your token URI
2847+
credentialsObject.addProperty("keyId", "<YOUR_KEY_ID>"); // Replace with your key ID
28362848
credentialsObject.addProperty("privateKey", "<YOUR_PRIVATE_KEY>"); // Replace with your private key
28372849

28382850
// Convert the credentials object to a string format to be used for generating a Bearer Token

0 commit comments

Comments
 (0)