From 345cdd98a8bd1f89f6eb847e377c2b435be73e28 Mon Sep 17 00:00:00 2001 From: Mirna Gama Date: Fri, 5 Jan 2024 16:36:52 -0300 Subject: [PATCH] [R3] Update README with API Documentation for PUT /doctors --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/README.md b/README.md index cad463a..8b29c92 100644 --- a/README.md +++ b/README.md @@ -120,4 +120,31 @@ Hospital Management API built in Spring Boot | `200` | _Successful operation_ | +#### PUT - [**/api/v1.0/doctors**] - Updates a existing doctor + +- **Body:** +``` +{ + "id" (number, required), + "name" (string, optional), + "telephone" (string, optional), + "address": { + "street" (string, optional), + "neighborhood" (string, optional), + "zipcode" (string, optional), + "city" (string, optional), + "state" (string, optional), + "additionalDetails" (string, optional), + "houseNumber" (string, optional), + } +} +``` + +- **Responses:** + +| Code | Description | +| ------------- | ------------- | +| `200` | _Successful operation_ | +| `400` | _Validation Error_ | +