Merge pull request #267 from lzpap/is_promotable_return_type

Fine-tune is_promotable response dictionary
iotaledger · Nov 19, 2019 · 6090958 · 6090958
2 parents 2e73a66 + 7c647c4
commit 6090958
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 2 deletions.
diff --git a/iota/api.py b/iota/api.py
@@ -1357,6 +1357,8 @@ def is_promotable(
                     'info': Optional(List[Text])
                         If `promotable` is ``False``, this contains info about what
                         went wrong.
+                        Note that when 'promotable' is ``True``, 'info' does not
+                        exist.
 
                 }
 

diff --git a/iota/commands/extended/is_promotable.py b/iota/commands/extended/is_promotable.py
@@ -93,8 +93,9 @@ def _execute(self, request):
             response['promotable'] = response['promotable'] and is_within
 
         # If there are no problems, we don't need 'info' field
+        # Delete info field to make it consistent with check_consistency repsonse.
         if response['promotable']:
-            response['info'] = None
+            del response['info']
 
         return response
 

diff --git a/test/commands/extended/is_promotable_test.py b/test/commands/extended/is_promotable_test.py
@@ -317,7 +317,6 @@ def test_happy_path(self):
 
                 {
                     'promotable': True,
-                    'info': None,
                 }
             )