API docs refactoring

Author: dmugtasimov

.gitignore

@@ -53,7 +53,6 @@ nosetests.xml
 
 # pytest
 .pytest_cache
-node/blockchain/tests/examples/testing.json
 
 # mypy
 .mypy_cache

node/blockchain/constants.py

@@ -5,16 +5,3 @@
 
 LAST_BLOCK_ID = 'last'
 BLOCK_LOCK = 'block'
-
-NODE_DETAILS_EXAMPLE = 'node_details'
-NODE_LIST_EXAMPLE = 'node_list'
-ACCOUNT_STATE_DETAILS_EXAMPLE = 'account_state_details'
-
-BLOCK_DETAILS_GENESIS_EXAMPLE = 'block_details_genesis'
-BLOCK_DETAILS_COIN_TRANSFER_EXAMPLE = 'block_details_coin_transfer'
-BLOCK_DETAILS_NODE_DECLARATION_EXAMPLE = 'block_details_node_declaration'
-BLOCK_DETAILS_PV_SCHEDULE_UPDATE_EXAMPLE = 'block_details_pv_schedule_update'
-BLOCK_LIST_EXAMPLE = 'block_list'
-
-SIGNED_CHANGE_REQUEST_COIN_TRANSFER_EXAMPLE = 'signed_change_request_coin_transfer'
-SIGNED_CHANGE_REQUEST_NODE_DECLARATION_EXAMPLE = 'signed_change_request_node_declaration'

node/blockchain/serializers/account_state.py

@@ -6,10 +6,6 @@
 
 
 class AccountStateSerializer(serializers.ModelSerializer):
-    """
-    Account state, which defines a set of attributes about the current account state, such as account balance
-    (the amount of coins owned by an account). These attributes change over time.
-    """
 
     _id = serializers.CharField()
     balance = serializers.IntegerField()

node/blockchain/serializers/block.py

@@ -11,14 +11,6 @@
 
 
 class BlockSerializer(serializers.ModelSerializer):
-    """
-    Block are structure that store data. These data describe changes to the network and originate
-    from signed change requests, such as:<br>
-    * Genesis;<br>
-    * Transfers of coins between accounts;<br>
-    * New nodes being added to the network;<br>
-    * Primary Validator Schedule Updates.
-    """
 
     signer = serializers.CharField(min_length=64, max_length=64, write_only=True)
     signature = serializers.CharField(min_length=128, max_length=128, write_only=True)

node/blockchain/serializers/node.py

@@ -4,11 +4,6 @@
 
 
 class NodeSerializer(serializers.ModelSerializer):
-    """
-    The network uses multiple nodes, which are servers with several responsibilities.
-    Nodes connect users or client apps to the network, or enable important processes,
-    such as transaction validation.
-    """
 
     # TODO(dmu) HIGH: Instead of redefining serializer fields generate serializer from
     #                 Node model metadata

node/blockchain/serializers/signed_change_request.py

@@ -15,11 +15,6 @@
 
 
 class SignedChangeRequestSerializer(serializers.Serializer, ValidateUnknownFieldsMixin):
-    """
-    Signed change request is a data update request. Next types are allowed:<br>
-    * Transfers of coins between accounts;<br>
-    * New nodes being added to the network.<br>
-    """
 
     signer = serializers.CharField()
     signature = serializers.CharField()