Skip to content

docs(minibf): document endpoints missing from coverage table - #1336

Merged
vladimirvolek merged 1 commit into
mainfrom
fix/minibf-docs-table
Sep 14, 2026
Merged

vladimirvolek merged 1 commit into
mainfrom
fix/minibf-docs-table

Conversation

@michalrus

@michalrus michalrus commented Sep 14, 2026 •

Copy link
Copy Markdown
Contributor

Resolves #1337.

Add the missing minibf routes that were hooked in the router but never listed in the Coverage table:

Summary by CodeRabbit

  • Documentation
    • Added coverage entries for governance proposal metadata endpoints.
    • Documented the utility endpoint for deriving an address from an extended public key (xpub), role, and index.
    • Updated the API endpoint coverage table to reflect these documented routes.

Add the three MiniBF routes that were hooked in the router but never
listed in the Coverage table:

- /utils/addresses/xpub/{xpub}/{role}/{index} (added in #1278)
- /governance/proposals/{tx_hash}/{cert_index}/metadata (added in #1295)
- /governance/proposals/{gov_action_id}/metadata (added in #1295)
@michalrus michalrus self-assigned this Sep 14, 2026
@michalrus michalrus added the documentation Improvements or additions to documentation label Sep 14, 2026
@michalrus
michalrus requested a review from a team as a code owner September 14, 2026 14:11
@michalrus michalrus added the area:minibf Mini Blockfrost (minibf) API label Sep 14, 2026
@coderabbitai

coderabbitai Bot commented Sep 14, 2026 •

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: df551ddd-f652-4de7-94e8-717707078e56

📥 Commits

Reviewing files that changed from the base of the PR and between 2cadf62 and d0f3c98.

📒 Files selected for processing (1)
  • docs/content/apis/minibf.mdx

Included review availability: Your plan provides up to 2 included reviews per hour; 1 remains after this review.


📝 Walkthrough

Walkthrough

The Minibf API documentation adds coverage rows for two governance proposal metadata endpoints and one xpub address derivation endpoint.

Changes

Minibf API coverage

Layer / File(s) Summary
Coverage table entries
docs/content/apis/minibf.mdx
Adds rows for two governance proposal metadata endpoints and the /utils/addresses/xpub/{xpub}/{role}/{index} address derivation endpoint.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to d0f3c

This change only adds coverage entries for existing endpoints and is ready to merge.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: documenting missing MiniBF endpoints in the coverage table.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/minibf-docs-table

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
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

No unresolved review issues remain.

Pull request overview

Documents three previously omitted minibf API routes in the coverage table.

Changes:

  • Added two governance proposal metadata endpoints.
  • Added the xpub address derivation endpoint.
File summaries
File Description
docs/content/apis/minibf.mdx Documents the three missing minibf routes.
Review details
  • Files reviewed: 1/1 changed files
  • Comments generated: 0
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@vladimirvolek
vladimirvolek added this pull request to the merge queue Sep 14, 2026
Merged via the queue into main with commit 093c77c Sep 14, 2026
23 of 30 checks passed
@michalrus
michalrus deleted the fix/minibf-docs-table branch September 14, 2026 14:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:minibf Mini Blockfrost (minibf) API documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(minibf): document endpoints missing from coverage table

3 participants