From 1c21a0b0c811fb22de7d5fcc57463bac5e49f688 Mon Sep 17 00:00:00 2001
From: Mirna Gama <mirnabeatrizgamav@gmail.com>
Date: Thu, 4 Jan 2024 13:19:03 -0300
Subject: [PATCH] [R1] Update README with API Documentation for POST /doctors

---
 README.md | 39 ++++++++++++++++++++++++++++++++++++++-
 1 file changed, 38 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 140fcf0..86cc19b 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,6 @@
-## Hospital Management - API Module ![Build Status](https://github.com/MirnaGama/hospital-management-api/actions/workflows/maven.yml/badge.svg)
+# Hospital Management - API Module ![Build Status](https://github.com/MirnaGama/hospital-management-api/actions/workflows/maven.yml/badge.svg)
+
+## About the project
 Hospital Management API built in Spring Boot
 
 ### Prerequisites:
@@ -17,3 +19,38 @@ Hospital Management API built in Spring Boot
 - [ ] R8 - Patient Exclusion
 - [ ] R9 - Consultation Scheduling
 - [ ] R10 - Consultation Cancellation
+
+## API Documentation
+
+### /doctors
+
+POST - [**/api/v1.0/doctors**] - Adds a new doctor
+
+- **Body:**
+```
+{   
+    "name" (string, required),  
+    "email" (string, required),  
+    "crm" (string, required),  
+    "telephone" (string, required),  
+    "address": {   
+        "street" (string, required),
+        "neighborhood" (string, required), 
+        "zipcode" (string, required),  
+        "city" (string, required),  
+        "state" (string, required),
+        "additionalDetails" (string, optional),  
+        "houseNumber" (string, optional)
+    } 
+}
+```
+
+- **Responses:**
+
+| Code  | Description |
+| ------------- | ------------- |
+| `200` | _Successful operation_ |
+| `400` | _Validation Error_ |
+
+
+