Skip to content

docs: add page for postman at api collection - #102

Merged
jhelison merged 1 commit into
mainfrom
docs/postman
Jul 17, 2026
Merged

docs: add page for postman at api collection#102
jhelison merged 1 commit into
mainfrom
docs/postman

Conversation

@jhelison

Copy link
Copy Markdown
Collaborator

Description

Add a page about the postman collection for Kiichain

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • Documentation (updates documentation on the project)
  • chore (Updates on dependencies, gitignore, etc)
  • test (For updates on tests)

How Has This Been Tested?

No tests needed

Copilot AI review requested due to automatic review settings July 17, 2026 20:44
@coderabbitai

coderabbitai Bot commented Jul 17, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

Expanded the API reference README with introductory guidance for the KiiChain Pay Backend Postman collection. It documents collection and environment setup, QueryServer and MsgServer request grouping, automatic signing for write requests, required environment variables, setup steps, related authentication and guide links, regeneration notes, and a warning to keep priv_key private.

Estimated code review effort: 1 (Trivial) | ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the documentation update for the Postman API collection.
Description check ✅ Passed The description matches the change by describing a Postman collection page for Kiichain.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/postman

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

Comment @coderabbitai help to get the list of available commands.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.

Comment thread kiichain-pay/api-reference/README.md
Comment thread kiichain-pay/api-reference/README.md
Comment thread kiichain-pay/api-reference/README.md

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between c6e2943 and 5753936.

📒 Files selected for processing (1)
  • kiichain-pay/api-reference/README.md

Comment thread kiichain-pay/api-reference/README.md
@jhelison
jhelison merged commit 452ff6e into main Jul 17, 2026
2 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants