[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:
Steven Luscher 2023-03-08 17:54:33 -08:00 committed by GitHub
parent 3b9438fd49
commit 569c5fd9d6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 33 additions and 16 deletions

View File

@ -56,13 +56,15 @@ Encoding format for Account data
</Field>
<Field name="dataSlice" type="string" optional={true}>
limit the returned account data using the provided "offset: &lt;usize&gt;" and
"length: &lt;usize&gt;" fields
<li>
only available for <code>base58</code>, <code>base64</code> or{" "}
<code>base64+zstd</code> encodings.
</li>
<Field name="dataSlice" type="object" optional={true}>
Request a slice of the account&apos;s data.
- `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 name="minContextSlot" type="number" optional={true}>

View File

@ -40,9 +40,14 @@ Configuration object containing the following fields:
</Field>
<Field name="dataSlice" type="object" optional={true}>
Request a slice of the account&apos;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 name="encoding" type="string" optional={true} defaultValue={"json"} href="/api/http#parsed-responses">

View File

@ -64,10 +64,14 @@ encoding format for the returned Account data
</Field>
<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&apos;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 name="filters" type="array" optional={true} href={"/api/http#filter-criteria"}>

View File

@ -48,11 +48,14 @@ Configuration object containing the following fields:
</Field>
<Field name="dataSlice" type="object" optional={true}>
Request a slice of the account&apos;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 name="encoding" type="string" optional={true} href="/api/http#parsed-responses">

View File

@ -48,11 +48,14 @@ Configuration object containing the following fields:
</Field>
<Field name="dataSlice" type="object" optional={true}>
Request a slice of the account&apos;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 name="encoding" type="string" optional={true} href="/api/http#parsed-responses">