17581942656
62%

Ran 09 Sep 2025 01:34PM UTC

Jobs 1

Files 706

Run time 4min

Badge

Embed ▾

Committed 09 Sep 2025 12:03PM UTC coverage: 60.905% (-0.01%) from 60.917%

Build # 17581942656

Build Type

push

github

Committed by

web-flow

Commit Message

docs: http api documentation (#7484)

Description
---

Documentation for the various API calls for HTTP.

Motivation and Context
---

Provide adequate documentation for the use of the HTTP API calls.

How Has This Been Tested?
---
All commands have been run on actual data, aside from
`sync_utxos_by_block`.

What process can a PR reviewer use to test or verify this change?
---

Breaking Changes
---

- [x] None
- [ ] Requires data directory on base node to be deleted
- [ ] Requires hard fork
- [ ] Other - Please specify


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- Documentation
  - Added a comprehensive HTTP API guide for the Minotari Base Node.
- Describes base URL and default port, plus eight endpoints with
methods, paths, parameters, and response schemas.
- Includes detailed JSON and curl examples, testing instructions, and
notes on hex-encoded byte fields and nested structures.
- Documents pagination for syncing UTXOs by block and states that no
authentication is required.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Run Details

73900 of 121337 relevant lines covered (60.9%)

295677.85 hits per line

Uncovered Existing Lines

Lines	Coverage	∆	File
1	91.54	-0.77%	base_layer/transaction_components/src/consensus/consensus_encoding/hashing.rs
1	90.05	-0.25%	comms/core/src/multiplexing/yamux.rs
3	60.48	0.0%	comms/dht/src/connectivity/mod.rs
4	80.73	-0.76%	comms/core/src/noise/socket.rs
6	55.82	-0.64%	comms/core/src/connectivity/manager.rs
100	44.35	36.94%	base_layer/core/src/base_node/metrics.rs
200	0.0	0.0%	base_layer/core/src/base_node/comms_interface/inbound_handlers.rs

Jobs

ID	Job ID	Ran	Files	Coverage
1	17581942656.1	09 Sep 2025 01:34PM UTC	706	60.9	GitHub Action Run

tari-project / tari / 17581942656
62%

README BADGES
x

Markdown

Textile

RDoc

HTML

Rst

Uncovered Existing Lines

Jobs

Source Files on build 17581942656

tari-project / tari / 17581942656 62%

README BADGES x

Markdown

Textile

RDoc

HTML

Rst

Uncovered Existing Lines

Jobs

Source Files on build 17581942656

tari-project / tari / 17581942656
62%

README BADGES
x