Technical Report Template - isel-leic-ls/2122-2-common GitHub Wiki
Phase 1
Introduction
This document contains the relevant design and implementation aspects of LS project's first phase.
Modeling the database
Conceptual model
The following diagram holds the Entity-Relationship model for the information managed by the system.
(include an image or a link to the conceptual diagram)
We highlight the following aspects:
- (include a list of relevant design issues)
The conceptual model has the following restrictions:
- (include a list of relevant design issues)
Physical Model
The physical model of the database is available in (link to the SQL script with the schema definition).
We highlight the following aspects of this model:
- (include a list of relevant design issues)
Software organization
Open-API Specification
(include a link to the YAML file containing the Open-API Specification)
In our Open-API specification, we highlight the following aspects:
(include a list of relevant issues or details in your specification)
Request Detalis
(describe how a request goes through the different elements of your solution)
(describe the relevant classes/functions used internally in a request)
(describe how and where request parameters are validated)
Connection Management
(describe how connections are created, used and disposed, namely its relation with transaction scopes).
Data Access
(describe any created classes to help on data access).
(identify any non-trivial used SQL statements).
Error Handling/Processing
(describe how errors are handled and their effects on the application behavior).
Critical Evaluation
(enumerate the functionality that is not concluded and the identified defects)
(identify improvements to be made on the next phase)