Skip to content

Commit

Permalink
chore: 카테고리 변경 내용을 문서에도 반영!
Browse files Browse the repository at this point in the history
  • Loading branch information
potados99 committed Nov 27, 2022
1 parent 31aaabe commit 0c09f3c
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 6 deletions.
7 changes: 2 additions & 5 deletions SWAGGERDOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,8 @@ INU 행사 알림/신청 플랫폼 **유니레터** 서버입니다.
> - 알림 설정 목록(`GET /notification`)을 제외한 모든 이벤트를 내려주는 라우터는 페이징이 적용되었습니다.
> - 페이지 관련 변수 `pageNum`, `pageSize` 둘 중에 하나라도 비어있으면 전체 이벤트를 내려줍니다. (하위 버전 호환)
`pageNum` 는 0부터 시작합니다.
> - categoryId : `선택없음:0` `동아리/소모임:1` `학생회:2` `간식나눔:3` `대회/공모전:4` `스터디:5` `구인:6` `기타:7`
> ( `선택없음`으로 작성된 글은 거의 없거나 중요하지 않으므로, tagList 가장 우측에 배치하는 것이 좋아보입니다! )


> - categoryId : `모두선택:0` `동아리/소모임:1` `학생회:2` `간식나눔:3` `대회/공모전:4` `스터디:5` `구인:6` `기타:7` `교육/강연:8`
> ( `모두선택`은 카테고리 관계없이 모든 카테고리의 글을 가져옵니다. )
<details>
<summary> <h2> ⭐ 개발 팁</h2> </summary>
Expand Down
2 changes: 1 addition & 1 deletion src/server/routes/events/getCategorybyFiltering.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import {EventResponseScheme} from '../../../entity/schemes';
const schema = defineSchema({
tags: ['히히'],
summary: '카테고리 별로 필터링해서 가져옵니다',
description: ' - categoryId : `선택없음:0` `동아리/소모임:1` `학생회:2` `간식나눔:3` `대회/공모전:4` `스터디:5` `구인:6` `기타:7`\n'+
description: ' - categoryId : `모두선택:0` `동아리/소모임:1` `학생회:2` `간식나눔:3` `대회/공모전:4` `스터디:5` `구인:6` `기타:7` `교육/강연:8` \n'+
` - eventStatus : true 일 경우 해당 카테고리 중애서 진행 중인 이벤트만 가져옴, false 일 경우 진행 중인 이벤트와 상관없이 해당 카테고리 이벤트 다 가져옴\n`+
` - 페이징 적용(/get events 참고)`,

Expand Down

0 comments on commit 0c09f3c

Please sign in to comment.