[docs] Fix `dataSlice` definition (#30648)
* Repair incorrect definition for `dataSlice` in `getAccountInfo` * Update all other occurrences of `dataSlice` in the docs
This commit is contained in:
parent
3b9438fd49
commit
569c5fd9d6
|
@ -56,13 +56,15 @@ Encoding format for Account data
|
||||||
|
|
||||||
</Field>
|
</Field>
|
||||||
|
|
||||||
<Field name="dataSlice" type="string" optional={true}>
|
<Field name="dataSlice" type="object" optional={true}>
|
||||||
limit the returned account data using the provided "offset: <usize>" and
|
Request a slice of the account's data.
|
||||||
"length: <usize>" fields
|
|
||||||
<li>
|
- `length: <usize>` - number of bytes to return
|
||||||
only available for <code>base58</code>, <code>base64</code> or{" "}
|
- `offset: <usize>` - byte offset from which to start reading
|
||||||
<code>base64+zstd</code> encodings.
|
|
||||||
</li>
|
:::info
|
||||||
|
Data slicing is only available for <code>base58</code>, <code>base64</code>, or <code>base64+zstd</code> encodings.
|
||||||
|
:::
|
||||||
</Field>
|
</Field>
|
||||||
|
|
||||||
<Field name="minContextSlot" type="number" optional={true}>
|
<Field name="minContextSlot" type="number" optional={true}>
|
||||||
|
|
|
@ -40,9 +40,14 @@ Configuration object containing the following fields:
|
||||||
</Field>
|
</Field>
|
||||||
|
|
||||||
<Field name="dataSlice" type="object" optional={true}>
|
<Field name="dataSlice" type="object" optional={true}>
|
||||||
|
Request a slice of the account's data.
|
||||||
|
|
||||||
limit the returned account data using the provided `offset: <usize>` and `length: <usize>` fields; only available for "base58", "base64" or "base64+zstd" encodings.
|
- `length: <usize>` - number of bytes to return
|
||||||
|
- `offset: <usize>` - byte offset from which to start reading
|
||||||
|
|
||||||
|
:::info
|
||||||
|
Data slicing is only available for <code>base58</code>, <code>base64</code>, or <code>base64+zstd</code> encodings.
|
||||||
|
:::
|
||||||
</Field>
|
</Field>
|
||||||
|
|
||||||
<Field name="encoding" type="string" optional={true} defaultValue={"json"} href="/api/http#parsed-responses">
|
<Field name="encoding" type="string" optional={true} defaultValue={"json"} href="/api/http#parsed-responses">
|
||||||
|
|
|
@ -64,10 +64,14 @@ encoding format for the returned Account data
|
||||||
</Field>
|
</Field>
|
||||||
|
|
||||||
<Field name="dataSlice" type="object" optional={true}>
|
<Field name="dataSlice" type="object" optional={true}>
|
||||||
limit the returned account data using the provided `offset: usize` and `length: usize` fields;
|
Request a slice of the account's data.
|
||||||
|
|
||||||
- only available for "base58", "base64" or "base64+zstd" encodings.
|
- `length: <usize>` - number of bytes to return
|
||||||
|
- `offset: <usize>` - byte offset from which to start reading
|
||||||
|
|
||||||
|
:::info
|
||||||
|
Data slicing is only available for <code>base58</code>, <code>base64</code>, or <code>base64+zstd</code> encodings.
|
||||||
|
:::
|
||||||
</Field>
|
</Field>
|
||||||
|
|
||||||
<Field name="filters" type="array" optional={true} href={"/api/http#filter-criteria"}>
|
<Field name="filters" type="array" optional={true} href={"/api/http#filter-criteria"}>
|
||||||
|
|
|
@ -48,11 +48,14 @@ Configuration object containing the following fields:
|
||||||
</Field>
|
</Field>
|
||||||
|
|
||||||
<Field name="dataSlice" type="object" optional={true}>
|
<Field name="dataSlice" type="object" optional={true}>
|
||||||
|
Request a slice of the account's data.
|
||||||
|
|
||||||
limit the returned account data using the provided `offset: <usize>`
|
- `length: <usize>` - number of bytes to return
|
||||||
and `length: <usize>` fields; only available for `base58`,
|
- `offset: <usize>` - byte offset from which to start reading
|
||||||
`base64` or `base64+zstd` encodings.
|
|
||||||
|
|
||||||
|
:::info
|
||||||
|
Data slicing is only available for <code>base58</code>, <code>base64</code>, or <code>base64+zstd</code> encodings.
|
||||||
|
:::
|
||||||
</Field>
|
</Field>
|
||||||
|
|
||||||
<Field name="encoding" type="string" optional={true} href="/api/http#parsed-responses">
|
<Field name="encoding" type="string" optional={true} href="/api/http#parsed-responses">
|
||||||
|
|
|
@ -48,11 +48,14 @@ Configuration object containing the following fields:
|
||||||
</Field>
|
</Field>
|
||||||
|
|
||||||
<Field name="dataSlice" type="object" optional={true}>
|
<Field name="dataSlice" type="object" optional={true}>
|
||||||
|
Request a slice of the account's data.
|
||||||
|
|
||||||
limit the returned account data using the provided `offset: <usize>`
|
- `length: <usize>` - number of bytes to return
|
||||||
and `length: <usize>` fields; only available for
|
- `offset: <usize>` - byte offset from which to start reading
|
||||||
`base58`, `base64`, or `base64+zstd` encodings.
|
|
||||||
|
|
||||||
|
:::info
|
||||||
|
Data slicing is only available for <code>base58</code>, <code>base64</code>, or <code>base64+zstd</code> encodings.
|
||||||
|
:::
|
||||||
</Field>
|
</Field>
|
||||||
|
|
||||||
<Field name="encoding" type="string" optional={true} href="/api/http#parsed-responses">
|
<Field name="encoding" type="string" optional={true} href="/api/http#parsed-responses">
|
||||||
|
|
Loading…
Reference in New Issue