Client Request: Step 03

[patricksan]

What?

Please, reference to file: /documentation/phases/Phase-01-school-management/01-New Client Request.pdf

This ticket is to create the Model + API from Step 03. This is related to Download and Upload Documents

How?

• Create mode Log
• Create API for Documents
  • GET /document
  • DELETE /document/1234
  • POST /document
    • creates a new document
    • limit file size to 5 Mb
    • this should be a configuration parameter
  • PUT /document/1234
    • update a document if necessary
    • limit file size to 5 Mb
    • this should be a configuration parameter

Expected

• Take in consideration the activity & log details
• This API should work a part, so we can test using Postman

[captain0612]

@patricksan where are these files stored? is it stored on s3 or is the file converted to base64 encrypted string and stored in db ? And also its an one to many relation , correct me if im wrong (1 org can have multiple docs)

[patricksan]

Excellent question. We should create an interface DocumentService and how we save the file should be transparent. Initially we will use a FileSystemDocumentImpl that will save the file locally in a folder configured in the application.properties.

With the time we can create a second implementation, eg: S3DocumentImpl.

Like this way we are safe.

Related to the one to many, that is true. So the client can have multiples files, you can see the screen in the PDF.

But it is very important to noticed that the DocumentService can work completely with no link to client. As we will use this overall in the system, is the others tables that will link to the DocumentTable.

For testing, for example, you can have a postman api that do all the CRUD in the table.

A JUnit is great to implement this.

Let me know if you have more questions.

[patricksan]

Hey @captain0612, do you have any update on this ticket?

[patricksan]

• Model update in the documentation folder
• code merged to master