Skip to content

Commit 31d23a4

Browse files
committed
docs
1 parent a3f4815 commit 31d23a4

File tree

3 files changed

+106
-10
lines changed

3 files changed

+106
-10
lines changed

docs-v2/dist/bundle.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/dist/app.bundle.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/src/openapi-v1.yaml

Lines changed: 104 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1544,9 +1544,9 @@ paths:
15441544
tags:
15451545
- blocks
15461546
summary: Get a range of blocks by their height.
1547-
description: Given a range query parameter return an array of all the blocks within that range.
1547+
description: Given a range query parameter return an array of all the blocks within that range.
15481548
When `useRcBlock` parameter is used, the range represents relay chain block numbers and the response
1549-
includes additional fields `rcBlockNumber` and `ahTimestamp` for each block. Relay chain blocks
1549+
includes additional fields `rcBlockHash`, `rcBlockNumber`, and `ahTimestamp` for each block. Relay chain blocks
15501550
without corresponding Asset Hub blocks are skipped.
15511551
operationId: getBlock
15521552
parameters:
@@ -1616,7 +1616,7 @@ paths:
16161616
summary: Get a block by its height or hash.
16171617
description: Returns a single block. BlockId can either be a block hash or a
16181618
block height. Replaces `/block/{number}` from versions < v1.0.0. When `useRcBlock` parameter is used, the response
1619-
includes additional fields `rcBlockNumber` and `ahTimestamp`.
1619+
includes additional fields `rcBlockHash`, `rcBlockNumber`, and `ahTimestamp`.
16201620
operationId: getBlockById
16211621
parameters:
16221622
- name: blockId
@@ -1713,7 +1713,7 @@ paths:
17131713
summary: Get a block's header by its height or hash.
17141714
description: Returns a single block's header. BlockId can either be a block hash or a
17151715
block height. When `useRcBlock` parameter is used, the response
1716-
includes additional fields `rcBlockNumber` and `ahTimestamp`.
1716+
includes additional fields `rcBlockHash`, `rcBlockNumber`, and `ahTimestamp`.
17171717
operationId: getBlockHeaderById
17181718
parameters:
17191719
- name: blockId
@@ -1756,7 +1756,7 @@ paths:
17561756
summary: Get an extrinsic by its extrinsicIndex and block height or hash.
17571757
The pair blockId, extrinsicIndex is sometimes referred to as a Timepoint.
17581758
description: Returns a single extrinsic. When `useRcBlock` parameter is used, the response
1759-
includes additional fields `rcBlockNumber` and `ahTimestamp`.
1759+
includes additional fields `rcBlockHash`, `rcBlockNumber`, and `ahTimestamp`.
17601760
operationId: getExtrinsicByTimepoint
17611761
parameters:
17621762
- name: blockId
@@ -1835,7 +1835,7 @@ paths:
18351835
summary: Get the most recently finalized block.
18361836
description: Returns the most recently finalized block. Replaces `/block`
18371837
from versions < v1.0.0. When `useRcBlock` parameter is used, the response
1838-
includes additional fields `rcBlockNumber` and `ahTimestamp`.
1838+
includes additional fields `rcBlockHash`, `rcBlockNumber`, and `ahTimestamp`.
18391839
operationId: getHeadBlock
18401840
parameters:
18411841
- name: finalized
@@ -1920,7 +1920,7 @@ paths:
19201920
- blocks
19211921
summary: Get information about the header of the most recent finalized block.
19221922
description: Returns the most recently finalized block's header. When `useRcBlock` parameter is used, the response
1923-
includes additional fields `rcBlockNumber` and `ahTimestamp`.
1923+
includes additional fields `rcBlockHash`, `rcBlockNumber`, and `ahTimestamp`.
19241924
operationId: getLatestBlockHeader
19251925
parameters:
19261926
- name: finalized
@@ -1966,7 +1966,7 @@ paths:
19661966
summary: Get a blocks header & its extrinsics as hex values.
19671967
description: Returns a block & its extrinsics as hex values. BlockId can either be a block hash or a
19681968
block height. When `useRcBlock` parameter is used, the response
1969-
includes additional fields `rcBlockNumber` and `ahTimestamp`.
1969+
includes additional fields `rcBlockHash`, `rcBlockNumber`, and `ahTimestamp`.
19701970
operationId: getBlockRawExtrinsics
19711971
parameters:
19721972
- name: blockId
@@ -4869,6 +4869,9 @@ components:
48694869
type: string
48704870
description: The amount reserved on the owner's account to hold this item in storage.
48714871
format: unsignedInteger
4872+
rcBlockHash:
4873+
type: string
4874+
description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used.
48724875
rcBlockNumber:
48734876
type: string
48744877
description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used.
@@ -4926,6 +4929,9 @@ components:
49264929
description: An array of queried assets.
49274930
items:
49284931
$ref: '#/components/schemas/AssetsBalance'
4932+
rcBlockHash:
4933+
type: string
4934+
description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used.
49294935
rcBlockNumber:
49304936
type: string
49314937
description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used.
@@ -4991,6 +4997,9 @@ components:
49914997
locks
49924998
items:
49934999
$ref: '#/components/schemas/BalanceLock'
5000+
rcBlockHash:
5001+
type: string
5002+
description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used.
49945003
rcBlockNumber:
49955004
type: string
49965005
description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used.
@@ -5045,6 +5054,9 @@ components:
50455054
description: An array of queried assets.
50465055
items:
50475056
$ref: '#/components/schemas/AssetsBalance'
5057+
rcBlockHash:
5058+
type: string
5059+
description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used.
50485060
rcBlockNumber:
50495061
type: string
50505062
description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used.
@@ -5078,6 +5090,9 @@ components:
50785090
type: string
50795091
format: unsignedInteger
50805092
description: The held deposit.
5093+
rcBlockHash:
5094+
type: string
5095+
description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used.
50815096
rcBlockNumber:
50825097
type: string
50835098
description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used.
@@ -5114,6 +5129,9 @@ components:
51145129
$ref: '#/components/schemas/Nominations'
51155130
staking:
51165131
$ref: '#/components/schemas/StakingLedger'
5132+
rcBlockHash:
5133+
type: string
5134+
description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used.
51175135
rcBlockNumber:
51185136
type: string
51195137
description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used.
@@ -5155,6 +5173,9 @@ components:
51555173
based on the portion of `totalEraRewardPoints` they have.
51565174
payouts:
51575175
$ref: '#/components/schemas/Payouts'
5176+
rcBlockHash:
5177+
type: string
5178+
description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used.
51585179
rcBlockNumber:
51595180
type: string
51605181
description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used.
@@ -5193,6 +5214,9 @@ components:
51935214
type: array
51945215
items:
51955216
$ref: '#/components/schemas/VestingSchedule'
5217+
rcBlockHash:
5218+
type: string
5219+
description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used.
51965220
rcBlockNumber:
51975221
type: string
51985222
description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used.
@@ -5398,6 +5422,9 @@ components:
53985422
description: >-
53995423
A boolean identifying whether the block is finalized or not.
54005424
Note: on chains that do not have deterministic finality this field is omitted.
5425+
rcBlockHash:
5426+
type: string
5427+
description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used.
54015428
rcBlockNumber:
54025429
type: string
54035430
description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used.
@@ -5443,6 +5470,9 @@ components:
54435470
block.
54445471
items:
54455472
type: string
5473+
rcBlockHash:
5474+
type: string
5475+
description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used.
54465476
rcBlockNumber:
54475477
type: string
54485478
description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used.
@@ -5491,6 +5521,9 @@ components:
54915521
items:
54925522
$ref: '#/components/schemas/DigestItem'
54935523
description: Array of `DigestItem`s associated with the block.
5524+
rcBlockHash:
5525+
type: string
5526+
description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used.
54945527
rcBlockNumber:
54955528
type: string
54965529
description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used.
@@ -6227,6 +6260,9 @@ components:
62276260
$ref: '#/components/schemas/BlockIdentifiers'
62286261
extrinsic:
62296262
$ref: '#/components/schemas/Extrinsic'
6263+
rcBlockHash:
6264+
type: string
6265+
description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used.
62306266
rcBlockNumber:
62316267
type: string
62326268
description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used.
@@ -6302,6 +6338,9 @@ components:
63026338
null}},{\"parents\":\"0\",\"interior\":{\"x2\":[{\"palletInstance\":
63036339
\"50\"},{\"generalIndex\":\"2\"}]}}],\"lpToken\":{\"lpToken\":\"1\"}
63046340
},{\"lpToken\":{\"lpToken\":\"0\"}}]"
6341+
rcBlockHash:
6342+
type: string
6343+
description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used.
63056344
rcBlockNumber:
63066345
type: string
63076346
description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used.
@@ -6336,6 +6375,9 @@ components:
63366375
type: string
63376376
description: Next availabe liquidity pool's id.
63386377
example: "4"
6378+
rcBlockHash:
6379+
type: string
6380+
description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used.
63396381
rcBlockNumber:
63406382
type: string
63416383
description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used.
@@ -6499,6 +6541,9 @@ components:
64996541
$ref: '#/components/schemas/AssetInfo'
65006542
assetMetadata:
65016543
$ref: '#/components/schemas/AssetMetadata'
6544+
rcBlockHash:
6545+
type: string
6546+
description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used.
65026547
rcBlockNumber:
65036548
type: string
65046549
description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used.
@@ -6525,6 +6570,9 @@ components:
65256570
items:
65266571
$ref: '#/components/schemas/PalletConstantsItemMetadata'
65276572
description: Array containing metadata for each constant entry of the pallet.
6573+
rcBlockHash:
6574+
type: string
6575+
description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used.
65286576
rcBlockNumber:
65296577
type: string
65306578
description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used.
@@ -6548,6 +6596,9 @@ components:
65486596
example: "EnactmentPeriod"
65496597
metadata:
65506598
$ref: '#/components/schemas/PalletConstantsItemMetadata'
6599+
rcBlockHash:
6600+
type: string
6601+
description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used.
65516602
rcBlockNumber:
65526603
type: string
65536604
description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used.
@@ -6590,6 +6641,9 @@ components:
65906641
items:
65916642
$ref: '#/components/schemas/PalletDispatchablesItemMetadata'
65926643
description: Array containing metadata for each dispatchable entry of the pallet.
6644+
rcBlockHash:
6645+
type: string
6646+
description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used.
65936647
rcBlockNumber:
65946648
type: string
65956649
description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used.
@@ -6615,6 +6669,9 @@ components:
66156669
example: "vote"
66166670
metadata:
66176671
$ref: '#/components/schemas/PalletDispatchablesItemMetadata'
6672+
rcBlockHash:
6673+
type: string
6674+
description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used.
66186675
rcBlockNumber:
66196676
type: string
66206677
description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used.
@@ -6664,6 +6721,9 @@ components:
66646721
items:
66656722
$ref: '#/components/schemas/PalletErrorsItemMetadata'
66666723
description: Array containing metadata for each error entry of the pallet.
6724+
rcBlockHash:
6725+
type: string
6726+
description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used.
66676727
rcBlockNumber:
66686728
type: string
66696729
description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used.
@@ -6687,6 +6747,9 @@ components:
66876747
example: "ValueLow"
66886748
metadata:
66896749
$ref: '#/components/schemas/PalletErrorsItemMetadata'
6750+
rcBlockHash:
6751+
type: string
6752+
description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used.
66906753
rcBlockNumber:
66916754
type: string
66926755
description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used.
@@ -6734,6 +6797,9 @@ components:
67346797
items:
67356798
$ref: '#/components/schemas/PalletEventsItemMetadata'
67366799
description: Array containing metadata for each event entry of the pallet.
6800+
rcBlockHash:
6801+
type: string
6802+
description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used.
67376803
rcBlockNumber:
67386804
type: string
67396805
description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used.
@@ -6757,6 +6823,9 @@ components:
67576823
example: "Proposed"
67586824
metadata:
67596825
$ref: '#/components/schemas/PalletEventsItemMetadata'
6826+
rcBlockHash:
6827+
type: string
6828+
description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used.
67606829
rcBlockNumber:
67616830
type: string
67626831
description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used.
@@ -6796,6 +6865,9 @@ components:
67966865
items:
67976866
$ref: '#/components/schemas/PalletsForeignAssetsInfo'
67986867
description: Array containing the `AssetDetails` and `AssetMetadata` of every foreign asset.
6868+
rcBlockHash:
6869+
type: string
6870+
description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used.
67996871
rcBlockNumber:
68006872
type: string
68016873
description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used.
@@ -6820,6 +6892,9 @@ components:
68206892
$ref: '#/components/schemas/BondedPool'
68216893
rewardPool:
68226894
$ref: '#/components/schemas/RewardPool'
6895+
rcBlockHash:
6896+
type: string
6897+
description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used.
68236898
rcBlockNumber:
68246899
type: string
68256900
description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used.
@@ -6856,6 +6931,9 @@ components:
68566931
type: number
68576932
minJoinBond:
68586933
type: number
6934+
rcBlockHash:
6935+
type: string
6936+
description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used.
68596937
rcBlockNumber:
68606938
type: string
68616939
description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used.
@@ -6911,6 +6989,9 @@ components:
69116989
description: The block number at which the referendum's confirmation stage will end at as long as
69126990
it doesn't lose its approval in the meantime.
69136991
description: A list of ongoing referenda and their details.
6992+
rcBlockHash:
6993+
type: string
6994+
description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used.
69146995
rcBlockNumber:
69156996
type: string
69166997
description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used.
@@ -6926,6 +7007,9 @@ components:
69267007
$ref: '#/components/schemas/AssetInfo'
69277008
poolAssetMetadata:
69287009
$ref: '#/components/schemas/AssetMetadata'
7010+
rcBlockHash:
7011+
type: string
7012+
description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used.
69297013
rcBlockNumber:
69307014
type: string
69317015
description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used.
@@ -6948,6 +7032,9 @@ components:
69487032
items:
69497033
$ref: '#/components/schemas/PalletStorageItemMetadata'
69507034
description: Array containing metadata for each storage entry of the pallet.
7035+
rcBlockHash:
7036+
type: string
7037+
description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used.
69517038
rcBlockNumber:
69527039
type: string
69537040
description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used.
@@ -6992,6 +7079,9 @@ components:
69927079
turnout: "34485320658000000"
69937080
metadata:
69947081
$ref: '#/components/schemas/PalletStorageItemMetadata'
7082+
rcBlockHash:
7083+
type: string
7084+
description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used.
69957085
rcBlockNumber:
69967086
type: string
69977087
description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used.
@@ -7520,6 +7610,9 @@ components:
75207610
items:
75217611
type: string
75227612
format: ss58
7613+
rcBlockHash:
7614+
type: string
7615+
description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used.
75237616
rcBlockNumber:
75247617
type: string
75257618
description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used.
@@ -7562,6 +7655,9 @@ components:
75627655
status:
75637656
type: string
75647657
description: Status of individual validator (active/waiting).
7658+
rcBlockHash:
7659+
type: string
7660+
description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used.
75657661
rcBlockNumber:
75667662
type: string
75677663
description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used.

0 commit comments

Comments
 (0)