Skip to content

Commit 353327a

Browse files
committed
chore: update readme
1 parent 7289d4c commit 353327a

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@ Each JSON file in `data/` should contain an array of items:
3131
{
3232
"sheet": "AchievementKind",
3333
"rowId": "1",
34-
"field": "Name",
3534
"values": {
3635
"en": "Battle",
3736
"ja": "バトル",
@@ -44,20 +43,23 @@ Each JSON file in `data/` should contain an array of items:
4443

4544
- **Search strings**
4645

47-
- **Endpoint**: `GET /search`
46+
- **Endpoint**: `GET /api/search`
4847
- **Query parameters**:
4948
- `lang` (required): language code, e.g. `en`, `ja`, `chs`
5049
- `q` (required): substring to search for in the given language
5150
- `sheet` (optional): restrict search to a specific sheet name
52-
- `limit` (optional): maximum number of results (default 100, max 1000)
53-
- **Response**: JSON array of matching items, each containing `sheet`, `rowId`, `field`, and `values` (all languages).
51+
- `offset` (optional): offset of the first item to return (default 0)
52+
- `limit` (optional): maximum number of items to return (default 100, max 1000)
53+
- **Response**: JSON array of matching items, each containing `sheet`, `rowId`, and `values` (all languages).
5454

5555
- **Get items for a row**
5656

57-
- **Endpoint**: `GET /items`
57+
- **Endpoint**: `GET /api/items`
5858
- **Query parameters**:
5959
- `sheet` (required): sheet name
6060
- `rowId` (required): row id (e.g. `"1"` or `"1.0"`)
61+
- `offset` (optional): offset of the first item to return (default 0)
62+
- `limit` (optional): maximum number of items to return (default 100, max 1000)
6163
- **Response**: JSON array of all items for the given sheet and rowId.
6264

6365

0 commit comments

Comments
 (0)