added documentation

Author: barreraalexander

docs/how-to-manage-api-products.md

@@ -23,4 +23,4 @@ The route used to create a product is named `create_product`. This route expects
 The route used to update a product is named `update_product.` This route expects to recieve a product id (integer) in the url, as raw as json, specifying which column needs to be changed. The exact data required and corresponding types allowed can be seen in `/src/schemas.py`, under the class ProductBase.
 
 **Delete ->**
-The route used to delete one product is named `get_product.` This route expects to recieve a product id (integer) in the url. 
+The route used to delete one product is named `delete_product.` This route expects to recieve a product id (integer) in the url. 

docs/how-to-manage-api-sales.md

@@ -23,4 +23,4 @@ The route used to create a sale is named `create_sale`. This route expects to re
 The route used to update a sale is named `update_sale.` This route expects to recieve a sale id (integer) in the url, as raw as json, specifying which column needs to be changed. The exact data required and corresponding types allowed can be seen in `/src/schemas.py`, under the class SaleBase.
 
 **Delete ->**
-The route used to delete one sale is named `get_sale.` This route expects to recieve a sale id (integer) in the url. 
+The route used to delete one sale is named `delete_sale.` This route expects to recieve a sale id (integer) in the url. 

docs/how-to-migrate-db.md

@@ -1,5 +1,22 @@
 # How to Migrate DB
 
-The database migration tool we are using is `Alembic.`
+The database migration tool we are using is `Alembic.` Alembic will help use manage various states of the database, including migrating the database strcuture from an sqlite database to a mysql database. We will go step by step, from beginning a fresh sqlite database, adding the base structure of the database, and finally migrating it over to mysql. All of the commands are to be run in the root folder. 
+
+1. To create your first revision (database version): `alembic revision --autogenerate -m "some information about the update"`
+
+2. A new entry will appear in the `/alembic/versions` folder.
+
+3. The entry will have two functions, upgrade and downgrade. If you used the `--autogenerate` flag, Alembic will attempt to fill in these 2 functions. If Alembic can't autogenerate, you will have to write in the changes to your database manually. 
+
+4. After the function is filled in with the proper set of changes. You will run the command: `alembic upgrade head` to upgrade your database to the latest revision. If you have issues,`alembic downgrade <revision number>` will set your database back to an older revision.
+
+
+## Migrating to Mysql
+
+5. After you have a revision created, it is fairly easy to switch over mysql. First, you will have to change what database Alembic is pointing to. This is done is the `alembic/env.py` file, line 14. Line 14 is the uri for sqllite, line 15 (commented out) is for mysql. Simply comment out 14, comment in 15. Now alembic is pointing to your database. 
+
+6. Now that Alembic is pointing to your database, migrating your structure over to that database is as simple as running `alembic upgrade head`.
+
+
 
 

docs/how-to-secure-api.md

@@ -1,4 +1,4 @@
-# How the API is secured
+# How the API is Secured
 
 The application is secured using jwt, or `json web tokens`. Communicating to the api that you are authorized occurs in two ways, differing on whether you're manually making requests or trying to access pages that require authentication.
 

docs/how-to-use-mysql.md

@@ -1,5 +1,5 @@
-# How to create initial DB
+# How to Use Mysql DB
 
 Switching the application over from SQLITE to Mysql is as simple as changing the projects environment variable `DEBUGGING` to 0, which means false. The application will automatically look for a mysql server with the proper authentication. However, it's very important that you already have mysql installed and an empty schema.
 
-Furthermore, the Alembic configuration should be changed so that it is pointing to the correct url. The config for alembic is `/alembic/env.py`. 
+Furthermore, the Alembic configuration should be changed so that it is pointing to the correct url. The config for alembic is `/alembic/env.py`.