From 9c0fec4fdfd90adb71a5aa53b85513fe338f35e7 Mon Sep 17 00:00:00 2001 From: Mirna Gama Date: Sat, 6 Jan 2024 18:59:42 -0300 Subject: [PATCH] [R5] Update README with API Documentation for POST /patients --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.md b/README.md index 59a43ec..221e450 100644 --- a/README.md +++ b/README.md @@ -186,3 +186,33 @@ Hospital Management API built in Spring Boot | `200` | _Successful operation_ | | `400` | _Validation Error_ | +### /patients + +#### POST - [**/api/v1.0/patients**] - Adds a new patient + +- **Body:** +``` +{ + "name" (string, required), + "email" (string, required), + "cpf" (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 | +| ------------- | ------------- | +| `201` | _Successfully created_ | +| `400` | _Validation Error_ | +