docs: add missing REST API examples to README#68
Merged
Conversation
Co-authored-by: teng-lei-tfs <teng.lei@thermofisher.com>
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #68 +/- ##
=======================================
Coverage ? 14.98%
=======================================
Files ? 38
Lines ? 7369
Branches ? 0
=======================================
Hits ? 1104
Misses ? 6176
Partials ? 89
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
palemoky
self-requested a review
July 21, 2026 00:42
palemoky
approved these changes
Jul 21, 2026
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
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
This PR supplements the README REST API section with the routes that are already registered in
router.gobut were not previously documented as examples.Changes
/api/v1/health/api/v1/stats/api/v1/authors/:id/api/v1/dynasties/:id/api/v1/types/api/v1/types/:idWhy
The README should reflect the currently available REST routes so users can discover and test the full API surface more easily.
Scope
Verification
router.go