docs: README tree, Swagger info, health vs API key (#139)#192
Merged
Conversation
- main.go: replace boilerplate Swagger title/description; regenerate docs/. - README: folder tree matches repo (CI, tests, middleware, .dockerignore, etc.). - README: list GET /api/v1/ health and /swagger as unauthenticated; clarify API key applies to all other /api/v1 routes. Closes #139 Co-authored-by: Cursor <cursoragent@cursor.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
main.gogeneral annotations (title + description) and runswag initsodocs/*matches..github/,tests/,.dockerignore,.golangci.yml, expandedpkg/files).GET /api/v1/health and/swagger/*as public; clarifyX-API-Keyis required for all other/api/v1routes (aligned withpkg/api/router.go).Closes #139
Made with Cursor