diff --git a/README.md b/README.md index 46eeab0..0f4aa98 100644 --- a/README.md +++ b/README.md @@ -279,14 +279,12 @@ null #### А1.Пользователь создает новую запись в дневнике * Если отсутствуют, то подключаются идентификаторы мании, депрессии, настроения, активности, аппетита, сна, тревоги * Пользователь кликает по соответствующей кнопке добавления записи в дневник -* Вызывается модальное окно с формой заполнения записи +* Вызывается меню с формой заполнения записи * Пользователь описывает свое текущее состояние на модальном окне и указывает используемую схему лечения ### 6.Потоки исключений: -#### B1.В приложении отсутствуют схемы лечений -* Выполнение добавления записи невозможно, поэтому кнопка вызова модального окна блокируется -#### B2.Пользователь оставил пустым любое из полей, кроме comment +#### B1.Пользователь оставил пустым любое из полей, кроме comment * Запись о неполном состоянии нельзя создать. Кнопка создания записи заблокирована -#### B3. Идентификаторы состояний не подгрузились +#### B2. Идентификаторы состояний не подгрузились * На поле вводаставится заглушка, делающая невозможным его заполнение. ### 7.Постусловия * Пользователь добавил запись с указанной датой и прочими состояниями в БД @@ -347,7 +345,104 @@ null ##### Errors * `400 BAD_REQUEST` — отсутствуют обязательные поля * `400 BAD_REQUEST` — сервер не смог десереализовать JSON -* `422 UNPROCECCABLE_ENTITY` - Во времени значение размерностей ниже, чем день, должно быть равно 0 +* `422 UNPROCECCABLE_ENTITY` - Во `time` значение размерностей ниже, чем день, должно быть равно 0 +* `422 TREATMENT_SCHEME_IS_NOT_EXISTS` - такой схемы лечения болезни не существует + +### 10. Используемые сущности ДБ +* diaries(uuid(PK), time , mania_level , depression_level , mood_level , activity_level , appetite_level , dream_level , anxiety_level, user_treatment_schemes_uuid) +* mania(level(PK)) +* depressions(level(PK)) +* moods(level(PK)) +* activities(level(PK)) +* appetites(level(PK)) +* dreams(level(PK)) +* anxiety(level(PK)) +* user_treatment_schemes(uuid(PK)) + + +## UseCase №5 +### 1.Название: Изменение существующей записи в дневнике +### 2.Актор: Пользователь-пациент +### 3.Цель: Внесение правок в ошибочно заполненный дневник +### 4.Предусловия: +* Пользователь авторизован в системе +* Пользователю доступно для использования окно создания/редактирования дневника +### 5.Основной поток: +#### А1.Пользователь редактирует новую запись в дневнике +* Если отсутствуют, то подключаются идентификаторы мании, депрессии, настроения, активности, аппетита, сна, тревоги +* Пользователь кликает по кнопке редактирования уже существующей записи о своем состоянии в дневнике +* В последующем меню пользователю предоставляется возможность изменить данные о своем состоянии, а также схему лечения +### 6.Потоки исключений: +#### B1.В приложении отсутствуют схемы лечений +* Выполнение добавления записи невозможно, поэтому кнопка вызова меню блокируется +#### B2.Пользователь оставил пустым любое из полей, кроме comment +* Запись о неполном состоянии нельзя создать. Кнопка создания записи заблокирована +#### B3. Идентификаторы состояний не подгрузились +* На поле вводаставится заглушка, делающая невозможным его заполнение. +#### B4. Попытка изменения даты +* Пользователь попытался сделать запрос с измененной датой +### 7.Постусловия +* Пользователь изменил запись соглсано условиям выше в БД +### 8.API-Маршруты +* `PUT /api/v1/Auth/Diaries/:diary_guid` - Создание записи в дневнике + + +### 9.Контракт +#### Diaries-Request +``` +{ + `uuid`: "61351bb1-7563-479d-a8e9-201d0ff934c2", + `user_uuid`: "51351bb1-7563-479d-a8e9-201d0ff934c2", + `time`: "172493000", + `mania_level`: "6", + `depression_level`: "6", + `mood_level`: "7", + `activity_level`: "4", + `appetite_level`: "5", + `dream_level`: "5", + `anxiety_level`: "9", + `comment`: "Сильная тревога. Пришлось выпить аминазин", + `user_treatment_schemes_uuid`: "51351bb1-7563-479d-a8e9-201d0ff934c2", +} +``` +##### Требования к валидации: +* Все поля, кроме `comment` обязательны к заполнению +* `user_treatment_schemes_uuid` должен указывать на существующую схему лечения + +##### Response - 201 - Created +``` +{ + `uuid`: "61351bb1-7563-479d-a8e9-201d0ff934c2", + `user_uuid`: "71351bb1-7563-479d-a8e9-201d0ff934c2", + `time` "172493000", + `mania_level`: "6", + `depression_level`: "6", + `mood_level`: "7", + `activity_level`: "4", + `appetite_level`: "5", + `dream_level`: "5", + `anxiety_level`: "9", + `comment`: "Сильная тревога. Пришлось выпить аминазин", + `user_treatment_scheme`: { + "uuid": "248313cb-a75e-4331-8379-d3f2fc36b68d" + "treatment_name": "Bipolar I Scheme Urgent", + "instructions": "Схема для быстрого и жесткого купирования психозов. Аминазин пить каждый день.", + "medications": [ + { + "uuid": "eda5a5f7-167a-44b9-900d-c5c6acfc249b", + "name": "Aminazin", + "dose": 100, + "unit": "mg", + "is_urgent": true + } + ] + }, +} +``` +##### Errors +* `400 BAD_REQUEST` — отсутствуют обязательные поля +* `400 BAD_REQUEST` — сервер не смог десереализовать JSON +* `422 UNPROCECCABLE_ENTITY` - `time` не должно быть изменено * `422 TREATMENT_SCHEME_IS_NOT_EXISTS` - такой схемы лечения болезни не существует ### 10. Используемые сущности ДБ