Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[어드민] 장소 & 건물 정보 삭제 API 추가 #238

Closed
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
161 changes: 161 additions & 0 deletions api-admin/api-spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ defaultContentType: application/json

tags:
- name: challenge
- name: accessibility

paths:
/login:
Expand Down Expand Up @@ -298,6 +299,71 @@ paths:
responses:
'204': {}

/admin/accessibilities/search:
get:
parameters:
- in: query
name: placeName
schema:
type: string
required: false
- in: query
name: cursor
schema:
type: string
required: false
- in: query
name: limit
description: default 값은 20으로 설정된다.
schema:
type: string
required: false
operationId: searchAccessibilities
summary: 장소 & 건물 정보를 검색한다.
tags:
- accessibility
responses:
'200':
description: 검색 성공
content:
application/json:
schema:
$ref: '#/components/schemas/AdminSearchAccessibilitiesResultDTO'

/admin/place-accessibilities/{id}:
parameters:
- in: path
name: id
schema:
type: string
required: true

delete:
operationId: deletePlaceAccessibility
summary: 장소 정보를 삭제한다.
tags:
- accessibility
responses:
204:
description: 삭제 성공

/admin/building-accessibilities/{id}:
parameters:
- in: path
name: id
schema:
type: string
required: true

delete:
operationId: deleteBuildingAccessibility
summary: 건물 정보를 삭제한다.
tags:
- accessibility
responses:
204:
description: 삭제 성공

components:
# Reusable schemas (data models)
schemas:
Expand Down Expand Up @@ -558,3 +624,98 @@ components:
- milestones
- conditions
- description

AdminSearchAccessibilitiesResultDTO:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/AdminAccessibilityDTO'
cursor:
type: string
description: 없으면 다음 페이지가 없다는 의미.
required:
- items

AdminAccessibilityDTO:
type: object
properties:
placeAccessibility:
$ref: '#/components/schemas/AdminPlaceAccessibilityDTO'
buildingAccessibility:
$ref: '#/components/schemas/AdminBuildingAccessibilityDTO'
required:
- placeAccessibility

AdminPlaceAccessibilityDTO:
type: object
properties:
id:
type: string
isFirstFloor:
type: boolean
stairInfo:
$ref: '#/components/schemas/AdminStairInfoDTO'
hasSlope:
type: boolean
imageUrls:
type: array
items:
type: string
placeName:
type: string
registeredUserName:
type: string
description: 익명으로 등록되었으면 null.
required:
- id
- isFirstFloor
- stairInfo
- hasSlope
- placeName
- imageUrls

AdminBuildingAccessibilityDTO:
type: object
properties:
id:
type: string
entranceStairInfo:
$ref: '#/components/schemas/AdminStairInfoDTO'
entranceImageUrls:
type: array
items:
type: string
hasSlope:
type: boolean
hasElevator:
type: boolean
elevatorStairInfo:
$ref: '#/components/schemas/AdminStairInfoDTO'
elevatorImageUrls:
type: array
items:
type: string
buildingName:
type: string
registeredUserName:
type: string
description: 익명으로 등록되었으면 null.
required:
- id
- entranceStairInfo
- entranceImageUrls
- hasSlope
- hasElevator
- elevatorStairInfo
- elevatorImageUrls

AdminStairInfoDTO:
type: string
enum:
- UNDEFINED # e.g. 엘리베이터가 아예 없는 경우, 엘리베이터 계단 정보는 UNDEFINED로 올린다.
- NONE
- ONE
- TWO_TO_FIVE
- OVER_SIX
Loading