Skip to content

Commit

Permalink
중복된 API spec 제거
Browse files Browse the repository at this point in the history
  • Loading branch information
Zeniuus committed Nov 3, 2023
1 parent d487349 commit e0d6c97
Showing 1 changed file with 0 additions and 179 deletions.
179 changes: 0 additions & 179 deletions app-server/subprojects/api/scc-api/api-spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -436,185 +436,6 @@ paths:
에러 코드 설명
- INVALID_AUTHENTICATION : kakaoTokens 중 일부가 잘못된 경우.
/giveBuildingAccessibilityUpvote:
post:
summary: "'이 정보가 도움이 돼요'를 준다."
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GiveBuildingAccessibilityUpvoteRequestDto'
responses:
'204': { }

/listAdministrativeAreas:
post:
summary: 점포를 검색한다.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties: { }
responses:
'200':
content:
application/json:
schema:
properties:
eupMyeonDongs:
items:
$ref: '#/components/schemas/EupMyeonDong'
type: array
siGunGus:
items:
$ref: '#/components/schemas/SiGunGu'
type: array
type: object

/listConqueredPlaces:
post:
summary: 내가 정복한 장소 목록을 조회한다.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListConqueredPlacesRequestDto'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListConqueredPlacesResponseDto'

/listPlacesInBuilding:
post:
summary: 특정 건물의 점포를 조회한다.
description: "'이 건물에 다른 점포 등록하기'를 눌렀을 때 호출된다."
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
buildingId:
type: string
required:
- buildingId
responses:
'200':
content:
application/json:
schema:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/PlaceListItem'
required:
- items

/listSearchKeywordsOfPlaceCategory:
post:
summary: 특정 카테고리의 점포들을 검색할 수 있게 키워드들을 내려준다.
description: "음식점, 카페, 편의점, 병원 같이 키워드를 내려주면 searchPlaces 키워드로 쓸 수 있습니다."
requestBody:
required: true
content:
application/json:
schema:
type: object
properties: { }
responses:
'200':
content:
application/json:
schema:
properties:
items:
items:
$ref: '#/components/schemas/SearchKeywordOfPlaceCategoryDto'
type: array
required:
- items
type: object

/login:
post:
summary: 로그인을 한다.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
nickname:
type: string
password:
type: string
required:
- nickname
- password
responses:
'204':
description: |
빈 response body를 내려준다.
대신 Header의 X-SCC-ACCESS-KEY에 access token을 내려준다. (회원가입하면 자동 로그인)
클라이언트는 이 토큰을 Bearer auth의 토큰으로 사용하면 된다.
/loginWithApple:
post:
summary: 애플 로그인을 통해 로그인 or 회원가입을 한다.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/LoginWithAppleRequestDto'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LoginResultDto'
'400':
$ref: '#/components/responses/ApiFailure'
description: |-
에러 코드 설명
- INVALID_AUTHENTICATION : 클라이언트에서 올려준 토큰 중 일부가 잘못된 경우.
/loginWithKakao:
post:
summary: 카카오 로그인을 통해 로그인 or 회원가입을 한다.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
kakaoTokens:
$ref: '#/components/schemas/KakaoTokensDto'
required:
- kakaoTokens
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LoginResultDto'
'400':
$ref: '#/components/responses/ApiFailure'
description: |-
에러 코드 설명
- INVALID_AUTHENTICATION : kakaoTokens 중 일부가 잘못된 경우.
/registerAccessibility:
post:
summary: 건물 & 점포의 접근성 정보를 등록한다.
Expand Down

0 comments on commit e0d6c97

Please sign in to comment.