diff --git a/README.md b/README.md index 10f8763..e736235 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ - Spring Boot as a framework - H2 for persistance - plan for Postgress - JPA/Hibernate for SQL +- Flyway for DB schema control - JWT for auth ## HTTP return codes @@ -24,9 +25,11 @@ Application-defined HTTP status codes are generated in `AuthController` for succ | `409` | Conflict | `GlobalExceptionHandler.handleConflict`; `AuthController.register` throws `ConflictException` | Duplicate username or other persistence/domain uniqueness conflict. | `ErrorResponse` with the exception message. | | `422` | Unprocessable Entity | `GlobalExceptionHandler.handleValidation` | Bean Validation fails for a request body annotated with `@Valid`. | `ValidationErrorResponse` with `error` and per-field `fields`. | -## DB schema +## Database -The schema is the basic requirements for a User, Note and NoteShare. Nothing additional was added in order to save time. +- The schema is the basic requirements for a User, Note and NoteShare. +- H2 database is used for development. +- Flyway will allow us to migrate to Postgres for "production". | Table | Column | Type | Required | Key / Constraint | Description | |---|---|---:|:---:|---|---|