Skip to content

Commit

Permalink
docs(grpc): fix linting issues for JSON-RPC and gRRC docs (#1609)
Browse files Browse the repository at this point in the history
Co-authored-by: b00f <[email protected]>
Co-authored-by: Javad Rajabzadeh <[email protected]>
  • Loading branch information
3 people authored Nov 25, 2024
1 parent 6cdf20c commit bba3df3
Show file tree
Hide file tree
Showing 19 changed files with 627 additions and 1,839 deletions.
3 changes: 2 additions & 1 deletion www/grpc/buf/grpc-md.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ title: GRPC API Reference
weight: 1
---

Each node in the Pactus network can be configured to use the [gRPC](https://grpc.io/) protocol for communication.
Each node in the Pactus network can be configured to use the
[gRPC](https://grpc.io/) protocol for communication.
Here you can find the list of all gRPC methods and messages.

All the amounts and values in gRPC endpoints are in NanoPAC units, which are atomic and the smallest unit in the Pactus blockchain.
Expand Down
3 changes: 2 additions & 1 deletion www/grpc/buf/json-rpc-md.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ title: JSON-RPC API Reference
weight: 2
---

Each node in the Pactus network can be configured to use the [JSON-RPC](https://www.jsonrpc.org/specification) protocol for communication.
Each node in the Pactus network can be configured to use the
[JSON-RPC](https://www.jsonrpc.org/specification) protocol for communication.
Here, you can find the list of all JSON-RPC methods and messages.

All the amounts and values in JSON-RPC endpoints are in NanoPAC units,
Expand Down
3 changes: 2 additions & 1 deletion www/grpc/gen/docs/grpc.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ title: GRPC API Reference
weight: 1
---

Each node in the Pactus network can be configured to use the [gRPC](https://grpc.io/) protocol for communication.
Each node in the Pactus network can be configured to use the
[gRPC](https://grpc.io/) protocol for communication.
Here you can find the list of all gRPC methods and messages.

All the amounts and values in gRPC endpoints are in NanoPAC units, which are atomic and the smallest unit in the Pactus blockchain.
Expand Down
21 changes: 11 additions & 10 deletions www/grpc/gen/docs/json-rpc.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ title: JSON-RPC API Reference
weight: 2
---

Each node in the Pactus network can be configured to use the [JSON-RPC](https://www.jsonrpc.org/specification) protocol for communication.
Each node in the Pactus network can be configured to use the
[JSON-RPC](https://www.jsonrpc.org/specification) protocol for communication.
Here, you can find the list of all JSON-RPC methods and messages.

All the amounts and values in JSON-RPC endpoints are in NanoPAC units,
Expand Down Expand Up @@ -275,7 +276,7 @@ parameters.</p>
</tr>
<tr>
<td class="fw-bold">verbosity</td>
<td> string</td>
<td> numeric</td>
<td>
(Enum)The verbosity level for transaction details.
<br>Available values:<ul>
Expand Down Expand Up @@ -358,7 +359,7 @@ parameters.</p>
</tr>
<tr>
<td class="fw-bold">transaction.payload_type</td>
<td> string</td>
<td> numeric</td>
<td>
(Enum)The type of transaction payload.
<br>Available values:<ul>
Expand Down Expand Up @@ -542,7 +543,7 @@ and payload type.</p>
</tr>
<tr>
<td class="fw-bold">payload_type</td>
<td> string</td>
<td> numeric</td>
<td>
(Enum)The type of transaction payload.
<br>Available values:<ul>
Expand Down Expand Up @@ -956,7 +957,7 @@ parameters.</p>
</tr>
<tr>
<td class="fw-bold">verbosity</td>
<td> string</td>
<td> numeric</td>
<td>
(Enum)The verbosity level for block information.
<br>Available values:<ul>
Expand Down Expand Up @@ -1139,7 +1140,7 @@ BLOCK_TRANSACTIONS.
</tr>
<tr>
<td class="fw-bold">txs[].payload_type</td>
<td> string</td>
<td> numeric</td>
<td>
(Enum)The type of transaction payload.
<br>Available values:<ul>
Expand Down Expand Up @@ -1627,7 +1628,7 @@ committee.
</tr>
<tr>
<td class="fw-bold">instances[].votes[].type</td>
<td> string</td>
<td> numeric</td>
<td>
(Enum)The type of the vote.
<br>Available values:<ul>
Expand Down Expand Up @@ -2040,7 +2041,7 @@ address.</p>
<tbody class="table-group-divider">
<tr>
<td class="fw-bold">payload_type</td>
<td> string</td>
<td> numeric</td>
<td>
(Enum)The type of transactions to retrieve from the transaction pool. 0 means all
types.
Expand Down Expand Up @@ -2114,7 +2115,7 @@ types.
</tr>
<tr>
<td class="fw-bold">txs[].payload_type</td>
<td> string</td>
<td> numeric</td>
<td>
(Enum)The type of transaction payload.
<br>Available values:<ul>
Expand Down Expand Up @@ -3199,7 +3200,7 @@ public key.</p>
</tr>
<tr>
<td class="fw-bold">address_type</td>
<td> string</td>
<td> numeric</td>
<td>
(Enum)The type of address to generate.
<br>Available values:<ul>
Expand Down
Loading

0 comments on commit bba3df3

Please sign in to comment.