Skip to content

Commit

Permalink
feat: update docs with new pre caveat for store/list and `upload/…
Browse files Browse the repository at this point in the history 
…list` (#48)

sync with the work merged in
storacha/w3up#423
  • Loading branch information
@travis
travis authored Feb 13, 2023
1 parent e58cc37 commit 445bb79
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions w3-store.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -203,12 +203,13 @@ The `with` field of the invocation must be set to the DID of the memory space to

#### Caveats

When invoking `store/list` the `size` caveat may be set to the desired number of results to return per invocation. If there are more total results than will fit into the given `size`, the response will include an opaque `cursor` field that can be used to continue the listing in a subsequent invocation by setting the `cursor` caveat to the value in the response.
When invoking `store/list` the `size` caveat may be set to the desired number of results to return per invocation. If there are more total results than will fit into the given `size`, the response will include an opaque `cursor` field that can be used to continue the listing in a subsequent invocation by setting the `cursor` caveat to the value in the response. The `pre` caveat may be set to return the page of results preceding the cursor.

| `field` | `value` | `required?` | `context` |
| -------- | --------------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------- |
| `size` | `number` | | The desired number of results to return. |
| `cursor` | `string` | | An opaque string included in a prior `store/list` response that allows the service to provide the next "page" of results. |
| `pre` | `boolean` | | If true, return the page of results preceding the cursor. |

#### Invocation

Expand Down Expand Up @@ -397,12 +398,13 @@ The `upload/list` capability can be invoked to request a list of metadata about

#### Caveats

When invoking `upload/list` the `size` caveat may be set to the desired number of results to return per invocation. If there are more total results than will fit into the given `size`, the response will include an opaque `cursor` field that can be used to continue the listing in a subsequent invocation by setting the `cursor` caveat to the value in the response.
When invoking `upload/list` the `size` caveat may be set to the desired number of results to return per invocation. If there are more total results than will fit into the given `size`, the response will include an opaque `cursor` field that can be used to continue the listing in a subsequent invocation by setting the `cursor` caveat to the value in the response. The `pre` caveat may be set to return the page of results preceding the cursor.

| `field` | `value` | `required?` | `context` |
| -------- | --------------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------- |
| `size` | `number` | | The desired number of results to return. |
| `cursor` | `string` | | An opaque string included in a prior `store/list` response that allows the service to provide the next "page" of results. |
| `pre` | `boolean` | | If true, return the page of results preceding the cursor. |

#### Invocation

Expand Down

0 comments on commit 445bb79

Please sign in to comment.