Skip to content

Commit

Permalink
docs small update
Browse files Browse the repository at this point in the history
  • Loading branch information
Imod7 committed Jan 8, 2025
1 parent 18e840a commit c7b7256
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/src/openapi-v1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -414,7 +414,8 @@ paths:
- staking
summary: Get staking information for a _Stash_ account.
description: Returns information about a _Stash_ account's staking activity.
Replaces `/staking/{address}` from versions < v1.0.0.
Replaces `/staking/{address}` from versions < v1.0.0. The _Stash_ account
can be either a validator or nominator account.
operationId: getStakingSummaryByAccountId
parameters:
- name: accountId
Expand Down Expand Up @@ -4338,8 +4339,8 @@ components:
claimedRewards:
type: array
description: Array of objects, each containing an `era` and its corresponding `status`,
which represents the rewards status of the stakers backing a validator. Only updated
for _validators._ This array is populated with values from `stakingLedger.legacyClaimedRewards`
which represents the rewards status of the queried Stash account. The queried account can either be
a validator or nominator account. This array is populated with values from `stakingLedger.legacyClaimedRewards`
or `stakingLedger.claimedRewards`, as well as the `query.staking.claimedRewards` call, depending
on whether the queried block is before or after the migration. For more details on the implementation
and the migration, refer to the related PR (https://github.com/paritytech/substrate-api-sidecar/pull/1445)
Expand Down

0 comments on commit c7b7256

Please sign in to comment.