Skip to content

docs: add missing REST API examples to README#68

Merged
palemoky merged 1 commit into
palemoky:mainfrom
hawk-roy:new_branch_supply
Jul 21, 2026
Merged

docs: add missing REST API examples to README#68
palemoky merged 1 commit into
palemoky:mainfrom
hawk-roy:new_branch_supply

Conversation

@hawk-roy

Copy link
Copy Markdown
Contributor

Summary

This PR supplements the README REST API section with the routes that are already registered in router.go but were not previously documented as examples.

Changes

  • Add health check example: /api/v1/health
  • Add stats example: /api/v1/stats
  • Add author detail example: /api/v1/authors/:id
  • Add dynasty detail example: /api/v1/dynasties/:id
  • Add poetry type list example: /api/v1/types
  • Add poetry type detail example: /api/v1/types/:id

Why

The README should reflect the currently available REST routes so users can discover and test the full API surface more easily.

Scope

  • Documentation only
  • No code or behavior changes

Verification

  • Cross-checked the README REST API examples against the routes registered in router.go

Co-authored-by: teng-lei-tfs <teng.lei@thermofisher.com>
@codecov-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@1c182df). Learn more about missing BASE report.
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #68   +/-   ##
=======================================
  Coverage        ?   14.98%           
=======================================
  Files           ?       38           
  Lines           ?     7369           
  Branches        ?        0           
=======================================
  Hits            ?     1104           
  Misses          ?     6176           
  Partials        ?       89           
Flag Coverage Δ
unittests 14.98% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@palemoky
palemoky self-requested a review July 21, 2026 00:42

@palemoky palemoky left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good job! Thanks for your contribution!

@palemoky palemoky self-assigned this Jul 21, 2026
@palemoky
palemoky merged commit 46a48e8 into palemoky:main Jul 21, 2026
1 check passed
@hawk-roy
hawk-roy deleted the new_branch_supply branch July 21, 2026 01:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants