fix(docs): add swag annotations to missing endpoints and add a note to claude#502
Merged
philwinder merged 2 commits intomainfrom Mar 26, 2026
Merged
fix(docs): add swag annotations to missing endpoints and add a note to claude#502philwinder merged 2 commits intomainfrom
philwinder merged 2 commits intomainfrom
Conversation
…; update CLAUDE.md with API handler rule Spec-Ref: helix-specs@97bd301:001647_update-claudemd-to
Spec-Ref: helix-specs@a1e3245:001647_update-claudemd-to
philwinder
changed the title
Contributor
Go Test CoverageTotal coverage: 32.1% Full coverage report |
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
Three endpoints registered in
infrastructure/api/v1/repositories.gowere missing swag annotations, making them invisible in the generated OpenAPI spec. This PR adds full annotations and updates CLAUDE.md to prevent future omissions.Changes
GetChunkingConfig(GET /repositories/{id}/config/chunking)UpdateChunkingConfig(PUT /repositories/{id}/config/chunking)Grep(GET /repositories/{id}/grep, marked@Deprecatedwith note to use/api/v1/search/grep)CLAUDE.mdrequiring complete swag blocks on all chi-registered handlersdocs/swagger/(swagger.json, swagger.yaml, docs.go)Testing
Ran
swag initdirectly — generation succeeds with all three new endpoints appearing in the spec.🔗 Open in Helix
📋 Spec:
🚀 Built with Helix