doc(swagger): add Swagger doc for all endpoints and reorganize routing

1. Add swagger documentation to all the endpoints.
2. Fix the status code of endpoints.
3. Make minor changes in DB schema.

Signed-off-by: Gaurav Mishra <[email protected]>

.reuse/dep5

@@ -0,0 +1,9 @@
+Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Upstream-Name: LicenseDB
+Source: https://github.com/fossology/LicenseDB/
+Upstream-Contact: FOSSology <[email protected]>
+Disclaimer: <text> This file is offered as-is, without any warranty. </text>
+
+Files: cmd/laas/docs/*
+Copyright: Fossology contributors
+License: GPL-2.0-only

README.md

@@ -86,3 +86,19 @@ go build ./cmd/laas
 ```bash
 go run ./cmd/laas
 ```
+
+### Generating Swagger Documentation
+1. Install [swag](https://github.com/swaggo/swag) using the following command.
+    ```bash
+    go install github.com/swaggo/swag/cmd/swag@latest
+    ```
+2. Run the following command to generate swagger documentation.
+    ```bash
+    swag init --generalInfo api.go --dir ./pkg/api,./pkg/auth,./pkg/db,./pkg/models,./pkg/utils --output ./cmd/laas/docs
+    ```
+3. Swagger documentation will be generated in `./cmd/laas/docs` folder.
+4. Run the project and navigate to `http://localhost:8080/swagger/index.html` to view the documentation.
+5. Optionally, after changing any documentation comments, format them with following command.
+    ```bash
+    swag fmt --generalInfo ./pkg/api/api.go --dir ./pkg/api,./pkg/auth,./pkg/db,./pkg/models,./pkg/utils
+    ```