Skip to content

Commit bab45a1

Browse files
mDuo13mDuo13
authored
Merge pull request #3229 from XRPLF/fix_api_versioning_links
Fix API v2 links & revise API versioning section slightly
2 parents 31e9682 + d58ddaf commit bab45a1

File tree

7 files changed

+345
-44
lines changed

7 files changed

+345
-44
lines changed

‎@l10n/ja/docs/_snippets/common-links.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@
1414
[AMMVoteトランザクション]: /@l10n/ja/docs/references/protocol/transactions/types/ammvote.md
1515
[AMMWithdraw]: /@l10n/ja/docs/references/protocol/transactions/types/ammwithdraw.md
1616
[AMMWithdrawトランザクション]: /@l10n/ja/docs/references/protocol/transactions/types/ammwithdraw.md
17-
[API v1]: /@l10n/ja/docs/references/http-websocket-apis/api-conventions/request-formatting.md#api-versioning
18-
[API v2]: /@l10n/ja/docs/references/http-websocket-apis/api-conventions/request-formatting.md#api-versioning
17+
[API v1]: /@l10n/ja/docs/references/http-websocket-apis/index.md
18+
[API v2]: /@l10n/ja/docs/references/http-websocket-apis/index.md
1919
[AccountDelete]: /@l10n/ja/docs/references/protocol/transactions/types/accountdelete.md
2020
[AccountDeleteトランザクション]: /@l10n/ja/docs/references/protocol/transactions/types/accountdelete.md
2121
[AccountRootエントリ]: /@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/accountroot.md

‎@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_tx.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ rippled -- account_tx rLNaPoKeeBjZe2qs6x52yVPZpZ8td4dc6w -1 -1 2 0 binary descen
8181
| `marker` | [マーカー][] | 以前にページネーションされたレスポンスの値。そのレスポンスを停止した箇所からデータの取得を再開します。サーバが使用できるレジャーの範囲に変更があっても、この値は変わりません。 |
8282

8383
- リクエスト内で次の各フィールドのうち1つ以上を使用する必要があります: `ledger_index`、`ledger_hash`、`ledger_index_min`、または`ledger_index_max`。
84-
- [API v2]： `ledger_index`と`ledger_hash`のどちらかを指定した場合、`ledger_index_min`と`ledger_index_max`を含めると`invalidParams`エラーが返ります。
84+
- [API v2][]： `ledger_index`と`ledger_hash`のどちらかを指定した場合、`ledger_index_min`と`ledger_index_max`を含めると`invalidParams`エラーが返ります。
8585

8686

8787
### 照会されたデータの繰り返し

‎docs/_snippets/common-links.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@
2121
[AMMWithdraw transaction]: /docs/references/protocol/transactions/types/ammwithdraw.md
2222
[AMMWithdraw transactions]: /docs/references/protocol/transactions/types/ammwithdraw.md
2323
[AMMWithdraw]: /docs/references/protocol/transactions/types/ammwithdraw.md
24-
[API v1]: /docs/references/http-websocket-apis/api-conventions/request-formatting.md#api-versioning
25-
[API v2]: /docs/references/http-websocket-apis/api-conventions/request-formatting.md#api-versioning
24+
[API v1]: /docs/references/http-websocket-apis/index.md#api-versioning
25+
[API v2]: /docs/references/http-websocket-apis/index.md#api-versioning
2626
[AccountDelete transaction]: /docs/references/protocol/transactions/types/accountdelete.md
2727
[AccountDelete transactions]: /docs/references/protocol/transactions/types/accountdelete.md
2828
[AccountDelete]: /docs/references/protocol/transactions/types/accountdelete.md

‎docs/img/_sources/api-functionality-venn-diagram.uxf‎

Lines changed: 168 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,168 @@
1+
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
2+
<diagram program="umlet" version="14.2">
3+
<zoom_level>10</zoom_level>
4+
<element>
5+
<id>UMLUseCase</id>
6+
<coordinates>
7+
<x>230</x>
8+
<y>90</y>
9+
<w>400</w>
10+
<h>360</h>
11+
</coordinates>
12+
<panel_attributes/>
13+
<additional_attributes/>
14+
</element>
15+
<element>
16+
<id>UMLUseCase</id>
17+
<coordinates>
18+
<x>30</x>
19+
<y>90</y>
20+
<w>400</w>
21+
<h>360</h>
22+
</coordinates>
23+
<panel_attributes/>
24+
<additional_attributes/>
25+
</element>
26+
<element>
27+
<id>Text</id>
28+
<coordinates>
29+
<x>140</x>
30+
<y>50</y>
31+
<w>110</w>
32+
<h>30</h>
33+
</coordinates>
34+
<panel_attributes>*rippled Server*</panel_attributes>
35+
<additional_attributes/>
36+
</element>
37+
<element>
38+
<id>Text</id>
39+
<coordinates>
40+
<x>400</x>
41+
<y>50</y>
42+
<w>110</w>
43+
<h>30</h>
44+
</coordinates>
45+
<panel_attributes>*Clio Server*</panel_attributes>
46+
<additional_attributes/>
47+
</element>
48+
<element>
49+
<id>Text</id>
50+
<coordinates>
51+
<x>310</x>
52+
<y>70</y>
53+
<w>50</w>
54+
<h>30</h>
55+
</coordinates>
56+
<panel_attributes>*Both*</panel_attributes>
57+
<additional_attributes/>
58+
</element>
59+
<element>
60+
<id>Text</id>
61+
<coordinates>
62+
<x>290</x>
63+
<y>250</y>
64+
<w>100</w>
65+
<h>50</h>
66+
</coordinates>
67+
<panel_attributes>style=wordwrap
68+
• Serve most API methods</panel_attributes>
69+
<additional_attributes/>
70+
</element>
71+
<element>
72+
<id>Text</id>
73+
<coordinates>
74+
<x>430</x>
75+
<y>150</y>
76+
<w>140</w>
77+
<h>50</h>
78+
</coordinates>
79+
<panel_attributes>style=wordwrap
80+
• Scales efficiently to many requests</panel_attributes>
81+
<additional_attributes/>
82+
</element>
83+
<element>
84+
<id>Text</id>
85+
<coordinates>
86+
<x>30</x>
87+
<y>0</y>
88+
<w>490</w>
89+
<h>40</h>
90+
</coordinates>
91+
<panel_attributes>fontsize=20
92+
*API functionality provided by servers*</panel_attributes>
93+
<additional_attributes/>
94+
</element>
95+
<element>
96+
<id>Text</id>
97+
<coordinates>
98+
<x>90</x>
99+
<y>160</y>
100+
<w>150</w>
101+
<h>50</h>
102+
</coordinates>
103+
<panel_attributes>style=wordwrap
104+
• Provides Admin API methods</panel_attributes>
105+
<additional_attributes/>
106+
</element>
107+
<element>
108+
<id>Text</id>
109+
<coordinates>
110+
<x>70</x>
111+
<y>220</y>
112+
<w>150</w>
113+
<h>80</h>
114+
</coordinates>
115+
<panel_attributes>style=wordwrap
116+
• Provides pending / unvalidated data including transaction queue
117+
</panel_attributes>
118+
<additional_attributes/>
119+
</element>
120+
<element>
121+
<id>Text</id>
122+
<coordinates>
123+
<x>80</x>
124+
<y>300</y>
125+
<w>160</w>
126+
<h>70</h>
127+
</coordinates>
128+
<panel_attributes>style=wordwrap
129+
• Has a live view of consensus and peer-to-peer network</panel_attributes>
130+
<additional_attributes/>
131+
</element>
132+
<element>
133+
<id>Text</id>
134+
<coordinates>
135+
<x>440</x>
136+
<y>200</y>
137+
<w>180</w>
138+
<h>70</h>
139+
</coordinates>
140+
<panel_attributes>style=wordwrap
141+
• Provides NFT methods: nft_history, nft_info, nfts_by_issuer</panel_attributes>
142+
<additional_attributes/>
143+
</element>
144+
<element>
145+
<id>Text</id>
146+
<coordinates>
147+
<x>450</x>
148+
<y>270</y>
149+
<w>180</w>
150+
<h>50</h>
151+
</coordinates>
152+
<panel_attributes>style=wordwrap
153+
• Provides mpt_holders method</panel_attributes>
154+
<additional_attributes/>
155+
</element>
156+
<element>
157+
<id>Text</id>
158+
<coordinates>
159+
<x>430</x>
160+
<y>320</y>
161+
<w>140</w>
162+
<h>80</h>
163+
</coordinates>
164+
<panel_attributes>style=wordwrap
165+
• Serves rippled-exclusive API requests by forwarding</panel_attributes>
166+
<additional_attributes/>
167+
</element>
168+
</diagram>

‎docs/img/api-functionality-venn-diagram.svg‎

Lines changed: 138 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)