From: Yongfeng LI <wliyongfeng@gmail.com>
Date: Tue, 15 May 2018 11:40:54 +0000 (+0800)
Subject: improve assets api doc
X-Git-Tag: v1.0.1~14
X-Git-Url: http://git.osdn.net/view?p=bytom%2Fbytom-node-sdk.git;a=commitdiff_plain;h=795ee7a21afe461426dda24e3a1032a1048c6402

improve assets api doc
---

diff --git a/src/api/assets.js b/src/api/assets.js
index 10e2256..e84f46e 100644
--- a/src/api/assets.js
+++ b/src/api/assets.js
@@ -69,7 +69,7 @@ const assetsApi = (connection) => {
      * @param {module:AssetsApi~quorum} quorum - The number of keys required to sign transactions for the account.
      * @param {module:AssetsApi~alias} alias - Asset alias.
      * @param {module:AssetsApi~definition} definition - Asset definition.
-     * @returns {Promise<Response>} Newly created asset response.
+     * @returns {Promise<Asset>} Newly created asset.
      */
     create: (xpubs, quorum, alias, definition) => connection.request('/create-asset', {
       alias,
@@ -81,26 +81,25 @@ const assetsApi = (connection) => {
     /**
      * List all assets in one Bytom node.
      *
-     * @returns {Promise<Response>} target assets response.
+     * @returns {Promise<Array<Asset>>} target assets.
      */
-    listAssets: () => connection.request('/list-assets', {}),
+    list: () => connection.request('/list-assets', {}),
 
     /**
      * Get asset by the asset id.
      *
      * @param {module:AssetsApi~id} id - Asset id.
-     * @returns {Promise<Response>} target asset response.
+     * @returns {Promise<Asset>} target asset.
      */
-    getAsset: (id) => connection.request('/get-asset', {id}),
+    getById: (id) => connection.request('/get-asset', {id}),
 
     /**
      * Update asset alias.
      *
      * @param {module:AssetsApi~id} id - Asset id.
      * @param {String} newAlias - new alias.
-     * @returns {Promise<Response>} update response.
      */
-    updateAssetAlias: (id, newAlias) => connection.request('/update-asset-alias', {id, alias: newAlias})
+    updateAlias: (id, newAlias) => connection.request('/update-asset-alias', {id, alias: newAlias})
   }
 }