Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(grpc): fix linting issues for JSON-RPC and gRRC docs #1609

Merged
merged 8 commits into from
Nov 25, 2024
Merged

docs(grpc): fix linting issues for JSON-RPC and gRRC docs #1609

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
ce1e06a
fix jrpc and grpc doc lint
alidevjimmy Nov 22, 2024
7c2fcc7
Update grpc-md.tmpl
b00f Nov 24, 2024
ac158c8
Update json-rpc-md.tmpl
b00f Nov 24, 2024
4f80978
Update grpc.md
b00f Nov 24, 2024
a5b4322
Update json-rpc.md
b00f Nov 24, 2024
5a9dd24
Merge branch 'main' into fix/doc-lint
Ja7ad Nov 25, 2024
1e844e7
Merge remote-tracking branch 'upstream/main' into fix/doc-lint
alidevjimmy Nov 25, 2024
8cf6d40
Merge branch 'fix/doc-lint' of github.com:alidevjimmy/pactus into fix…
alidevjimmy Nov 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion www/grpc/buf/grpc-md.tmpl
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
Loading