Skip to content

Update integration-apis.rst#576

Open
nataly-gb wants to merge 1 commit into
dashpay:23.0.0from
nataly-gb:patch-1
Open

Update integration-apis.rst#576
nataly-gb wants to merge 1 commit into
dashpay:23.0.0from
nataly-gb:patch-1

Conversation

@nataly-gb
Copy link
Copy Markdown

@nataly-gb nataly-gb commented Jun 3, 2026

Add GetBlock to API Services

Preview build: https://dash-docs--576.org.readthedocs.build/en/576/

Summary by CodeRabbit

  • Documentation
    • Added GetBlock API provider documentation section to integration APIs guide, including details on supported protocols (JSON-RPC, REST, Blockbook via REST/WebSocket), pricing model (free tier up to 50K CUs with shared/dedicated node options), and references to provider resources.

Add GetBlock to API Services
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 3, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

This PR adds a new GetBlock API provider section to the developer integration APIs documentation. The change includes the provider's website link, feature description covering JSON-RPC, REST, and Blockbook support, pricing information for free and paid tiers, and a reference to external documentation.

Changes

GetBlock API Provider Documentation

Layer / File(s) Summary
GetBlock API provider section
docs/user/developers/integration-apis.rst
Adds a new subsection documenting GetBlock's features (JSON-RPC/REST and Blockbook protocols), pricing model (free up to 50K compute units, then shared/dedicated node options), and links to documentation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Update integration-apis.rst' is vague and generic, using non-descriptive terms that don't convey meaningful information about the specific change made. Use a more specific title that describes the actual change, such as 'Add GetBlock API provider to integration documentation' to clearly communicate the main purpose of the update.
✅ Passed checks (4 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.
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.

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


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 and usage tips.

Warning

⚠️ This pull request might be slop. It has been flagged by CodeRabbit slop detection and should be reviewed carefully.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (2)
docs/user/developers/integration-apis.rst (2)

115-128: ⚡ Quick win

Add an image for visual consistency.

The GetBlock section lacks a provider logo/image, while all other API provider sections in this document include one (Insight, BlockCypher, BitGo, Blockmove, NOWNodes, Tokenview, CoinPayments). Adding an image would maintain visual consistency and improve the user experience.

📸 Suggested image directive to add

Add the following between line 116 and line 117:

.. image:: img/getblock.png
   :width: 200px
   :align: right
   :target: https://getblock.io/

Note: You'll need to obtain and add the GetBlock logo image file to docs/user/developers/img/getblock.png.

🤖 Prompt for 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.

In `@docs/user/developers/integration-apis.rst` around lines 115 - 128, Add the
GetBlock provider image directive to the GetBlock section so it matches other
provider entries: insert an RST image directive referencing the provider logo
(e.g., the same pattern used in sections for Insight/BlockCypher) pointing to
img/getblock.png with :width: 200px, :align: right and :target:
https://getblock.io/ and ensure the image file is added to
docs/user/developers/img/getblock.png; update the GetBlock block in
integration-apis.rst (the "GetBlock" section) to include this directive above
the description.

125-126: 💤 Low value

Improve hyphenation in pricing model description.

The phrase "paid shared- and dedicated-node pricing" uses awkward suspended hyphenation that may confuse readers.

✍️ Suggested rewording
-- Pricing Model: Free up to 50K CUs, paid shared- and dedicated-node
-pricing
+- Pricing Model: Free up to 50K CUs, paid shared-node and dedicated-node
+pricing

Alternatively, you could simplify to "paid shared and dedicated node pricing" if the hyphenation doesn't add clarity.

🤖 Prompt for 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.

In `@docs/user/developers/integration-apis.rst` around lines 125 - 126, Update the
phrasing "paid shared- and dedicated-node pricing" in the docs to remove the
awkward suspended hyphenation; locate the exact string and replace it with
either "paid shared- and dedicated-node pricing" corrected to "paid shared and
dedicated-node pricing" if you want to keep the compound "dedicated-node", or
simpler "paid shared and dedicated node pricing" for clarity and consistency
with surrounding copy; ensure the replacement occurs where the phrase appears in
the integration-apis.rst content.
🤖 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.

Nitpick comments:
In `@docs/user/developers/integration-apis.rst`:
- Around line 115-128: Add the GetBlock provider image directive to the GetBlock
section so it matches other provider entries: insert an RST image directive
referencing the provider logo (e.g., the same pattern used in sections for
Insight/BlockCypher) pointing to img/getblock.png with :width: 200px, :align:
right and :target: https://getblock.io/ and ensure the image file is added to
docs/user/developers/img/getblock.png; update the GetBlock block in
integration-apis.rst (the "GetBlock" section) to include this directive above
the description.
- Around line 125-126: Update the phrasing "paid shared- and dedicated-node
pricing" in the docs to remove the awkward suspended hyphenation; locate the
exact string and replace it with either "paid shared- and dedicated-node
pricing" corrected to "paid shared and dedicated-node pricing" if you want to
keep the compound "dedicated-node", or simpler "paid shared and dedicated node
pricing" for clarity and consistency with surrounding copy; ensure the
replacement occurs where the phrase appears in the integration-apis.rst content.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 05633707-5cce-4495-91bf-b7993c7ad037

📥 Commits

Reviewing files that changed from the base of the PR and between f86f347 and f6a3961.

📒 Files selected for processing (1)
  • docs/user/developers/integration-apis.rst

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.

1 participant