Merge pull request hyperledger-archives#1532 from Artemkaaas/feature/…

…auth-rule-builder Updated documentation for AUTH_RULE builder
srottem · Mar 14, 2019 · e7359ac · e7359ac
2 parents 5f2a1d0 + 0db9784
commit e7359ac
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 4 deletions.
diff --git a/cli/src/commands/ledger.rs b/cli/src/commands/ledger.rs
@@ -1230,7 +1230,7 @@ pub mod auth_rule_command {
                 .add_required_param("constraint", r#"Set of constraints required for execution of an action
          {
              constraint_id - type of a constraint. Can be either "ROLE" to specify final constraint or  "AND"/"OR" to combine constraints.
-             role - role of a user which satisfy to constrain.
+             role - role associated value {TRUSTEE: 0, STEWARD: 2, TRUST_ANCHOR: 101, NETWORK_MONITOR: 201, ANY: *}.
              sig_count - the number of signatures required to execution action.
              need_to_be_owner - if user must be an owner of transaction.
              metadata - additional parameters of the constraint.
@@ -1241,8 +1241,8 @@ pub mod auth_rule_command {
              auth_constraints: [<constraint_1>, <constraint_2>]
          }
                 "#)
-                .add_example(r#"ledger auth-rule txn_type=NYM action=ADD field=role new_value=101 constraint={"sig_count":1,"role":0,"constraint_id":"role","need_to_be_owner":false}"#)
-                .add_example(r#"ledger auth-rule txn_type=NYM action=EDIT field=role old_value=101 new_value=0 constraint={"sig_count":1,"role":0,"constraint_id":"role","need_to_be_owner":false}"#)
+                .add_example(r#"ledger auth-rule txn_type=NYM action=ADD field=role new_value=101 constraint="{"sig_count":1,"role":"0","constraint_id":"ROLE","need_to_be_owner":false}""#)
+                .add_example(r#"ledger auth-rule txn_type=NYM action=EDIT field=role old_value=101 new_value=0 constraint="{"sig_count":1,"role":"0","constraint_id":"ROLE","need_to_be_owner":false}""#)
                 .finalize()
     );
 

diff --git a/libindy/src/api/ledger.rs b/libindy/src/api/ledger.rs
@@ -1860,6 +1860,10 @@ pub extern fn indy_get_response_metadata(command_handle: CommandHandle,
 ///         'auth_constraints': [<constraint_1>, <constraint_2>]
 ///     }
 ///
+/// Default ledger auth rules: https://github.com/hyperledger/indy-node/blob/master/docs/source/auth_rules.md
+///
+/// More about AUTH_RULE request: https://github.com/hyperledger/indy-node/blob/master/docs/source/requests.md#auth_rule
+///
 /// cb: Callback that takes command result as parameter.
 ///
 /// #Returns

diff --git a/wrappers/ios/libindy-pod/Indy/Wrapper/IndyLedger.h b/wrappers/ios/libindy-pod/Indy/Wrapper/IndyLedger.h
@@ -596,6 +596,10 @@
             'auth_constraints': [<constraint_1>, <constraint_2>]
         }
 
+ Default ledger auth rules: https://github.com/hyperledger/indy-node/blob/master/docs/source/auth_rules.md
+
+ More about AUTH_RULE request: https://github.com/hyperledger/indy-node/blob/master/docs/source/requests.md#auth_rule
+
  @param completion Callback that takes command result as parameter. Returns request result as json.
  */
 + (void)buildAuthRuleRequestWithSubmitterDid:(NSString *)submitterDid

diff --git a/wrappers/java/src/main/java/org/hyperledger/indy/sdk/ledger/Ledger.java b/wrappers/java/src/main/java/org/hyperledger/indy/sdk/ledger/Ledger.java
@@ -1290,7 +1290,11 @@ public static CompletableFuture<String> getResponseMetadata(
 	 *         'constraint_id': "AND" or "OR"
 	 *         'auth_constraints': [[constraint_1], [constraint_2]]
 	 *     }
-
+	 *
+	 * Default ledger auth rules: https://github.com/hyperledger/indy-node/blob/master/docs/source/auth_rules.md
+	 *
+	 * More about AUTH_RULE request: https://github.com/hyperledger/indy-node/blob/master/docs/source/requests.md#auth_rule
+	 *
 	 * @return A future resolving to a request result as json.
 	 * @throws IndyException Thrown if an error occurs when calling the underlying SDK.
 	 */

diff --git a/wrappers/nodejs/README.md b/wrappers/nodejs/README.md
@@ -1776,6 +1776,11 @@ can be combined by
      'auth_constraints': [<constraint_1>, <constraint_2>]
  }
 ```
+
+Default ledger auth rules: https://github.com/hyperledger/indy-node/blob/master/docs/source/auth_rules.md
+
+More about AUTH_RULE request: https://github.com/hyperledger/indy-node/blob/master/docs/source/requests.md#auth_rule   
+
 * __->__ `request`: Json
 
 Errors: `Common*`

diff --git a/wrappers/python/indy/ledger.py b/wrappers/python/indy/ledger.py
@@ -1295,6 +1295,10 @@ async def build_auth_rule_request(submitter_did: str,
             'auth_constraints': [<constraint_1>, <constraint_2>]
         }
 
+    Default ledger auth rules: https://github.com/hyperledger/indy-node/blob/master/docs/source/auth_rules.md
+
+    More about AUTH_RULE request: https://github.com/hyperledger/indy-node/blob/master/docs/source/requests.md#auth_rule
+
     :return: Request result as json.
     """