Skip to content
Merged
Show file tree
Hide file tree
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
141 changes: 0 additions & 141 deletions src/docs/asciidoc/admin/admin.adoc

This file was deleted.

39 changes: 39 additions & 0 deletions src/docs/asciidoc/admin/auth.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
[[admin-api]]
== Admin API

[[admin-login]]
=== 어드민 로그인

어드민 계정으로 로그인합니다.

operation::admin/login[snippets='http-request,request-fields,http-response,response-fields']

[[admin-refresh]]
=== 어드민 토큰 갱신

Refresh Token을 사용하여 새로운 Access Token을 발급받습니다.

==== 유효한 토큰

operation::admin/refresh-valid-token[snippets='http-request,request-fields,http-response,response-fields']

==== 만료 임박 토큰

operation::admin/refresh-expiring-soon[snippets='http-request,request-fields,http-response,response-fields']

==== 만료된 토큰

operation::admin/refresh-expired-token[snippets='http-request,request-fields,http-response,response-fields']

==== 유효하지 않은 토큰

operation::admin/refresh-invalid-token[snippets='http-request,request-fields,http-response,response-fields']

[[admin-logout]]
=== 어드민 로그아웃

어드민 계정을 로그아웃하고 Refresh Token을 삭제합니다.

* Authorization 헤더에 Access Token이 필요합니다.

operation::admin/logout[snippets='http-request,request-headers,http-response,response-fields']
5 changes: 4 additions & 1 deletion src/docs/asciidoc/admin/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,7 @@ endif::[]

include::../shared/overview.adoc[]

include::admin.adoc[]
include::auth.adoc[]
include::management.adoc[]
include::location.adoc[]
include::notice.adoc[]
63 changes: 63 additions & 0 deletions src/docs/asciidoc/admin/location.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
[[admin-location]]
== 지역 관리

[[country-list]]
=== 나라 목록 조회

나라 목록을 조회합니다.

* SUPER_ADMIN 또는 ADMIN 또는 VIEWER 권한이 필요합니다.

operation::admin/get-countries[snippets='http-request,request-headers,http-response,response-fields']

[[city-list]]
=== 도시 목록 조회

나라별 도시 목록을 페이징하여 조회합니다.

* SUPER_ADMIN 또는 ADMIN 또는 VIEWER 권한이 필요합니다.
* keyword 입력 시 한글명, 영문명으로 검색됩니다.
* 우선순위 오름차순, 우선순위 없는 도시는 이름 오름차순으로 정렬됩니다.
* 페이지 번호는 1부터 시작합니다.
* 기본 페이지 크기는 10이며, 최대 30까지 가능합니다.

operation::admin/get-cities[snippets='http-request,request-headers,query-parameters,http-response,response-fields']

[[city-create]]
=== 도시 추가

도시를 추가합니다.

* SUPER_ADMIN 또는 ADMIN 권한이 필요합니다.

operation::admin/create-city[snippets='http-request,request-headers,request-fields,http-response,response-fields']

[[city-delete]]
=== 도시 삭제

도시를 삭제합니다.

* SUPER_ADMIN 또는 ADMIN 권한이 필요합니다.

operation::admin/delete-city[snippets='http-request,request-headers,path-parameters,http-response,response-fields']

[[city-priority]]
=== 도시 우선순위 설정

도시의 검색 우선순위를 설정합니다.

* SUPER_ADMIN 또는 ADMIN 권한이 필요합니다.
* priority 미입력 시 우선순위가 초기화됩니다.
* 우선순위는 1 이상이어야 합니다.
* 같은 국가 내에서 우선순위가 중복되지 않도록 자동으로 조정됩니다.

operation::admin/update-city-priority[snippets='http-request,request-headers,path-parameters,query-parameters,http-response,response-fields']

[[city-priority-reset]]
=== 도시 우선순위 초기화

도시의 검색 우선순위를 초기화합니다.

* SUPER_ADMIN 또는 ADMIN 권한이 필요합니다.

operation::admin/reset-city-priority[snippets='http-request,request-headers,path-parameters,http-response,response-fields']
34 changes: 34 additions & 0 deletions src/docs/asciidoc/admin/management.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
[[admin-management]]
== 관리자 관리

[[admin-invite]]
=== 관리자 초대

새로운 관리자를 초대합니다.

* SUPER_ADMIN 권한이 필요합니다.
* ADMIN 또는 VIEWER 역할만 초대 가능합니다.
* SUPER_ADMIN 역할은 초대할 수 없습니다.

operation::admin/invite-admin[snippets='http-request,request-headers,request-fields,http-response,response-fields']

[[admin-list]]
=== 관리자 목록 조회

관리자 목록을 페이징하여 조회합니다.

* SUPER_ADMIN 권한이 필요합니다.
* SUPER_ADMIN 역할은 목록에 표시되지 않습니다.
* 페이지 번호는 1부터 시작합니다.
* 기본 페이지 크기는 10이며, 최대 30까지 가능합니다.

operation::admin/get-admins[snippets='http-request,request-headers,query-parameters,http-response,response-fields']

[[admin-delete]]
=== 관리자 삭제

관리자를 삭제합니다.

* SUPER_ADMIN 권한이 필요합니다.

operation::admin/delete-admin[snippets='http-request,request-headers,path-parameters,http-response,response-fields']
72 changes: 72 additions & 0 deletions src/docs/asciidoc/admin/notice.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
[[admin-notice-api]]
== 공지사항 관리

[[admin-notice-register]]
=== 공지사항 등록

공지사항을 등록합니다.

* ADMIN 권한이 필요합니다.
* multipart/form-data 형식으로 전송됩니다.
* 파일은 선택사항입니다.

operation::admin/notice/register[snippets='http-request,request-parts,request-part-notice-fields,http-response,response-fields']

[[admin-notice-update]]
=== 공지사항 수정

공지사항을 수정합니다.

* ADMIN 권한이 필요합니다.
* multipart/form-data 형식으로 전송됩니다.
* deleteFileIds: 삭제할 파일 ID 목록 (JSON array)
* newFiles: 새로 추가할 파일

operation::admin/notice/update[snippets='http-request,path-parameters,request-parts,request-part-notice-fields,http-response,response-fields']

[[admin-notice-activate]]
=== 공지사항 활성화

공지사항을 활성화합니다.

* ADMIN 권한이 필요합니다.

operation::admin/notice/activate[snippets='http-request,path-parameters,http-response,response-fields']

[[admin-notice-deactivate]]
=== 공지사항 비활성화

공지사항을 비활성화합니다.

* ADMIN 권한이 필요합니다.

operation::admin/notice/deactivate[snippets='http-request,path-parameters,http-response,response-fields']

[[admin-notice-delete]]
=== 공지사항 삭제

공지사항을 삭제합니다.

* ADMIN 권한이 필요합니다.
* 공지사항과 관련된 모든 파일도 함께 삭제됩니다.

operation::admin/notice/delete[snippets='http-request,path-parameters,http-response,response-fields']

[[admin-notice-get-all]]
=== 전체 공지사항 목록 조회

전체 공지사항 목록을 조회합니다.

* VIEWER 이상의 권한이 필요합니다.
* ACTIVE, INACTIVE 상태 모두 조회됩니다.

operation::admin/notice/get-all[snippets='http-request,http-response,response-fields']

[[admin-notice-get-by-id]]
=== 공지사항 상세 조회

공지사항 상세 정보를 조회합니다.

* VIEWER 이상의 권한이 필요합니다.

operation::admin/notice/get-by-id[snippets='http-request,path-parameters,http-response,response-fields']
1 change: 1 addition & 0 deletions src/docs/asciidoc/app/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,4 @@ include::ai.adoc[]
include::location.adoc[]
include::geocoding.adoc[]
include::search.adoc[]
include::notice.adoc[]
21 changes: 21 additions & 0 deletions src/docs/asciidoc/app/notice.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
[[notice-api]]
== Notice API

[[notice-get-all-active]]
=== 활성 공지사항 목록 조회

활성화된 공지사항 목록을 조회합니다.

* ACTIVE 상태의 공지사항만 조회됩니다.
* 인증이 필요하지 않습니다.

operation::notice/get-all-active[snippets='http-request,http-response,response-fields']

[[notice-get-by-id]]
=== 공지사항 상세 조회

공지사항 상세 정보를 조회합니다.

* 인증이 필요하지 않습니다.

operation::notice/get-by-id[snippets='http-request,path-parameters,http-response,response-fields']
Loading