Skip to content

Commit 5c55783

Browse files
dannywillemsdannywillems
committed
CHANGELOG: add entry for patch 1745
1 parent cb28e95 commit 5c55783

10 files changed

+83
-92
lines changed

‎.github/scripts/test-block-producer-node-capabilities.sh‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ for node_url in $bp_nodes; do
2222

2323
# Test network ID query using website script
2424
network_success=false
25-
if network_response=$(bash website/docs/developers/scripts/graphql-api/queries/curl/network-id.sh "$graphql_url" 2>&1); then
25+
if network_response=$(bash website/docs/developers/api-and-data/scripts/graphql-api/queries/curl/network-id.sh "$graphql_url" 2>&1); then
2626
if echo "$network_response" | jq -e '.data.networkID' > /dev/null 2>&1; then
2727
network_id=$(echo "$network_response" | jq -r '.data.networkID')
2828
echo "✅ Network ID query successful: $network_id"
@@ -36,7 +36,7 @@ for node_url in $bp_nodes; do
3636

3737
# Test best chain query using website script
3838
chain_success=false
39-
if chain_response=$(bash website/docs/developers/scripts/graphql-api/queries/curl/best-chain.sh "$graphql_url" 2>&1); then
39+
if chain_response=$(bash website/docs/developers/api-and-data/scripts/graphql-api/queries/curl/best-chain.sh "$graphql_url" 2>&1); then
4040
if echo "$chain_response" | jq -e '.data.bestChain[0].stateHash' > /dev/null 2>&1; then
4141
state_hash=$(echo "$chain_response" | jq -r '.data.bestChain[0].stateHash')
4242
echo "✅ Best chain query successful: ${state_hash:0:16}..."

‎.github/scripts/test-block-producer-node-connectivity.sh‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ for node_url in $bp_nodes; do
3737
graphql_url="${node_url}graphql"
3838

3939
# Test daemon status query using the website script
40-
if response=$(bash website/docs/developers/scripts/graphql-api/queries/curl/daemon-status.sh "$graphql_url" 2>&1); then
40+
if response=$(bash website/docs/developers/api-and-data/scripts/graphql-api/queries/curl/daemon-status.sh "$graphql_url" 2>&1); then
4141
# Check if it's valid JSON
4242
if echo "$response" | jq . > /dev/null 2>&1; then
4343
# Check for GraphQL errors

‎.github/scripts/test-cli-graphql-commands.sh‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ MINA_DIR="$(dirname "${MINA_BIN}")"
1414
export PATH="${MINA_DIR}:${PATH}"
1515

1616
SCRIPT_DIR="website/docs/developers/scripts/cli"
17-
QUERY_FILE="website/docs/developers/scripts/graphql-api/queries/query/sync-status.graphql"
17+
QUERY_FILE="website/docs/developers/api-and-data/scripts/graphql-api/queries/query/sync-status.graphql"
1818
GRAPHQL_NODE="${GRAPHQL_NODE:-https://mina-rust-plain-3.gcp.o1test.net/graphql}"
1919

2020
echo "Testing that 'mina internal graphql' commands are available..."

‎.github/scripts/test-graphql-api-local.sh‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ echo ""
3232
# Test 1: Script and query file consistency
3333
echo "🔍 Testing consistency between bash scripts and GraphQL query files..."
3434

35-
script_dir="website/docs/developers/scripts/graphql-api/queries/curl"
36-
query_dir="website/docs/developers/scripts/graphql-api/queries/query"
35+
script_dir="website/docs/developers/api-and-data/scripts/graphql-api/queries/curl"
36+
query_dir="website/docs/developers/api-and-data/scripts/graphql-api/queries/query"
3737

3838
inconsistent=0
3939

@@ -88,7 +88,7 @@ echo ""
8888
echo "🔍 Testing GraphQL API command scripts..."
8989

9090
# Dynamically discover all bash scripts in the queries/curl directory (only test queries, not mutations)
91-
script_dir="website/docs/developers/scripts/graphql-api/queries/curl"
91+
script_dir="website/docs/developers/api-and-data/scripts/graphql-api/queries/curl"
9292

9393
if [ ! -d "$script_dir" ]; then
9494
echo "❌ Script directory not found: $script_dir"

‎.github/scripts/test-plain-node-capabilities.sh‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ for node_url in $plain_nodes; do
2222

2323
# Test network ID query using website script
2424
network_success=false
25-
if network_response=$(bash website/docs/developers/scripts/graphql-api/queries/curl/network-id.sh "$graphql_url" 2>&1); then
25+
if network_response=$(bash website/docs/developers/api-and-data/scripts/graphql-api/queries/curl/network-id.sh "$graphql_url" 2>&1); then
2626
if echo "$network_response" | jq -e '.data.networkID' > /dev/null 2>&1; then
2727
network_id=$(echo "$network_response" | jq -r '.data.networkID')
2828
echo "✅ Network ID query successful: $network_id"
@@ -36,7 +36,7 @@ for node_url in $plain_nodes; do
3636

3737
# Test best chain query using website script
3838
chain_success=false
39-
if chain_response=$(bash website/docs/developers/scripts/graphql-api/queries/curl/best-chain.sh "$graphql_url" 2>&1); then
39+
if chain_response=$(bash website/docs/developers/api-and-data/scripts/graphql-api/queries/curl/best-chain.sh "$graphql_url" 2>&1); then
4040
if echo "$chain_response" | jq -e '.data.bestChain[0].stateHash' > /dev/null 2>&1; then
4141
state_hash=$(echo "$chain_response" | jq -r '.data.bestChain[0].stateHash')
4242
echo "✅ Best chain query successful: ${state_hash:0:16}..."

‎.github/scripts/test-plain-node-connectivity.sh‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ for node_url in $plain_nodes; do
3737
graphql_url="${node_url}graphql"
3838

3939
# Test daemon status query using the website script
40-
if response=$(bash website/docs/developers/scripts/graphql-api/queries/curl/daemon-status.sh "$graphql_url" 2>&1); then
40+
if response=$(bash website/docs/developers/api-and-data/scripts/graphql-api/queries/curl/daemon-status.sh "$graphql_url" 2>&1); then
4141
# Check if it's valid JSON
4242
if echo "$response" | jq . > /dev/null 2>&1; then
4343
# Check for GraphQL errors

‎.github/scripts/test-script-query-consistency.sh‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010

1111
echo "🔍 Testing consistency between bash scripts and GraphQL query files..."
1212

13-
script_dir="website/docs/developers/scripts/graphql-api/queries/curl"
14-
query_dir="website/docs/developers/scripts/graphql-api/queries/query"
13+
script_dir="website/docs/developers/api-and-data/scripts/graphql-api/queries/curl"
14+
query_dir="website/docs/developers/api-and-data/scripts/graphql-api/queries/query"
1515

1616
inconsistent=0
1717

‎.github/workflows/test-rpc-remote.yml‎

Lines changed: 32 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -31,60 +31,68 @@ jobs:
3131
chmod +x "$CURL_SCRIPTS"/*.sh
3232
3333
- name: Test healthz endpoint
34-
run: "$SCRIPT_DIR/test-healthz.sh" "$RPC_ENDPOINT"
34+
run: |
35+
"$SCRIPT_DIR/test-healthz.sh" "$RPC_ENDPOINT"
3536
3637
- name: Test readyz endpoint
37-
run: "$SCRIPT_DIR/test-readyz.sh" "$RPC_ENDPOINT"
38+
run: |
39+
"$SCRIPT_DIR/test-readyz.sh" "$RPC_ENDPOINT"
3840
3941
- name: Test status endpoint
40-
run: "$SCRIPT_DIR/test-status.sh" "$RPC_ENDPOINT" "$CURL_SCRIPTS"
42+
run: |
43+
"$SCRIPT_DIR/test-status.sh" "$RPC_ENDPOINT" "$CURL_SCRIPTS"
4144
4245
- name: Test build_env endpoint
43-
run: "$SCRIPT_DIR/test-build-env.sh" "$RPC_ENDPOINT" "$CURL_SCRIPTS"
46+
run: |
47+
"$SCRIPT_DIR/test-build-env.sh" "$RPC_ENDPOINT" "$CURL_SCRIPTS"
4448
4549
- name: Test peers endpoint
46-
run: "$SCRIPT_DIR/test-peers.sh" "$RPC_ENDPOINT" "$CURL_SCRIPTS"
50+
run: |
51+
"$SCRIPT_DIR/test-peers.sh" "$RPC_ENDPOINT" "$CURL_SCRIPTS"
4752
4853
- name: Test stats/sync endpoint
49-
run: "$SCRIPT_DIR/test-stats-sync.sh" "$RPC_ENDPOINT" "$CURL_SCRIPTS"
54+
run: |
55+
"$SCRIPT_DIR/test-stats-sync.sh" "$RPC_ENDPOINT" "$CURL_SCRIPTS"
5056
5157
- name: Test snark-pool/jobs endpoint
52-
run: "$SCRIPT_DIR/test-snark-pool-jobs.sh" "$RPC_ENDPOINT" "$CURL_SCRIPTS"
58+
run: |
59+
"$SCRIPT_DIR/test-snark-pool-jobs.sh" "$RPC_ENDPOINT" "$CURL_SCRIPTS"
5360
5461
- name: Test snarker/workers endpoint
55-
run: "$SCRIPT_DIR/test-snarker-workers.sh" "$RPC_ENDPOINT" "$CURL_SCRIPTS"
62+
run: |
63+
"$SCRIPT_DIR/test-snarker-workers.sh" "$RPC_ENDPOINT" "$CURL_SCRIPTS"
5664
5765
- name: Test snarker/config endpoint
58-
run: "$SCRIPT_DIR/test-snarker-config.sh" "$RPC_ENDPOINT" "$CURL_SCRIPTS"
66+
run: |
67+
"$SCRIPT_DIR/test-snarker-config.sh" "$RPC_ENDPOINT" "$CURL_SCRIPTS"
5968
6069
- name: Test transaction-pool endpoint
61-
run: "$SCRIPT_DIR/test-transaction-pool.sh" "$RPC_ENDPOINT" "$CURL_SCRIPTS"
70+
run: |
71+
"$SCRIPT_DIR/test-transaction-pool.sh" "$RPC_ENDPOINT" "$CURL_SCRIPTS"
6272
6373
- name: Test discovery/routing_table endpoint
64-
run: >-
65-
"$SCRIPT_DIR/test-discovery-routing-table.sh"
66-
"$RPC_ENDPOINT" "$CURL_SCRIPTS"
74+
run: |
75+
"$SCRIPT_DIR/test-discovery-routing-table.sh" "$RPC_ENDPOINT" "$CURL_SCRIPTS"
6776
6877
- name: Test discovery/bootstrap_stats endpoint
69-
run: >-
70-
"$SCRIPT_DIR/test-discovery-bootstrap-stats.sh"
71-
"$RPC_ENDPOINT" "$CURL_SCRIPTS"
78+
run: |
79+
"$SCRIPT_DIR/test-discovery-bootstrap-stats.sh" "$RPC_ENDPOINT" "$CURL_SCRIPTS"
7280
7381
- name: Test scan-state/summary endpoint
74-
run: >-
75-
"$SCRIPT_DIR/test-scan-state-summary.sh"
76-
"$RPC_ENDPOINT" "$CURL_SCRIPTS"
82+
run: |
83+
"$SCRIPT_DIR/test-scan-state-summary.sh" "$RPC_ENDPOINT" "$CURL_SCRIPTS"
7784
7885
- name: Test state endpoint
79-
run: "$SCRIPT_DIR/test-state.sh" "$RPC_ENDPOINT" "$CURL_SCRIPTS"
86+
run: |
87+
"$SCRIPT_DIR/test-state.sh" "$RPC_ENDPOINT" "$CURL_SCRIPTS"
8088
8189
- name: Test message-progress endpoint
82-
run: >-
83-
"$SCRIPT_DIR/test-message-progress.sh"
84-
"$RPC_ENDPOINT" "$CURL_SCRIPTS"
90+
run: |
91+
"$SCRIPT_DIR/test-message-progress.sh" "$RPC_ENDPOINT" "$CURL_SCRIPTS"
8592
8693
- name: Test accounts endpoint
87-
run: "$SCRIPT_DIR/test-accounts.sh" "$RPC_ENDPOINT" "$CURL_SCRIPTS"
94+
run: |
95+
"$SCRIPT_DIR/test-accounts.sh" "$RPC_ENDPOINT" "$CURL_SCRIPTS"
8896
8997
- name: Summary
9098
run: |

‎CHANGELOG.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
99

1010
### Added
1111

12+
- **Documentation**: add RPC API reference documentation with CI validation
13+
against o1Labs node, reorganize API docs into dedicated section
14+
([#1745](https://github.com/o1-labs/mina-rust/pull/1745))
1215
- **Node**: add top-level documentation for the crate `node`
1316
([#1736](https://github.com/o1-labs/mina-rust/pull/1736))
1417

0 commit comments

Comments
 (0)