Skip to content

Commit 4a81e4f

Browse files
committed
docs: /regencies/{code}/islands
1 parent c83edc8 commit 4a81e4f

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ Built with [NestJS framework](https://nestjs.com) and writen in TypeScript. [Pri
2626
- [4. Get Regencies by Name](#4-get-regencies-by-name)
2727
- [5. Get Specific Regency](#5-get-specific-regency)
2828
- [6. Get All Districts in a Regency](#6-get-all-districts-in-a-regency)
29+
- [Get All Islands in a Regency](#get-all-islands-in-a-regency)
2930
- [7. Get Districts by Name](#7-get-districts-by-name)
3031
- [8. Get Specific District](#8-get-specific-district)
3132
- [9. Get All Villages in a District](#9-get-all-villages-in-a-district)
@@ -153,6 +154,19 @@ GET /regencies/{regencyCode}/districts
153154

154155
> This endpoint also support [`sortBy`][sortby-query] and [`sortOrder`][sortorder-query] queries.
155156
157+
### Get All Islands in a Regency
158+
159+
```
160+
GET /regencies/{regencyCode}/islands
161+
```
162+
163+
- Use this endpoint to **get all islands in a regency**.
164+
- The `{regencyCode}` must be **4 numeric characters**. If not, you will get `400 Bad Request` response.
165+
- This endpoint **will return** the array of island if the `{regencyCode}` is exists. Otherwise, you will get a `404 Not Found` response.
166+
- Usage example: http://localhost:3000/regencies/1101/islands
167+
168+
> This endpoint also support [`sortBy`][sortby-query] and [`sortOrder`][sortorder-query] queries.
169+
156170
### 7. Get Districts by Name
157171

158172
```

src/regency/regency.controller.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ export class RegencyController {
137137
description: 'The regency code',
138138
required: true,
139139
type: 'string',
140-
example: '3273',
140+
example: '1101',
141141
})
142142
@ApiQuery({
143143
name: 'sortBy',

0 commit comments

Comments
 (0)