Skip to content

Commit 2ca3645

Browse files
committed
docs: add Pagination section to README
#112 list 系コマンドの --limit / --offset サポート状況を README に明記。 サーバー側の maxLimit (NGSI 1000 / Admin 100) も併記。
1 parent 0fa1583 commit 2ca3645

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,19 @@ Options are resolved in this order (first wins):
8585
2. Config file (`~/.config/geonic/config.json`)
8686
3. Defaults (`format=json`)
8787

88+
## Pagination
89+
90+
All `list` subcommands accept `--limit <n>` and `--offset <n>` to paginate through results:
91+
92+
```bash
93+
geonic types list --limit 50 --offset 100
94+
geonic admin users list --limit 100 --offset 0
95+
```
96+
97+
Supported on: `entities list`, `temporal entities list`, `subscriptions list`, `registrations list`, `snapshots list`, `types list`, `rules list`, `catalog datasets list`, `custom-data-models list`, `me policies list`, `me api-keys list`, `me oauth-clients list`, and all `admin <resource> list` commands.
98+
99+
Server-side maximum limits: 1000 for NGSI endpoints, 100 for admin endpoints. Omit both flags to use server defaults.
100+
88101
## Commands
89102

90103
### help — Get help on commands

0 commit comments

Comments
 (0)