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

Stair-Crusher-Club · Mar 13, 2024 · 7097571 · 7097571
1 parent ffd7ad2
commit 7097571
Showing 1 changed file with 196 additions and 0 deletions.
diff --git a/api-admin/api-spec.yaml b/api-admin/api-spec.yaml
@@ -9,6 +9,7 @@ defaultContentType: application/json
 
 tags:
   - name: challenge
+  - name: accessibility
 
 paths:
   /login:
@@ -298,6 +299,102 @@ paths:
       responses:
         '204': {}
 
+  /place-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: searchPlaceAccessibility
+      summary: 장소 정보를 검색한다.
+      tags:
+        - accessibility
+      responses:
+        '200':
+          description: 검색 성공
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AdminSearchPlaceAccessibilityResultDTO'
+
+  /place-accessibilities/{id}:
+    parameters:
+      - in: path
+        name: id
+        schema:
+          type: string
+        required: true
+
+    delete:
+      operationId: deletePlaceAccessibility
+      summary: 장소 정보를 삭제한다.
+      tags:
+        - accessibility
+      responses:
+        204:
+          description: 삭제 성공
+
+  /building-accessibilities/search:
+    get:
+      parameters:
+        - in: query
+          name: buildingName
+          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: searchBuildingAccessibility
+      summary: 건물 정보를 검색한다.
+      tags:
+        - accessibility
+      responses:
+        '200':
+          description: 검색 성공
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AdminSearchBuildingAccessibilityResultDTO'
+
+  /building-accessibilities/{id}:
+    parameters:
+      - in: path
+        name: id
+        schema:
+          type: string
+        required: true
+
+    delete:
+      operationId: deletePlaceAccessibility
+      summary: 건물 정보를 삭제한다.
+      tags:
+        - accessibility
+      responses:
+        204:
+          description: 삭제 성공
+
 components:
   # Reusable schemas (data models)
   schemas:
@@ -558,3 +655,102 @@ components:
         - milestones
         - conditions
         - description
+
+    AdminSearchPlaceAccessibilityResultDTO:
+      type: object
+      properties:
+        items:
+          type: array
+          items:
+            $ref: '#/components/schemas/AdminPlaceAccessibilityDTO'
+        cursor:
+          type: string
+          description: 없으면 다음 페이지가 없다는 의미.
+      required:
+        - items
+
+    AdminStairInfoDTO:
+      type: string
+      enum:
+        - UNDEFINED # e.g. 엘리베이터가 아예 없는 경우, 엘리베이터 계단 정보는 UNDEFINED로 올린다.
+        - NONE
+        - ONE
+        - TWO_TO_FIVE
+        - OVER_SIX
+
+    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
+
+    AdminSearchBuildingAccessibilityResultDTO:
+      type: object
+      properties:
+        items:
+          type: array
+          items:
+            $ref: '#/components/schemas/AdminBuildingAccessibilityDTO'
+        cursor:
+          type: string
+          description: 없으면 다음 페이지가 없다는 의미.
+      required:
+        - items
+
+    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
+        - buildingName