renamed handshake to api

CSSE6400 · May 26, 2024 · 8aa582c · 8aa582c
1 parent c1fca5d
commit 8aa582c
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # UniBasement
 
-## [Architecture](model/ARCHITECTURE.md) | [Handshake](docs/HANDSHAKE.md) | [Database](docs/DATABASE.md) | [AI](AI.md) | [Report](report/REPORT.md) | [Tests](docs/TESTS.MD) | [Proposal](https://csse6400.github.io/project-proposal-2024/s4702098/proposal.html)
+## [Architecture](model/ARCHITECTURE.md) | [API](docs/API.md) | [Database](docs/DATABASE.md) | [AI](AI.md) | [Report](report/REPORT.md) | [Tests](docs/TESTS.MD) | [Proposal](https://csse6400.github.io/project-proposal-2024/s4702098/proposal.html)
 
 ## Description
 

diff --git a/backend/src/routes/routes.ts b/backend/src/routes/routes.ts
@@ -35,7 +35,7 @@ export const router = Router();
  * Puts
  * ====
  *
- * Inputs and params are described within HANDSHAKE.md
+ * Inputs and params are described within API.md
  *
  */
 
@@ -49,7 +49,7 @@ router.put('/comments/:commentId/edit', <any>multer().single('commentPNG'), edit
  * Patches
  * =======
  *
- * Inputs and params are described within HANDSHAKE.md
+ * Inputs and params are described within API.md
  *
  */
 
@@ -75,7 +75,7 @@ router.patch('/comments/:commentId/upvote', upvoteComments);
  * Post Requests below
  * ===================
  *
- * Inputs and params are described within HANDSHAKE.md
+ * Inputs and params are described within API.md
  *
  */
 
@@ -98,7 +98,7 @@ router.post('/courses', postCourse);
  * Get Requests below
  * ==================
  *
- * See outputs and params in HANDSHAKE.md
+ * See outputs and params in API.md
  *
  */
 

diff --git a/docs/HANDSHAKE.md → docs/API.md b/docs/HANDSHAKE.md → docs/API.md
diff --git a/report/REPORT.md b/report/REPORT.md
@@ -88,7 +88,7 @@ Secondly, by deploying our application to Amazon Web Services, we remove the nec
 
 #### Maintainability
 
-Maintainability has been achieved primarily by the abstraction of code and layers. In the backend we have separated the functionality behind the endpoints in their own files and services to allow for easier maintainability. This also allows us to easily improve our architecture in the future by converting to a microservices architecture for better maintainability. We also use docker and containerization to separate the frontend, backend and database into three independent containers that communicate with each other through highly [documented](../docs/HANDSHAKE.md) API calls over HTTPS. This level of separation allows for ease of use and ease of access as each container has vastly different responsibilities.
+Maintainability has been achieved primarily by the abstraction of code and layers. In the backend we have separated the functionality behind the endpoints in their own files and services to allow for easier maintainability. This also allows us to easily improve our architecture in the future by converting to a microservices architecture for better maintainability. We also use docker and containerization to separate the frontend, backend and database into three independent containers that communicate with each other through highly [documented](../docs/API.md) API calls over HTTPS. This level of separation allows for ease of use and ease of access as each container has vastly different responsibilities.
 
 We also made the effort to use the same programming language for both the front and backend. This acts as a redundancy that even if our documentation is unable to effectively communicate our decisions or is no longer update, the developer should be easily able to read the codebase and understand the importance and inner working of each component of the system.