Fix examples, add valid keys case #56

grimadas · 2018-02-02T09:10:56Z

Fix comma issue as described in Client API support for MST iroha#779
Replace ... with valid keys

Signed-off-by: grimadas <bulat.nasrulin@gmail.com>

lebdron

Please run validator on examples.

lebdron · 2018-02-06T09:56:37Z

source/includes/_transactions.md

@@ -11,11 +11,16 @@ message Transaction {
 ```json
 {
    /* Transaction */


Such comments are not valid JSON syntax, consider removing.

lebdron · 2018-02-06T09:58:40Z

source/includes/_transactions.md

+    "created_ts": 1517560129182,
+    "creator_account_id": "admin@test",
+    "tx_counter": 1,
+    "commands": []


Transactions with no commands are currently invalid, consider adding a small command, such as AddPeer.

lebdron · 2018-02-06T09:59:29Z

source/includes/_transactions.md

@@ -53,13 +58,12 @@ message Payload {
 {
    "commands": [
        {
-            "command_type": string(?),
-            /* other command-specific fields */
+            /* command-specific fields */


Such comments are invalid JSON syntax. Also empty commands are not currently accepted, consider adding a small command such as AddPeer.

The example for the valid transaction is provided above, this is used for explanation. Is it necessary to complicate it, as it might hurt the explanation?

Concern is that person can just try to copy and paste the example and try to run it with iroha-cli. Maybe this explanation can be done in text, and not in JSON?

lebdron · 2018-02-06T10:00:57Z

source/includes/_transactions.md

@@ -75,10 +79,10 @@ message Signature {
 {
    "signatures": [
        {
-            "pubkey": string(64),
-            "signature": string(128),
+             "pubkey": "407e57f50ca48969b08ba948171bb2435e035d82cec417e18e4a38f5fb113f83",


Space looks redundant, maybe run some JSON beautifier on examples?

lebdron · 2018-02-06T10:03:04Z

source/includes/_queries.md

    "creator_account_id": "admin@test",
    "query_counter": 1,
    "query_type" : "GetTransactions",
-    "tx_hashes": [string(64),…]
+    "tx_hashes": [bf6edb882d53f5532cb416455834878db7af08fb814f8c95d6867a6d9eea4057]


Not sure if this is valid, since other hex strings are enclosed in "".

Signed-off-by: grimadas <bulat.nasrulin@gmail.com>

Outdated

l4l

GetAccountDetail query is mssing
Check the rest details of all types, there's also a lot outdated info here
Also uppercase letters allowed only at the json's keys

l4l · 2018-02-16T11:47:19Z

source/includes/_commands.md

@@ -357,9 +356,9 @@ message DetachRole {
        {
            "command_type": "DetachRole",
            "account_id": "test@test",
-            "role_name": "user"
+            "role_name": "User"


Role should be in lower case

l4l · 2018-02-16T11:51:13Z

source/includes/_commands.md

@@ -319,11 +319,10 @@ message CreateRole {
            "command_type": "CreateRole",
            "role_name": "MoneyCreator",
            "permissions": [
-                "CanAddAssetQuantity",
-                …
+                "CanAddAssetQuantity"


It was changed to can_add_asset_quantity at hyperledger-iroha/iroha@999a1c7

l4l · 2018-02-16T11:54:50Z

source/includes/_queries.md

-            "pubkey": "…",
-            "signature": "…"
+            "pubkey": "407e57f50ca48969b08ba948171bb2435e035d82cec417e18e4a38f5fb113f83",
+            "signature": "81744e004555970ad114a2b8f7a0d1bb087e26c6e009a6147781a5042dbbf8e00f1fd5a4d4ddb123c1c0813f00d633b7295e482a43001edbe7f51dd4d32aef05"


Why all of the signatures are the same?

this is just an example, don't worry

l4l · 2018-02-16T11:57:40Z

source/includes/_queries.md

    "creator_account_id": "admin@test",
    "query_counter": 1,
    "query_type" : "GetRolePermissions",
-    "role_id" : "MoneyCreator",
+    "role_id" : "MoneyCreator"


Signed-off-by: grimadas <bulat.nasrulin@gmail.com>

l4l · 2018-02-20T08:15:46Z

source/includes/_commands.md

@@ -393,9 +392,9 @@ message GrantPermission {
        {
            "command_type": "GrantPermission",
            "account_id": "takemiya@soramitsu",
-            "permission_name": "CanAddAssetQuantity"
+            "permission_name": "can_add_asset_quantity"


can_add_asset_qty :(

l4l · 2018-02-20T08:15:57Z

source/includes/_commands.md

@@ -164,9 +164,9 @@ message AppendRole {
        {
            "command_type": "AppendRole",
            "account_id": "takemiya@test",
-            "role_name": "Administrator"
+            "role_name": "administrator"


Seems it too long

l4l · 2018-02-20T08:16:10Z

source/includes/_commands.md

@@ -469,9 +468,9 @@ message RevokePermission {
        {
            "command_type": "RevokePermission",
            "account_id": "takemiya@soramitsu",
-            "permission_name": "CanAddAssetQuantity"
+            "permission_name": "can_add_asset_quantity"


l4l · 2018-02-20T08:17:06Z

source/includes/_transactions.md

+   "commands":[  
+      {  
+         "command_type":"CreateAccount",
+         "account_name":"makoto.takemiya",


'.' isn't accepted

Signed-off-by: grimadas <bulat.nasrulin@gmail.com>

l4l · 2018-03-24T16:56:37Z

Any progress on that?

grimadas added 5 commits February 2, 2018 17:08

Fix examples, add valid keys

a005277

Signed-off-by: grimadas <bulat.nasrulin@gmail.com>

Merge branch 'docs' into docs

bc33718

Remove three dots in docs

78197f0

Signed-off-by: grimadas <bulat.nasrulin@gmail.com>

Remove three dots in commands

cc2aa64

Signed-off-by: grimadas <bulat.nasrulin@gmail.com>

Merge branch 'docs' of https://github.com/grimadas/iroha-api into docs

bad2fd5

kamilsa approved these changes Feb 6, 2018

View reviewed changes

lebdron previously requested changes Feb 6, 2018

View reviewed changes

Add json fix, beautify and format

f7f8caa

Signed-off-by: grimadas <bulat.nasrulin@gmail.com>

grimadas requested review from luckychess and neewy February 13, 2018 04:17

grimadas requested a review from l4l February 16, 2018 06:44

l4l suggested changes Feb 16, 2018

View reviewed changes

Update commands

815cf46

Signed-off-by: grimadas <bulat.nasrulin@gmail.com>

l4l reviewed Feb 20, 2018

View reviewed changes

grimadas added 2 commits February 20, 2018 16:25

Fix commands parameters

a62411e

Signed-off-by: grimadas <bulat.nasrulin@gmail.com>

Fix tx parameters

3672eac

Signed-off-by: grimadas <bulat.nasrulin@gmail.com>

l4l approved these changes Feb 20, 2018

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix examples, add valid keys case #56

Fix examples, add valid keys case #56

grimadas commented Feb 2, 2018

lebdron left a comment

lebdron Feb 6, 2018

lebdron Feb 6, 2018

lebdron Feb 6, 2018

grimadas Feb 7, 2018

lebdron Feb 13, 2018

lebdron Feb 6, 2018

grimadas Feb 6, 2018

lebdron Feb 6, 2018

l4l left a comment

l4l Feb 16, 2018

l4l Feb 16, 2018

l4l Feb 16, 2018

neewy Feb 20, 2018

l4l Feb 16, 2018

l4l Feb 20, 2018

l4l Feb 20, 2018

l4l Feb 20, 2018

l4l Feb 20, 2018

l4l commented Mar 24, 2018

Fix examples, add valid keys case #56

Are you sure you want to change the base?

Fix examples, add valid keys case #56

Conversation

grimadas commented Feb 2, 2018

lebdron left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

l4l left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

l4l commented Mar 24, 2018