Corrected documentation

Signed-off-by: artem.ivanov <[email protected]>

Author: Artemkaaas

doc/design/002-anoncreds/README.md

@@ -480,27 +480,34 @@ pub extern fn indy_prover_get_credential(command_handle: i32,
 ```Rust
 /// Gets human readable credentials according to the filter.
 /// If filter is NULL, then all credentials are returned.
-/// Credentials can be filtered by tags created during saving of credential.
+/// Credentials can be filtered by Issuer, credential_def and/or Schema.
 ///
-/// NOTE: This method is deprecated because immediately returns all fetched credentials. 
+/// NOTE: This method is deprecated because immediately returns all fetched credentials.
 /// Use <indy_prover_search_credentials> to fetch records by small batches.
-/// 
+///
 /// #Params
 /// wallet_handle: wallet handler (created by open_wallet).
-/// filter_json: Wql style filter for credentials searching based on tags.
-///     where wql query: indy-sdk/doc/design/011-wallet-query-language/README.md
+/// filter_json: filter for credentials
+///        {
+///            "schema_id": string, (Optional)
+///            "schema_issuer_did": string, (Optional)
+///            "schema_name": string, (Optional)
+///            "schema_version": string, (Optional)
+///            "issuer_did": string, (Optional)
+///            "cred_def_id": string, (Optional)
+///        }
 /// cb: Callback that takes command result as parameter.
 ///
 /// #Returns
-/// credentials json 
-///     [{ 
-///         "referent": string, // cred_id in the wallet 
-///         "attrs": {"key1":"raw_value1", "key2":"raw_value2"}, 
-///         "schema_id": string, 
-///         "cred_def_id": string, 
-///         "rev_reg_id": Optional<string>, 
-///         "cred_rev_id": Optional<string> 
-///     }] 
+/// credentials json
+///     [{
+///         "referent": string, // cred_id in the wallet
+///         "attrs": {"key1":"raw_value1", "key2":"raw_value2"},
+///         "schema_id": string,
+///         "cred_def_id": string,
+///         "rev_reg_id": Optional<string>,
+///         "cred_rev_id": Optional<string>
+///     }]
 ///
 /// #Errors
 /// Annoncreds*
@@ -525,7 +532,7 @@ pub extern fn indy_prover_get_credentials(command_handle: i32,
 ///
 /// #Params
 /// wallet_handle: wallet handler (created by open_wallet).
-/// filter_json: Wql style filter for credentials searching based on tags.
+/// query_json: Wql style filter for credentials searching based on tags.
 ///     where wql query: indy-sdk/doc/design/011-wallet-query-language/README.md
 /// cb: Callback that takes command result as parameter.
 ///
@@ -540,7 +547,7 @@ pub extern fn indy_prover_get_credentials(command_handle: i32,
 #[no_mangle]
 pub extern fn indy_prover_search_credentials(command_handle: i32,
                                              wallet_handle: i32,
-                                             filter_json: *const c_char,
+                                             query_json: *const c_char,
                                              cb: Option<extern fn(
                                                  xcommand_handle: i32, err: ErrorCode,
                                                  search_handle: i32,
@@ -595,9 +602,9 @@ pub  extern fn indy_prover_close_credentials_search(command_handle: i32,
 
 /// Gets human readable credentials matching the given proof request.
 ///
-/// NOTE: This method is deprecated because immediately returns all fetched credentials. 
+/// NOTE: This method is deprecated because immediately returns all fetched credentials.
 /// Use <indy_prover_search_credentials_for_proof_req> to fetch records by small batches.
-/// 
+///
 /// #Params
 /// wallet_handle: wallet handler (created by open_wallet).
 /// proof_request_json: proof request json
@@ -618,20 +625,14 @@ pub  extern fn indy_prover_close_credentials_search(command_handle: i32,
 ///                        // for date in this interval for each attribute
 ///                        // (can be overridden on attribute level)
 ///     }
-/// extra_query_json:(Optional) List of extra queries that will be applied to correspondent attribute/predicate:
-///     {
-///         "<attr_referent>": <wql query>,
-///         "<predicate_referent>": <wql query>,
-///     }
 /// cb: Callback that takes command result as parameter.
 ///
 /// where
-/// where wql query: indy-sdk/doc/design/011-wallet-query-language/README.md
 /// attr_referent: Proof-request local identifier of requested attribute
 /// attr_info: Describes requested attribute
 ///     {
 ///         "name": string, // attribute name, (case insensitive and ignore spaces)
-///         "restrictions": Optional<wql query>,
+///         "restrictions": Optional<filter_json>, // see above
 ///         "non_revoked": Optional<<non_revoc_interval>>, // see below,
 ///                        // If specified prover must proof non-revocation
 ///                        // for date in this interval this attribute
@@ -643,7 +644,7 @@ pub  extern fn indy_prover_close_credentials_search(command_handle: i32,
 ///         "name": attribute name, (case insensitive and ignore spaces)
 ///         "p_type": predicate type (Currently ">=" only)
 ///         "p_value": int predicate value
-///         "restrictions": Optional<wql query>,
+///         "restrictions": Optional<filter_json>, // see above
 ///         "non_revoked": Optional<<non_revoc_interval>>, // see below,
 ///                        // If specified prover must proof non-revocation
 ///                        // for date in this interval this attribute
@@ -684,7 +685,6 @@ pub  extern fn indy_prover_close_credentials_search(command_handle: i32,
 pub extern fn indy_prover_get_credentials_for_proof_req(command_handle: i32,
                                                         wallet_handle: i32,
                                                         proof_request_json: *const c_char,
-                                                        extra_query_json: *const c_char,
                                                         cb: Option<extern fn(
                                                             xcommand_handle: i32, err: ErrorCode,
                                                             credentials_json: *const c_char)>) -> ErrorCode

libindy/include/indy_anoncreds.h

@@ -159,7 +159,7 @@ extern "C" {
 
     extern indy_error_t indy_prover_search_credentials(indy_handle_t command_handle,
                                                        indy_handle_t wallet_handle,
-                                                       const char *  filter_json,
+                                                       const char *  query_json,
 
                                                        void           (*cb)(indy_handle_t xcommand_handle,
                                                                             indy_error_t  err,

libindy/src/api/anoncreds.rs

@@ -854,15 +854,22 @@ pub extern fn indy_prover_get_credential(command_handle: i32,
 
 /// Gets human readable credentials according to the filter.
 /// If filter is NULL, then all credentials are returned.
-/// Credentials can be filtered by tags created during saving of credential.
+/// Credentials can be filtered by Issuer, credential_def and/or Schema.
 ///
 /// NOTE: This method is deprecated because immediately returns all fetched credentials.
 /// Use <indy_prover_search_credentials> to fetch records by small batches.
 ///
 /// #Params
 /// wallet_handle: wallet handler (created by open_wallet).
-/// filter_json: Wql style query for credentials searching based on tags.
-/// where query: indy-sdk/doc/design/011-wallet-query-language/README.md
+/// filter_json: filter for credentials
+///        {
+///            "schema_id": string, (Optional)
+///            "schema_issuer_did": string, (Optional)
+///            "schema_name": string, (Optional)
+///            "schema_version": string, (Optional)
+///            "issuer_did": string, (Optional)
+///            "cred_def_id": string, (Optional)
+///        }
 /// cb: Callback that takes command result as parameter.
 ///
 /// #Returns
@@ -924,7 +931,7 @@ pub extern fn indy_prover_get_credentials(command_handle: i32,
 ///
 /// #Params
 /// wallet_handle: wallet handler (created by open_wallet).
-/// filter_json: Wql query filter for credentials searching based on tags.
+/// query_json: Wql query filter for credentials searching based on tags.
 /// where query: indy-sdk/doc/design/011-wallet-query-language/README.md
 /// cb: Callback that takes command result as parameter.
 ///
@@ -939,24 +946,24 @@ pub extern fn indy_prover_get_credentials(command_handle: i32,
 #[no_mangle]
 pub extern fn indy_prover_search_credentials(command_handle: i32,
                                              wallet_handle: i32,
-                                             filter_json: *const c_char,
+                                             query_json: *const c_char,
                                              cb: Option<extern fn(
                                                  xcommand_handle: i32, err: ErrorCode,
                                                  search_handle: i32,
                                                  total_count: usize)>) -> ErrorCode {
-    trace!("indy_prover_search_credentials: >>> wallet_handle: {:?}, filter_json: {:?}", wallet_handle, filter_json);
+    trace!("indy_prover_search_credentials: >>> wallet_handle: {:?}, query_json: {:?}", wallet_handle, query_json);
 
-    check_useful_opt_c_str!(filter_json, ErrorCode::CommonInvalidParam3);
+    check_useful_opt_c_str!(query_json, ErrorCode::CommonInvalidParam3);
     check_useful_c_callback!(cb, ErrorCode::CommonInvalidParam4);
 
-    trace!("indy_prover_search_credentials: entities >>> wallet_handle: {:?}, filter_json: {:?}", wallet_handle, filter_json);
+    trace!("indy_prover_search_credentials: entities >>> wallet_handle: {:?}, query_json: {:?}", wallet_handle, query_json);
 
     let result = CommandExecutor::instance()
         .send(Command::Anoncreds(
             AnoncredsCommand::Prover(
                 ProverCommand::SearchCredentials(
                     wallet_handle,
-                    filter_json,
+                    query_json,
                     Box::new(move |result| {
                         let (err, handle, total_count) = result_to_err_code_2!(result, 0, 0);
                         cb(command_handle, err, handle, total_count)
@@ -1092,12 +1099,11 @@ pub  extern fn indy_prover_close_credentials_search(command_handle: i32,
 /// cb: Callback that takes command result as parameter.
 ///
 /// where
-/// where wql query: indy-sdk/doc/design/011-wallet-query-language/README.md
 /// attr_referent: Proof-request local identifier of requested attribute
 /// attr_info: Describes requested attribute
 ///     {
 ///         "name": string, // attribute name, (case insensitive and ignore spaces)
-///         "restrictions": Optional<wql query>.
+///         "restrictions": Optional<filter_json>, // see above
 ///         "non_revoked": Optional<<non_revoc_interval>>, // see below,
 ///                        // If specified prover must proof non-revocation
 ///                        // for date in this interval this attribute
@@ -1109,7 +1115,7 @@ pub  extern fn indy_prover_close_credentials_search(command_handle: i32,
 ///         "name": attribute name, (case insensitive and ignore spaces)
 ///         "p_type": predicate type (Currently ">=" only)
 ///         "p_value": int predicate value
-///         "restrictions": Optional<wql query> .
+///         "restrictions": Optional<filter_json>, // see above
 ///         "non_revoked": Optional<<non_revoc_interval>>, // see below,
 ///                        // If specified prover must proof non-revocation
 ///                        // for date in this interval this attribute

libindy/src/commands/anoncreds/prover.rs

@@ -64,7 +64,7 @@ pub enum ProverCommand {
         Box<Fn(Result<String, IndyError>) + Send>),
     SearchCredentials(
         i32, // wallet handle
-        Option<String>, // filter json
+        Option<String>, // query json
         Box<Fn(Result<(i32, usize), IndyError>) + Send>),
     FetchCredentials(
         i32, // search handle
@@ -184,9 +184,9 @@ impl ProverCommandExecutor {
                 info!(target: "prover_command_executor", "GetCredential command received");
                 cb(self.get_credential(wallet_handle, &cred_id));
             }
-            ProverCommand::SearchCredentials(wallet_handle, filter_json, cb) => {
+            ProverCommand::SearchCredentials(wallet_handle, query_json, cb) => {
                 info!(target: "prover_command_executor", "SearchCredentials command received");
-                cb(self.search_credentials(wallet_handle, filter_json.as_ref().map(String::as_str)));
+                cb(self.search_credentials(wallet_handle, query_json.as_ref().map(String::as_str)));
             }
             ProverCommand::FetchCredentials(search_handle, count, cb) => {
                 info!(target: "prover_command_executor", "FetchCredentials command received");
@@ -396,11 +396,11 @@ impl ProverCommandExecutor {
 
     fn search_credentials(&self,
                           wallet_handle: i32,
-                          filter_json: Option<&str>) -> Result<(i32, usize), IndyError> {
-        debug!("search_credentials >>> wallet_handle: {:?}, filter_json: {:?}", wallet_handle, filter_json);
+                          query_json: Option<&str>) -> Result<(i32, usize), IndyError> {
+        debug!("search_credentials >>> wallet_handle: {:?}, query_json: {:?}", wallet_handle, query_json);
 
         let credentials_search =
-            self.wallet_service.search_indy_records::<Credential>(wallet_handle, filter_json.unwrap_or("{}"), &SearchOptions::id_value())?;
+            self.wallet_service.search_indy_records::<Credential>(wallet_handle, query_json.unwrap_or("{}"), &SearchOptions::id_value())?;
 
         let total_count = credentials_search.get_total_count()?.unwrap_or(0);
 

wrappers/ios/libindy-pod/Indy-demoTests/Case Tests/Anoncreds/AnoncredsHighCases.m

@@ -428,11 +428,11 @@ - (void)testProverCredentialSearchWorks {
     // 2. get credentials
     IndyHandle searchHandle;
     NSNumber *totalCount;
-    ret = [[AnoncredsUtils sharedInstance] proverSearchCredentialsForFilter:@"{}"
+    ret = [[AnoncredsUtils sharedInstance] proverSearchCredentialsForQuery:@"{}"
                                                                walletHandle:walletHandle
                                                                searchHandle:&searchHandle
                                                                  totalCount:&totalCount];
-    XCTAssertEqual(ret.code, Success, @"AnoncredsUtils::proverSearchCredentialsForFilter failed");
+    XCTAssertEqual(ret.code, Success, @"AnoncredsUtils::proverSearchCredentialsForQuery failed");
 
     XCTAssertEqual([totalCount intValue], 3, @"credentials count != 3");
 

wrappers/ios/libindy-pod/Indy-demoTests/Test Utils/AnoncredsUtils.h

@@ -123,7 +123,7 @@
                               walletHandle:(IndyHandle)walletHandle
                             credentilsJson:(NSString **)credentialsJson;
 
-- (NSError *)proverSearchCredentialsForFilter:(NSString *)filterJSON
+- (NSError *)proverSearchCredentialsForQuery:(NSString *)queryJSON
                                  walletHandle:(IndyHandle)walletHandle
                                  searchHandle:(IndyHandle *)searchHandle
                                    totalCount:(NSNumber **)totalCount;

wrappers/ios/libindy-pod/Indy-demoTests/Test Utils/AnoncredsUtils.m

@@ -586,7 +586,7 @@ - (NSError *)proverGetCredentialsForFilter:(NSString *)filterJSON
     return err;
 }
 
-- (NSError *)proverSearchCredentialsForFilter:(NSString *)filterJSON
+- (NSError *)proverSearchCredentialsForQuery:(NSString *)queryJSON
                                  walletHandle:(IndyHandle)walletHandle
                                  searchHandle:(IndyHandle *)searchHandle
                                    totalCount:(NSNumber **)totalCount {
@@ -595,7 +595,7 @@ - (NSError *)proverSearchCredentialsForFilter:(NSString *)filterJSON
 
     completionExpectation = [[XCTestExpectation alloc] initWithDescription:@"completion finished"];
 
-    [IndyAnoncreds proverSearchCredentialsForFilter:filterJSON
+    [IndyAnoncreds proverSearchCredentialsForQuery:queryJSON
                                        walletHandle:walletHandle
                                          completion:^(NSError *error, IndyHandle outSearchHandle, NSNumber *outTotalCount) {
                                              err = error;

wrappers/ios/libindy-pod/Indy/Wrapper/IndyAnoncreds.h

@@ -332,10 +332,17 @@
  Credentials can be filtered by tags created during saving of credential.
 
  NOTE: This method is deprecated because immediately returns all fetched credentials. 
- Use <proverSearchCredentialsForFilter> to fetch records by small batches.
+ Use <proverSearchCredentialsForQuery> to fetch records by small batches.
 
- @param filterJSON: Wql style filter for credentials searching based on tags.
-        (indy-sdk/doc/design/011-wallet-query-language/README.md)
+ @param filterJSON: filter for credentials
+    {
+        "schema_id": string, (Optional)
+        "schema_issuer_did": string, (Optional)
+        "schema_name": string, (Optional)
+        "schema_version": string, (Optional)
+        "issuer_did": string, (Optional)
+        "cred_def_id": string, (Optional)
+    }
  @param walletHandle Wallet handler (created by IndyWallet::openWalletWithName).
  @param completion Callback that takes command result as parameter. 
  Returns credentials json. 
@@ -362,22 +369,22 @@
  to fetch records by small batches (with proverFetchCredentialsWithSearchHandle).
   
  @param walletHandle Wallet handler (created by IndyWallet::openWalletWithName).
- @param filterJson Wql style filter for credentials searching based on tags.
+ @param queryJSON Wql style filter for credentials searching based on tags.
         (indy-sdk/doc/design/011-wallet-query-language/README.md)
  @param completion Callback that takes command result as parameter. 
  Returns 
     searchHandle: Search handle that can be used later to fetch records by small batches (with proverFetchCredentialsWithSearchHandle)
     totalCount: Total count of records
 
  */
-+ (void)proverSearchCredentialsForFilter:(NSString *)filterJSON
++ (void)proverSearchCredentialsForQuery:(NSString *)queryJSON
                             walletHandle:(IndyHandle)walletHandle
                               completion:(void (^)(NSError *error, IndyHandle searchHandle, NSNumber *totalCount))completion;
 
 /**
  Fetch next credentials for search.
   
- @param searchHandle Search handle (created by proverSearchCredentialsForFilter).
+ @param searchHandle Search handle (created by proverSearchCredentialsForQuery).
  @param count Count of credentials to fetch
  @param completion Callback that takes command result as parameter. 
  Returns 
@@ -400,7 +407,7 @@
 /**
  Close credentials search (make search handle invalid)
   
- @param searchHandle Search handle (created by proverSearchCredentialsForFilter).
+ @param searchHandle Search handle (created by proverSearchCredentialsForQuery).
  Returns no result
 
  */
@@ -432,12 +439,11 @@
                        // (can be overridden on attribute level)
     }
  where
- wql query: indy-sdk/doc/design/011-wallet-query-language/README.md
  attr_referent: Proof-request local identifier of requested attribute
  attr_info: Describes requested attribute
      {
          "name": string, // attribute name, (case insensitive and ignore spaces)
-         "restrictions": Optional<wql query>,
+         "restrictions": Optional<filterJSON>, // see above
          "non_revoked": Optional<<non_revoc_interval>>, // see below,
                         // If specified prover must proof non-revocation
                         // for date in this interval this attribute
@@ -449,7 +455,7 @@
          "name": attribute name, (case insensitive and ignore spaces)
          "p_type": predicate type (Currently ">=" only)
          "p_value": int predicate value
-         "restrictions": Optional<wql query>,
+         "restrictions": Optional<filterJSON>, // see above,
          "non_revoked": Optional<<non_revoc_interval>>, // see below,
                         // If specified prover must proof non-revocation
                         // for date in this interval this attribute