doc(swagger): add Swagger doc for all endpoints and reorganize routing #22
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Will review by this weekend. |
avinal
suggested changes
Dec 10, 2023
cmd/laas/main.go
Outdated
| "github.com/fossology/LicenseDb/pkg/api" | ||
| "github.com/fossology/LicenseDb/pkg/db" | ||
| "github.com/fossology/LicenseDb/pkg/models" | ||
| "log" |
There was a problem hiding this comment.
The log should be above only. The order is std libraries and then third-party libs. You may use goimports -l -e -w pkg cmd test to format and arrange the imports.
There was a problem hiding this comment.
Afterthought: we may use a tool like golangci-lint in our CI to automatically run these checks. I can add a PR if we agree.
There was a problem hiding this comment.
The formatting is currently done by my IDE. I think it will be a good idea if you create the CI workflow, I can update my IDE accordingly.
There was a problem hiding this comment.
Hope new formatting looks good.
There was a problem hiding this comment.
Yes, it is on point, I will add the static checks.
GMishx
force-pushed
the
docs/api/swagger
branch
2 times, most recently
from
c8ad292 to
9f7bd70
Compare
avinal
approved these changes
Dec 11, 2023
GMishx
force-pushed
the
docs/api/swagger
branch
from
9f7bd70 to
2d3e5e2
Compare
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]>
1. Check if the latest swagger docs are commited with the PR. 2. Check if the swagger docs are formatted. Signed-off-by: Gaurav Mishra <[email protected]>
GMishx
force-pushed
the
docs/api/swagger
branch
from
2d3e5e2 to
ddccd78
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Note: Merge after #21