Skip to content

Add Swagger annotations for registry auth endpoints#4243

Merged
ChrisJBurns merged 1 commit intomainfrom
add-swagger-annotations-registry-auth
Mar 19, 2026
Merged

Add Swagger annotations for registry auth endpoints#4243
ChrisJBurns merged 1 commit intomainfrom
add-swagger-annotations-registry-auth

Conversation

@ChrisJBurns
Copy link
Copy Markdown
Collaborator

Summary

  • The registryAuthLogin and registryAuthLogout handlers were missing swag annotations, so they did not appear in the generated OpenAPI spec. This adds the standard @Summary, @Description, @Tags, @Router, etc. comment blocks and regenerates the swagger docs.

Type of change

  • Documentation

Test plan

  • Linting (task lint-fix)
  • Manual testing (describe below)

Verified task docs regenerates successfully and the new endpoints appear in docs/server/swagger.json and docs/server/swagger.yaml under /api/v1beta/registry/auth/login and /api/v1beta/registry/auth/logout.

Does this introduce a user-facing change?

No code behavior change. The login/logout endpoints now appear in the Swagger/OpenAPI documentation.

Generated with Claude Code

The registryAuthLogin and registryAuthLogout handlers were missing
swag annotations, so they did not appear in the generated OpenAPI
spec. Add the standard @summary, @description, @tags, @router, etc.
comment blocks and regenerate the swagger docs.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@github-actions github-actions bot added the size/S Small PR: 100-299 lines changed label Mar 19, 2026
Copy link
Copy Markdown
Contributor

@peppescg peppescg left a comment

Choose a reason for hiding this comment

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

🚀

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 19, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 69.12%. Comparing base (41c7474) to head (97103a5).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4243      +/-   ##
==========================================
+ Coverage   69.11%   69.12%   +0.01%     
==========================================
  Files         470      470              
  Lines       47387    47388       +1     
==========================================
+ Hits        32752    32758       +6     
- Misses      12091    12092       +1     
+ Partials     2544     2538       -6     

☔ View full report in Codecov by Sentry.
📢 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.

@ChrisJBurns ChrisJBurns merged commit 660babb into main Mar 19, 2026
42 checks passed
@ChrisJBurns ChrisJBurns deleted the add-swagger-annotations-registry-auth branch March 19, 2026 17:04
Sanskarzz pushed a commit to Sanskarzz/toolhive that referenced this pull request Mar 23, 2026
Add Swagger annotations for registry auth login/logout endpoints

The registryAuthLogin and registryAuthLogout handlers were missing
swag annotations, so they did not appear in the generated OpenAPI
spec. Add the standard @summary, @description, @tags, @router, etc.
comment blocks and regenerate the swagger docs.

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/S Small PR: 100-299 lines changed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants