Skip to content

Commit

Permalink
Update outdated Swagger document: Add query parameters for area, alti…
Browse files Browse the repository at this point in the history
…tude, province, and district in provinces, districts, neighborhoods, and villages endpoints
  • Loading branch information
ubeydeozdmr committed Nov 3, 2024
1 parent 5c8a653 commit c33e45d
Showing 1 changed file with 100 additions and 0 deletions.
100 changes: 100 additions & 0 deletions src/v1/routes.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,26 @@ const router = express.Router();
* schema:
* type: number
* - in: query
* name: minArea
* description: The minimum area of the province.
* schema:
* type: number
* - in: query
* name: maxArea
* description: The maximum area of the province.
* schema:
* type: number
* - in: query
* name: minAltitude
* description: The minimum altitude of the province.
* schema:
* type: number
* - in: query
* name: maxAltitude
* description: The maximum altitude of the province.
* schema:
* type: number
* - in: query
* name: isMetropolitan
* description: The province is metropolitan or not.
* schema:
Expand Down Expand Up @@ -400,6 +420,26 @@ router.get('/provinces/:id', controller.getExactProvince);
* schema:
* type: number
* - in: query
* name: minArea
* description: The minimum area of the district.
* schema:
* type: number
* - in: query
* name: maxArea
* description: The maximum area of the district.
* schema:
* type: number
* - in: query
* name: provinceId
* description: The province ID.
* schema:
* type: number
* - in: query
* name: province
* description: The province name.
* schema:
* type: string
* - in: query
* name: offset
* description: The offset of the districts list.
* schema:
Expand Down Expand Up @@ -620,6 +660,26 @@ router.get('/districts/:id', controller.getExactDistrict);
* schema:
* type: number
* - in: query
* name: provinceId
* description: The province ID.
* schema:
* type: number
* - in: query
* name: province
* description: The province name.
* schema:
* type: string
* - in: query
* name: districtId
* description: The district ID.
* schema:
* type: number
* - in: query
* name: district
* description: The district name.
* schema:
* type: string
* - in: query
* name: offset
* description: The offset of the neighborhoods list.
* schema:
Expand Down Expand Up @@ -818,6 +878,26 @@ router.get('/neighborhoods/:id', controller.getExactNeighborhood);
* schema:
* type: number
* - in: query
* name: provinceId
* description: The province ID.
* schema:
* type: number
* - in: query
* name: province
* description: The province name.
* schema:
* type: string
* - in: query
* name: districtId
* description: The district ID.
* schema:
* type: number
* - in: query
* name: district
* description: The district name.
* schema:
* type: string
* - in: query
* name: offset
* description: The offset of the villages list.
* schema:
Expand Down Expand Up @@ -1019,6 +1099,26 @@ router.get('/villages/:id', controller.getExactVillage);
* schema:
* type: number
* - in: query
* name: provinceId
* description: The province ID.
* schema:
* type: number
* - in: query
* name: province
* description: The province name.
* schema:
* type: string
* - in: query
* name: districtId
* description: The district ID.
* schema:
* type: number
* - in: query
* name: district
* description: The district name.
* schema:
* type: string
* - in: query
* name: offset
* description: The offset of the towns list.
* schema:
Expand Down

0 comments on commit c33e45d

Please sign in to comment.