[docs] include only User and System parts of the API docs #142
Conversation
WalkthroughThe Swagger documentation generation command in the codebase was updated to include filtering by the "User" and "System" tags. No other changes were made to the code or public entity declarations. Changes
Sequence Diagram(s)sequenceDiagram
participant Developer
participant GoGenerate
participant SwaggerInit
Developer->>GoGenerate: Run go generate
GoGenerate->>SwaggerInit: Generate docs with --tags=User,System
SwaggerInit-->>GoGenerate: Output filtered Swagger documentation
GoGenerate-->>Developer: Generation complete
✨ Finishing Touches
🧪 Generate Unit Tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pkg/swagger/swagger.go(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Build / Docker image (linux/arm64)
- GitHub Check: Build / Docker image (linux/amd64)
- GitHub Check: Analyze (go)
| @@ -2,7 +2,7 @@ package swagger | |||
|
|
|||
| import "embed" | |||
|
|
|||
| //go:generate swag init --parseDependency --outputTypes json,yaml -d ../../ -g ./cmd/sms-gateway/main.go -o ../../pkg/swagger/docs | |||
| //go:generate swag init --parseDependency --tags=User,System --outputTypes json,yaml -d ../../ -g ./cmd/sms-gateway/main.go -o ../../pkg/swagger/docs | |||
There was a problem hiding this comment.
💡 Verification agent
❓ Verification inconclusive
Approve: Updated Swagger directive; regenerate docs
Including --tags=User,System correctly narrows the generated API docs to only the “User” and “System” endpoints as per the PR objective. To apply this change, please run go generate ./pkg/swagger (or your CI script) to regenerate the JSON/YAML under pkg/swagger/docs, then commit those updated files so your docs hosting/CI reflects the filter.
🏁 Script executed:
#!/bin/bash
# Regenerate Swagger docs to reflect the new tag filter
go generate ./pkg/swaggerLength of output: 118
Error regenerating Swagger docs: missing swag CLI
The go:generate directive in pkg/swagger/swagger.go:5 failed with “exec: ‘swag’: executable file not found in $PATH”. To fix and commit your filtered docs:
• Install the Swag CLI:
go install github.com/swaggo/swag/cmd/swag@latest• Ensure your $GOBIN (or $GOPATH/bin) is in your PATH.
• Re-run and commit the outputs:
go generate ./pkg/swagger
git add pkg/swagger/docs
git commit -m "chore: regenerate Swagger docs with User,System tags"🤖 Prompt for AI Agents
In pkg/swagger/swagger.go at line 5, the go:generate directive was updated to
filter Swagger docs by User and System tags, but the Swagger docs were not
regenerated due to the missing swag CLI tool. To fix this, install the swag CLI
by running 'go install github.com/swaggo/swag/cmd/swag@latest', ensure your Go
bin directory is in your PATH, then run 'go generate ./pkg/swagger' to
regenerate the docs, and finally commit the updated files under
pkg/swagger/docs.
Summary by CodeRabbit