Added required/optional for all types in README

FPriv · Nov 12, 2019 · 342a40b · 342a40b
1 parent 414c7b2
commit 342a40b
Show file tree

Hide file tree

Showing 5 changed files with 88 additions and 88 deletions.
diff --git a/documentation/anchors.md b/documentation/anchors.md
@@ -21,7 +21,7 @@ const anchorObj = await factomConnectSDK.anchors.get({
 
 | **Name**                     | **Type** | **Description**                                                                                                                                                                                                                                                                       | **SDK Error Message & Description**       <img width=400/>                          |
 |------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
-| `params.objectIdentifier`             | string | Represented by an entry hash, chain id, directory block height, directory block keymr, entry block keymr, or factoid block keymr.                                                                                                                                                                                                                            | **objectIdentifier is required** </br> `objectIdentifier` parameter was not provided. |
+| `params.objectIdentifier`             | string <br> `Required` | Represented by an entry hash, chain id, directory block height, directory block keymr, entry block keymr, or factoid block keymr.                                                                                                                                                                                                                            | **objectIdentifier is required** </br> `objectIdentifier` parameter was not provided. |
 |
 
 **Returns**

diff --git a/documentation/apiInfo.md b/documentation/apiInfo.md
@@ -12,8 +12,8 @@ const apiInfo = await factomConnectSDK.apiInfo.get();
 
 | **Name**                 | **Type** | **Description**                                                                                                                                                                                                                                                                                                                               | **SDK Error Message & Description** |
 |--------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------|
-| `params.accessToken` | object | This is the override parameter that allows user to specify the following two authentication parameters which will override the same parameters which have already been set on the instantiation of the SDK class </br>  * `appId` (string) </br> * `appKey`  (string)|
-| `params.baseUrl` | string | This is the override parameter that allows user to specify a different API Base URL for your application (which you can see by clicking on any of the applications in the application list the you see upon logging into https://account.factom.com)   |
+| `params.accessToken` | object <br> `Optional` | This is the override parameter that allows user to specify the following two authentication parameters which will override the same parameters which have already been set on the instantiation of the SDK class </br>  * `appId` (string) </br> * `appKey`  (string)|
+| `params.baseUrl` | string <br> `Optional` | This is the override parameter that allows user to specify a different API Base URL for your application (which you can see by clicking on any of the applications in the application list the you see upon logging into https://account.factom.com)   |
 
 **Returns**