starkey/notesvault
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

README updates

Browse Source
This commit is contained in:
Sean Starkey
2026-05-31 17:11:08 -06:00
parent d432f1d1a3
commit 92a2013b05
1 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -6,6 +6,7 @@
- Spring Boot as a framework - Spring Boot as a framework
- H2 for persistance - plan for Postgress - H2 for persistance - plan for Postgress
- JPA/Hibernate for SQL - JPA/Hibernate for SQL
- Flyway for DB schema control
- JWT for auth - JWT for auth
## HTTP return codes ## 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. | | `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`. | | `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 | | Table | Column | Type | Required | Key / Constraint | Description |
|---|---|---:|:---:|---|---| |---|---|---:|:---:|---|---|