Ci cd

[DanielPopoola]

What this PR is about:

Made a mistake by committing to master directly, created a new branch to move and refactor Swagger docs from docs/ to docs/api

Summary by CodeRabbit

Release Notes

• Refactor
  • Reorganized API documentation generation structure and internal package organization to improve modularity and code maintainability.

[chatgpt-codex-connector]

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

[coderabbitai]

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

The pull request reorganizes generated Swagger API documentation into a subdirectory structure by moving the output path from docs/ to docs/api/, updating the corresponding import statement, and adjusting the package declaration to match the new location.

Changes

Cohort / File(s)	Summary
Build Configuration Dockerfile	Modified the swag documentation generation command to output to docs/api/ instead of docs/.
API Initialization & Package Structure cmd/api/main.go, docs/api/docs.go	Updated the import path from docs to docs/api and changed the package declaration in the generated docs file from package docs to package api to align with the new directory structure.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Docs hop to their cozy nest,
In docs/api/ they rest so blessed,
Imports rewired, paths align,
Organization, oh so fine,
Tidy warrens make code shine! 🌿

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'Ci cd' is vague and generic, failing to describe the actual changes which involve reorganizing Swagger documentation structure from docs/ to docs/api/.	Use a more descriptive title that reflects the main change, such as 'Reorganize Swagger docs to docs/api directory' or 'Move API documentation to docs/api subdirectory'.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch ci-cd

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}