MeiH10 / SDD

GNU General Public License v3.0
0 stars 0 forks source link

Put & Download Note API. #41

Closed mvhutz closed 1 month ago

mvhutz commented 1 month ago

Specifications

PUT /note/{id}

If the note exists, and the user has access to it (currently always true), edit all title and data attributes that are present in the form body.

GET /note/{id}?download=true

A special case of the GET /note/{id} endpoint, it will return the binary file data, and force the user to download it automatically.

GET /note

A helper API to list all available notes in the database.

Further Notes

  1. Added documentation on how the start the Spring Boot server without knowledge. (This would have been useful to me, as will be useful to other team members.)
  2. Changes the server folder from PuckNotes to server, becuase this is a mono-repository, and we cannot have every folder named PuckNotes.
  3. Added an application.example.properties file, and added application.properties to the .gitignore, so that developers don't mistakenly commit their credentials in the true properties file when pushing to their branch.
  4. Removed all verbs from the current REST API endpoints. (Remember, API endpoints should never have verbs.)