Skip to content

Remove pagination from collection list #502

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 15, 2020
Merged

Remove pagination from collection list #502

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cb80f82
Remove pagination from collection list
Apr 6, 2020
1e8d089
Default size to 0
Apr 6, 2020
cc7822a
Default size to 0
Apr 6, 2020
9ee01a9
Merge branch '7-dev' into fix-collection-list
Apr 10, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions doc/7/controllers/collection/list/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ list(index, [options]);
<br/>

| Arguments | Type | Description |
| --------- | ----------------- | ------------- |
|-----------|-------------------|---------------|
| `index` | <pre>string</pre> | Index name |
| `options` | <pre>object</pre> | Query options |

Expand All @@ -28,26 +28,26 @@ list(index, [options]);
Additional query options

| Property | Type<br/>(default) | Description |
| ---------- | ------------------------------- | ---------------------------------------------------------------------------- |
|------------|---------------------------------|------------------------------------------------------------------------------|
| `queuable` | <pre>boolean</pre><br/>(`true`) | If true, queues the request during downtime, until connected to Kuzzle again |
| `from` | <pre>number</pre> <br/>(`0`) | Offset of the first result |
| `size` | <pre>number</pre> <br/>(`10`) | Maximum number of returned results |
| `from` | <pre>number</pre> <br/>(`0`) | Offset of the first result <DeprecatedBadge since="7.1.4"/> |
| `size` | <pre>number</pre> <br/>(`10`) | Maximum number of returned results <DeprecatedBadge since="7.1.4"/> |

## Resolves

Resolves to an object containing the following properties:

| Property | Type | Description |
| ------------- | ------------------- | ------------------------------------------------------------------ |
|---------------|---------------------|--------------------------------------------------------------------|
| `type` | <pre>string</pre> | Types of returned collections <br/>(`all`, `realtime` or `stored`) |
| `collections` | <pre>object[]</pre> | List of collections |
| `from` | <pre>number</pre> | Offset of the first result |
| `size` | <pre>number</pre> | Maximum number of returned results |
| `from` | <pre>number</pre> | Offset of the first result <DeprecatedBadge since="7.1.4"/> |
| `size` | <pre>number</pre> | Maximum number of returned results <DeprecatedBadge since="7.1.4"/> |

Each object in the `collections` array contains the following properties:

| Property | Type | Description |
| -------- | ----------------- | ---------------------------------------- |
|----------|-------------------|------------------------------------------|
| `name` | <pre>string</pre> | Collection name |
| `type` | <pre>string</pre> | Collection type (`realtime` or `stored`) |

Expand Down
4 changes: 2 additions & 2 deletions src/controllers/Collection.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,8 @@ class CollectionController extends BaseController {
const request = {
index,
action: 'list',
from: options.from,
size: options.size
size: options.size || 0,
from: options.from
};
delete options.from;
delete options.size;
Expand Down
4 changes: 2 additions & 2 deletions test/controllers/collection.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,8 +220,8 @@ describe('Collection Controller', () => {
controller: 'collection',
action: 'list',
index: 'index',
from: undefined,
size: undefined
size: 0,
from: undefined
}, options);

should(res).match({
Expand Down