diff --git a/openapi.yaml b/openapi.yaml index cff4172..a11445e 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -181,24 +181,48 @@ paths: '500': $ref: '#/components/responses/InternalServerError' - /locations: + /locations/regions: get: - summary: 지역 검색 - description: 지역 정보를 검색합니다. + summary: 지역 목록 조회 + description: 시, 도 단위의 주요 행정 구역 목록을 조회합니다. tags: - locations - operationId: searchLocations + operationId: getLocationRegions + responses: + '200': + description: 조회 성공 + content: + application/json: + schema: + $ref: '#/components/schemas/GetLocationRegionsResponse' + '500': + $ref: '#/components/responses/InternalServerError' + + /locations/{regionName}: + get: + summary: 지역 목록 조회 + description: 시, 도 단위의 주요 지역을 기반으로 지역을 조회합니다. + tags: + - locations + operationId: getLocationsByRegion parameters: - - $ref: '#/components/parameters/NameQuery' - - $ref: '#/components/parameters/NextQuery' - - $ref: '#/components/parameters/LimitQuery' + - in: path + name: regionName + required: true + schema: + type: string + description: 조회할 지역의 시, 도 이름 responses: '200': - description: 지역 검색 결과 + description: 조회 성공 content: application/json: schema: - $ref: '#/components/schemas/SearchLocationsResponse' + type: array + items: + $ref: '#/components/schemas/Location' + '404': + $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' @@ -660,20 +684,11 @@ components: - refreshToken - expiresIn - SearchLocationsResponse: - type: object - properties: - locations: - type: array - items: - $ref: '#/components/schemas/Location' - next: - type: string - format: uuid - description: 다음 페이지를 위한 키, 더 이상 결과가 없으면 null - required: - - locations - description: 위치 정보 리스트 응답 + GetLocationRegionsResponse: + type: array + items: + type: string + example: [ "서울", "경기" ] Location: type: object @@ -684,7 +699,7 @@ components: example: "0191cd0e-a061-7213-b39e-51274c1e7c71" region: type: string - example: "서울특별시" + example: "서울" subRegion: type: string example: "종로구"