adding docs for api endpoints (#532)

mobilecoinofficial · Oct 21, 2022 · d496c71 · d496c71
1 parent ad11827
commit d496c71
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 2 deletions.
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -3,7 +3,7 @@
 * [Welcome!](README.md)
 
 ## API Endpoints
-* v2
+* [v2](v2/README.md)
   * Account
     * [Account](v2/accounts/account/README.md)
       * [Create Account](v2/api-endpoints/create_account.md)
@@ -60,7 +60,7 @@
     * [Get Wallet Status](v2/api-endpoints/get_wallet_status.md)
   * [Version](v2/other/version/README.md)
     * [Get Version](v2/api-endpoints/version.md)
-* v1 (deprecated)
+* [v1 (deprecated)](v1/README.md)
   * Account
     * [Account](v1/accounts//account/README.md)
       * [Create Account](v1/api-endpoints/create_account.md)

diff --git a/docs/v1/README.md b/docs/v1/README.md
@@ -0,0 +1,5 @@
+To target v1 api endpoints, send post requests to the following url with the appropriate host and port (depending on your configuration). The default port is 9090
+
+```bash
+$HOST:$PORT/wallet
+```
diff --git a/docs/v2/README.md b/docs/v2/README.md
@@ -0,0 +1,5 @@
+To target v2 api endpoints, send post requests to the following url with the appropriate host and port (depending on your configuration). The default port is 9090
+
+```bash
+$HOST:$PORT/wallet/v2
+```