Current API implementation has many problems that I think can be fixed.
Please see the issues below for details.
As the title says, this milestone will focus on backend since I study Database Engineering.
I wish to change frontend as little as possible and the endpoints will stay the same.
Nomenclature
- API is the project as a whole (reuse/api)
- api are the API's endpoints
Purpose of this API
To understand what can be improved first one needs to know what is the purpose of this project on a deeper level than to check REUSE compliance of a git project.
It is to store information about a repository available under a certain URL regarding it's REUSE compliance.
That information should be served on the info webpage
https://api.reuse.software/info/git.fsfe.org/reuse/api
and the webserver should send a REUSE badge under the url
https://api.reuse.software/badge/git.fsfe.org/reuse/api
The info webpage should contain:
- stdout
- stderr?
- latest scanned commit
- date?
and the badge should indicate that a project is:
- unregistered
- initialising
- compliant
- non-compliant