From f3d736ceb5b188b72b7ee2ff5acf15b5e23ef9d1 Mon Sep 17 00:00:00 2001 From: Mirna Gama Date: Sat, 6 Jan 2024 14:33:07 -0300 Subject: [PATCH] [R4] Update README with API Documentation for DELETE /doctors --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/README.md b/README.md index 3059571..9ba4166 100644 --- a/README.md +++ b/README.md @@ -149,3 +149,40 @@ Hospital Management API built in Spring Boot | `400` | _Validation Error_ | +#### DELETE - [**/api/v1.0/doctors/{id}**] - Deactivates an existing doctor + +- **Response Body Example:** +``` +{ + "id": 2, + "name": "DEACTIVATED USER TEST", + "email": "test@gmail.com", + "crm": "12456", + "telephone": "(81) 99999999", + "specialty": "ORTHOPEDICS", + "active": false, + "address": { + "street": "TEST STR.", + "neighborhood": "TEST NEIGHBORHOOD", + "zipCode": "12345678", + "city": "TEST CITY", + "state": "ST", + "additionalDetails": null, + "houseNumber": null + } +} +``` + +- **Request Parameters:** + +| Key | Description | +| ------------- | ------------- | +| `id` | _Unique identifier of the doctor who will be deactivated_ | + +- **Responses:** + +| Code | Description | +| ------------- | ------------- | +| `200` | _Successful operation_ | +| `400` | _Validation Error_ | +