docs: add page for postman at api collection - #102
Conversation
WalkthroughExpanded the API reference README with introductory guidance for the KiiChain Pay Backend Postman collection. It documents collection and environment setup, Estimated code review effort: 1 (Trivial) | ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Pull request overview
Adds introductory documentation to the KiiChain Pay API Reference landing page so readers can use the official Postman collection alongside the generated endpoint reference.
Changes:
- Adds GitBook frontmatter and an expanded introduction to the API Reference section.
- Documents how to open and use the Postman collection (including environment variables and basic workflow).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@kiichain-pay/api-reference/README.md`:
- Around line 46-48: Update the Postman warning in the surrounding hint to
clarify that environment values are not universally visible: instruct users to
store api_key and priv_key in local/current values or Postman Vault, and warn
that initial/shared values can sync with workspace collaborators. Remove the
implication that all environment values are exposed.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 7014de43-73fe-43e2-b043-8c798819447a
📒 Files selected for processing (1)
kiichain-pay/api-reference/README.md
Description
Add a page about the postman collection for Kiichain
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
No tests needed