Skip to content

Commit 8e8952f

Browse files
ArtemkaaasArtemkaaas
committed
Updated documentation related ro NonSecrets API
Signed-off-by: artem.ivanov <[email protected]>
1 parent 2558198 commit 8e8952f

File tree

6 files changed

+35
-35
lines changed

6 files changed

+35
-35
lines changed

‎libindy/include/indy_non_secrets.h‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ extern "C" {
1616
/// tags_json: the record tags used for search and storing meta information as json:
1717
/// {
1818
/// "tagName1": <str>, // string tag (will be stored encrypted)
19-
/// "tagName2": <int>, // int tag (will be stored encrypted)
19+
/// "tagName2": <str>, // string tag (will be stored encrypted)
2020
/// "~tagName3": <str>, // string tag (will be stored un-encrypted)
21-
/// "~tagName4": <int>, // int tag (will be stored un-encrypted)
21+
/// "~tagName4": <str>, // string tag (will be stored un-encrypted)
2222
/// }
2323
/// Note that null means no tags
2424
/// If tag name starts with "~" the tag will be stored un-encrypted that will allow
@@ -63,9 +63,9 @@ extern "C" {
6363
/// tags_json: the record tags used for search and storing meta information as json:
6464
/// {
6565
/// "tagName1": <str>, // string tag (will be stored encrypted)
66-
/// "tagName2": <int>, // int tag (will be stored encrypted)
66+
/// "tagName2": <str>, // string tag (will be stored encrypted)
6767
/// "~tagName3": <str>, // string tag (will be stored un-encrypted)
68-
/// "~tagName4": <int>, // int tag (will be stored un-encrypted)
68+
/// "~tagName4": <str>, // string tag (will be stored un-encrypted)
6969
/// }
7070
/// If tag name starts with "~" the tag will be stored un-encrypted that will allow
7171
/// usage of this tag in complex search queries (comparison, predicates)
@@ -90,9 +90,9 @@ extern "C" {
9090
/// tags_json: the record tags used for search and storing meta information as json:
9191
/// {
9292
/// "tagName1": <str>, // string tag (will be stored encrypted)
93-
/// "tagName2": <int>, // int tag (will be stored encrypted)
93+
/// "tagName2": <str>, // string tag (will be stored encrypted)
9494
/// "~tagName3": <str>, // string tag (will be stored un-encrypted)
95-
/// "~tagName4": <int>, // int tag (will be stored un-encrypted)
95+
/// "~tagName4": <str>, // string tag (will be stored un-encrypted)
9696
/// }
9797
/// If tag name starts with "~" the tag will be stored un-encrypted that will allow
9898
/// usage of this tag in complex search queries (comparison, predicates)
@@ -190,7 +190,7 @@ extern "C" {
190190
/// "tagName": "tagValue",
191191
/// $or: {
192192
/// "tagName2": { $regex: 'pattern' },
193-
/// "tagName3": { $gte: 123 },
193+
/// "tagName3": { $gte: '123' },
194194
/// },
195195
/// }
196196
/// options_json: //TODO: FIXME: Think about replacing by bitmaks

‎libindy/src/api/non_secrets.rs‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ use self::libc::c_char;
2020
/// tags_json: the record tags used for search and storing meta information as json:
2121
/// {
2222
/// "tagName1": <str>, // string tag (will be stored encrypted)
23-
/// "tagName2": <int>, // int tag (will be stored encrypted)
23+
/// "tagName2": <str>, // string tag (will be stored encrypted)
2424
/// "~tagName3": <str>, // string tag (will be stored un-encrypted)
25-
/// "~tagName4": <int>, // int tag (will be stored un-encrypted)
25+
/// "~tagName4": <str>, // string tag (will be stored un-encrypted)
2626
/// }
2727
/// Note that null means no tags
2828
/// If tag name starts with "~" the tag will be stored un-encrypted that will allow
@@ -123,9 +123,9 @@ pub extern fn indy_update_wallet_record_value(command_handle: i32,
123123
/// tags_json: the record tags used for search and storing meta information as json:
124124
/// {
125125
/// "tagName1": <str>, // string tag (will be stored encrypted)
126-
/// "tagName2": <int>, // int tag (will be stored encrypted)
126+
/// "tagName2": <str>, // string tag (will be stored encrypted)
127127
/// "~tagName3": <str>, // string tag (will be stored un-encrypted)
128-
/// "~tagName4": <int>, // int tag (will be stored un-encrypted)
128+
/// "~tagName4": <str>, // string tag (will be stored un-encrypted)
129129
/// }
130130
/// If tag name starts with "~" the tag will be stored un-encrypted that will allow
131131
/// usage of this tag in complex search queries (comparison, predicates)
@@ -177,9 +177,9 @@ pub extern fn indy_update_wallet_record_tags(command_handle: i32,
177177
/// tags_json: the record tags used for search and storing meta information as json:
178178
/// {
179179
/// "tagName1": <str>, // string tag (will be stored encrypted)
180-
/// "tagName2": <int>, // int tag (will be stored encrypted)
180+
/// "tagName2": <str>, // string tag (will be stored encrypted)
181181
/// "~tagName3": <str>, // string tag (will be stored un-encrypted)
182-
/// "~tagName4": <int>, // int tag (will be stored un-encrypted)
182+
/// "~tagName4": <str>, // string tag (will be stored un-encrypted)
183183
/// }
184184
/// If tag name starts with "~" the tag will be stored un-encrypted that will allow
185185
/// usage of this tag in complex search queries (comparison, predicates)
@@ -384,7 +384,7 @@ pub extern fn indy_get_wallet_record(command_handle: i32,
384384
/// "tagName": "tagValue",
385385
/// $or: {
386386
/// "tagName2": { $regex: 'pattern' },
387-
/// "tagName3": { $gte: 123 },
387+
/// "tagName3": { $gte: '123' },
388388
/// },
389389
/// }
390390
/// options_json: //TODO: FIXME: Think about replacing by bitmaks
@@ -448,7 +448,7 @@ pub extern fn indy_open_wallet_search(command_handle: i32,
448448
/// #Returns
449449
/// wallet records json:
450450
/// {
451-
/// totalCount: <int>, // present only if retrieveTotalCount set to true
451+
/// totalCount: <str>, // present only if retrieveTotalCount set to true
452452
/// records: [{ // present only if retrieveRecords set to true
453453
/// id: "Some id",
454454
/// type: "Some type", // present only if retrieveType set to true

‎wrappers/ios/libindy-pod/Indy/Wrapper/IndyNonSecrets.h‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@
1919
@paran tagsJson the record tags used for search and storing meta information as json:
2020
{
2121
"tagName1": <str>, // string tag (will be stored encrypted)
22-
"tagName2": <int>, // int tag (will be stored encrypted)
22+
"tagName2": <str>, // string tag (will be stored encrypted)
2323
"~tagName3": <str>, // string tag (will be stored un-encrypted)
24-
"~tagName4": <int>, // int tag (will be stored un-encrypted)
24+
"~tagName4": <str>, // string tag (will be stored un-encrypted)
2525
}
2626
Note that null means no tags
2727
If tag name starts with "~" the tag will be stored un-encrypted that will allow
@@ -60,9 +60,9 @@
6060
@paran tagsJson the record tags used for search and storing meta information as json:
6161
{
6262
"tagName1": <str>, // string tag (will be stored encrypted)
63-
"tagName2": <int>, // int tag (will be stored encrypted)
63+
"tagName2": <str>, // string tag (will be stored encrypted)
6464
"~tagName3": <str>, // string tag (will be stored un-encrypted)
65-
"~tagName4": <int>, // int tag (will be stored un-encrypted)
65+
"~tagName4": <str>, // string tag (will be stored un-encrypted)
6666
}
6767
Note that null means no tags
6868
If tag name starts with "~" the tag will be stored un-encrypted that will allow
@@ -85,9 +85,9 @@
8585
@paran tagsJson the record tags used for search and storing meta information as json:
8686
{
8787
"tagName1": <str>, // string tag (will be stored encrypted)
88-
"tagName2": <int>, // int tag (will be stored encrypted)
88+
"tagName2": <str>, // string tag (will be stored encrypted)
8989
"~tagName3": <str>, // string tag (will be stored un-encrypted)
90-
"~tagName4": <int>, // int tag (will be stored un-encrypted)
90+
"~tagName4": <str>, // string tag (will be stored un-encrypted)
9191
}
9292
Note that null means no tags
9393
If tag name starts with "~" the tag will be stored un-encrypted that will allow
@@ -172,7 +172,7 @@
172172
"tagName": "tagValue",
173173
$or: {
174174
"tagName2": { $regex: 'pattern' },
175-
"tagName3": { $gte: 123 },
175+
"tagName3": { $gte: '123' },
176176
},
177177
}
178178
@param optionsJson:
@@ -204,7 +204,7 @@
204204
205205
@param completion Completion callback that returns error code and wallet records json wallet records json:
206206
{
207-
totalCount: <int>, // present only if retrieveTotalCount set to true
207+
totalCount: <str>, // present only if retrieveTotalCount set to true
208208
records: [{ // present only if retrieveRecords set to true
209209
id: "Some id",
210210
type: "Some type", // present only if retrieveType set to true

‎wrappers/java/src/main/java/org/hyperledger/indy/sdk/non_secrets/WalletRecord.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ public void callback(int xcommand_handle, int err, String str) {
7272
* @param tagsJson The record tags used for search and storing meta information as json:
7373
* {
7474
* "tagName1": <str>, // string tag (will be stored encrypted)
75-
* "tagName2": <int>, // int tag (will be stored encrypted)
75+
* "tagName2": <str>, // string tag (will be stored encrypted)
7676
* }
7777
* @return A future that resolves no value.
7878
* @throws IndyException Thrown if an error occurs when calling the underlying SDK.
@@ -156,7 +156,7 @@ public static CompletableFuture<Void> updateValue(
156156
* @param tagsJson The record tags used for search and storing meta information as json:
157157
* {
158158
* "tagName1": <str>, // string tag (will be stored encrypted)
159-
* "tagName2": <int>, // int tag (will be stored encrypted)
159+
* "tagName2": <str>, // string tag (will be stored encrypted)
160160
* }
161161
* @return A future that resolves no value.
162162
* @throws IndyException Thrown if an error occurs when calling the underlying SDK.
@@ -199,7 +199,7 @@ public static CompletableFuture<Void> updateTags(
199199
* @param tagsJson The record tags used for search and storing meta information as json:
200200
* {
201201
* "tagName1": <str>, // string tag (will be stored encrypted)
202-
* "tagName2": <int>, // int tag (will be stored encrypted)
202+
* "tagName2": <str>, // string tag (will be stored encrypted)
203203
* }
204204
* @return A future that resolves no value.
205205
* @throws IndyException Thrown if an error occurs when calling the underlying SDK.

‎wrappers/java/src/main/java/org/hyperledger/indy/sdk/non_secrets/WalletSearch.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ public void callback(int xcommand_handle, int err, int handle) {
101101
* "tagName": "tagValue",
102102
* $or: {
103103
* "tagName2": { $regex: 'pattern' },
104-
* "tagName3": { $gte: 123 },
104+
* "tagName3": { $gte: '123' },
105105
* }
106106
* }
107107
* @param optionsJson {

‎wrappers/python/indy/non_secrets.py‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ async def add_wallet_record(wallet_handle: int,
2121
:param tags_json: the record tags used for search and storing meta information as json:
2222
{
2323
"tagName1": <str>, // string tag (will be stored encrypted)
24-
"tagName2": <int>, // int tag (will be stored encrypted)
24+
"tagName2": <str>, // string tag (will be stored encrypted)
2525
"~tagName3": <str>, // string tag (will be stored un-encrypted)
26-
"~tagName4": <int>, // int tag (will be stored un-encrypted)
26+
"~tagName4": <str>, // string tag (will be stored un-encrypted)
2727
}
2828
:return: None
2929
"""
@@ -112,9 +112,9 @@ async def update_wallet_record_tags(wallet_handle: int,
112112
:param tags_json: ags_json: the record tags used for search and storing meta information as json:
113113
{
114114
"tagName1": <str>, // string tag (will be stored encrypted)
115-
"tagName2": <int>, // int tag (will be stored encrypted)
115+
"tagName2": <str>, // string tag (will be stored encrypted)
116116
"~tagName3": <str>, // string tag (will be stored un-encrypted)
117-
"~tagName4": <int>, // int tag (will be stored un-encrypted)
117+
"~tagName4": <str>, // string tag (will be stored un-encrypted)
118118
}
119119
:return: None
120120
"""
@@ -159,9 +159,9 @@ async def add_wallet_record_tags(wallet_handle: int,
159159
:param tags_json: ags_json: the record tags used for search and storing meta information as json:
160160
{
161161
"tagName1": <str>, // string tag (will be stored encrypted)
162-
"tagName2": <int>, // int tag (will be stored encrypted)
162+
"tagName2": <str>, // string tag (will be stored encrypted)
163163
"~tagName3": <str>, // string tag (will be stored un-encrypted)
164-
"~tagName4": <int>, // int tag (will be stored un-encrypted)
164+
"~tagName4": <str>, // string tag (will be stored un-encrypted)
165165
}
166166
:return: None
167167
"""
@@ -337,7 +337,7 @@ async def open_wallet_search(wallet_handle: int,
337337
"tagName": "tagValue",
338338
$or: {
339339
"tagName2": { $regex: 'pattern' },
340-
"tagName3": { $gte: 123 },
340+
"tagName3": { $gte: '123' },
341341
},
342342
}
343343
:param options_json: //TODO: FIXME: Think about replacing by bitmaks
@@ -391,7 +391,7 @@ async def fetch_wallet_search_next_records(wallet_handle: int,
391391
:param count: Count of records to fetch
392392
:return: wallet records json:
393393
{
394-
totalCount: <int>, // present only if retrieveTotalCount set to true
394+
totalCount: <str>, // present only if retrieveTotalCount set to true
395395
records: [{ // present only if retrieveRecords set to true
396396
id: "Some id",
397397
type: "Some type", // present only if retrieveType set to true

0 commit comments

Comments
 (0)