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

refactor: admin 라벨링 코드 제거 #174

Merged
merged 2 commits into from
Jan 14, 2024
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
239 changes: 0 additions & 239 deletions src/docs/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1600,245 +1600,6 @@ include::{snippets}/admin/problems/deleteMany/request-fields.adoc[]
include::{snippets}/admin/problems/deleteMany/response-body.adoc[]
include::{snippets}/admin/problems/deleteMany/response-fields.adoc[]


=== UserAnswer API ( /api/admin/user-answers, /api/admin/user-answer )

==== 유저 응답 단일 생성

.description
[source]
----
하나의 유저 응답을 생성하기 위한 API입니다.

HTTP Method : POST
End-Point : /api/admin/user-answer
----

.Sample Request
include::{snippets}/admin/userAnswer/createOne/http-request.adoc[]

.Sample Response
include::{snippets}/admin/userAnswer/createOne/http-response.adoc[]

.Request Body
include::{snippets}/admin/userAnswer/createOne/request-body.adoc[]
include::{snippets}/admin/userAnswer/createOne/request-fields.adoc[]

.Response Body
include::{snippets}/admin/userAnswer/createOne/response-body.adoc[]
include::{snippets}/admin/userAnswer/createOne/response-fields.adoc[]

==== 유저 응답 생성

.description
[source]
----
여러 개의 유저 응답을 생성하기 위한 API입니다.

HTTP Method : POST
End-Point : /api/admin/user-answers
----

.Sample Request
include::{snippets}/admin/userAnswer/createMany/http-request.adoc[]

.Sample Response
include::{snippets}/admin/userAnswer/createMany/http-response.adoc[]

.Request Body
include::{snippets}/admin/userAnswer/createMany/request-body.adoc[]
include::{snippets}/admin/userAnswer/createMany/request-fields.adoc[]

.Response Body
include::{snippets}/admin/userAnswer/createMany/response-body.adoc[]
include::{snippets}/admin/userAnswer/createMany/response-fields.adoc[]

==== 유저 응답 단건 조회

.description
[source]
----
유저 응답 단건 조회를 위한 API입니다.

HTTP Method : GET
End-Point : /api/admin/user-answers/{user_answer_id: Long}
----

.Sample Request
include::{snippets}/admin/userAnswer/findOne/http-request.adoc[]

.Sample Response
include::{snippets}/admin/userAnswer/findOne/http-response.adoc[]

.Path parameters
include::{snippets}/admin/userAnswer/findOne/path-parameters.adoc[]

유저 답안 조회를 위한 path parameter의 설명입니다.

.Response Body
include::{snippets}/admin/userAnswer/findOne/response-body.adoc[]
include::{snippets}/admin/userAnswer/findOne/response-fields.adoc[]

==== 유저 답안 검색

.description
[source]
----
유저 답안 검색을 위한 API입니다.

HTTP Method : GET
End-Point : /api/admin/user-answers
Req Params : id, assignedBy, validatedBy, problemTitle, answer, isLabeled, isValidated, size, page
----

.Sample Request
include::{snippets}/admin/userAnswer/search/http-request.adoc[]

.Sample Response
include::{snippets}/admin/userAnswer/search/http-response.adoc[]

.Request parameters

유저 답안 검색을 위한 request parameter의 설명입니다.
include::{snippets}/admin/userAnswer/search/request-parameters.adoc[]


.Response Body
include::{snippets}/admin/userAnswer/search/response-body.adoc[]
include::{snippets}/admin/userAnswer/search/response-fields.adoc[]

==== 유저 답안 라벨링

.description
[source]
----
유저 답안 라벨링을 위한 API입니다.

HTTP Method : POST
End-Point : /api/admin/user-answers/{user_answer_id: Long}/label
----

.Sample Request
include::{snippets}/admin/userAnswer/label/http-request.adoc[]

.Sample Response
include::{snippets}/admin/userAnswer/label/http-response.adoc[]

.Path parameters
include::{snippets}/admin/userAnswer/label/path-parameters.adoc[]

유저 답안 라벨링을 위한 path parameter의 설명입니다.

.Request Body
include::{snippets}/admin/userAnswer/label/request-body.adoc[]
include::{snippets}/admin/userAnswer/label/request-fields.adoc[]

.Response Body
include::{snippets}/admin/userAnswer/label/response-body.adoc[]
include::{snippets}/admin/userAnswer/label/response-fields.adoc[]

==== 유저 답안 검수

.description
[source]
----
유저 답안 검수를 위한 API입니다.

HTTP Method : POST
End-Point : /api/admin/user-answers/{user_answer_id: Long}/validate
----

.Sample Request
include::{snippets}/admin/userAnswer/validate/http-request.adoc[]

.Sample Response
include::{snippets}/admin/userAnswer/validate/http-response.adoc[]

.Path parameters
include::{snippets}/admin/userAnswer/validate/path-parameters.adoc[]

유저 답안 검수를 위한 path parameter의 설명입니다.

.Request Body
include::{snippets}/admin/userAnswer/validate/request-body.adoc[]
include::{snippets}/admin/userAnswer/validate/request-fields.adoc[]

.Response Body
include::{snippets}/admin/userAnswer/validate/response-body.adoc[]
include::{snippets}/admin/userAnswer/validate/response-fields.adoc[]

==== 유저 답안 라벨링 유저 할당

.description
[source]
----
유저 답안 라벨링 유저 할당을 위한 API입니다.

HTTP Method : PUT
End-Point : /api/admin/user-answers/assign/validate
----

.Sample Request
include::{snippets}/admin/userAnswer/assign/label/http-request.adoc[]

.Sample Response
include::{snippets}/admin/userAnswer/assign/label/http-response.adoc[]

.Request Body
include::{snippets}/admin/userAnswer/assign/label/request-body.adoc[]
include::{snippets}/admin/userAnswer/assign/label/request-fields.adoc[]

.Response Body
include::{snippets}/admin/userAnswer/assign/label/response-body.adoc[]
include::{snippets}/admin/userAnswer/assign/label/response-fields.adoc[]


==== 유저 답안 검수자 할당

.description
[source]
----
유저 답안 검수자 할당을 위한 API입니다.

HTTP Method : PUT
End-Point : /api/admin/user-answers/assign/validate
----

.Sample Request
include::{snippets}/admin/userAnswer/assign/validate/http-request.adoc[]

.Sample Response
include::{snippets}/admin/userAnswer/assign/validate/http-response.adoc[]

.Request Body
include::{snippets}/admin/userAnswer/assign/validate/request-body.adoc[]
include::{snippets}/admin/userAnswer/assign/validate/request-fields.adoc[]

.Response Body
include::{snippets}/admin/userAnswer/assign/validate/response-body.adoc[]
include::{snippets}/admin/userAnswer/assign/validate/response-fields.adoc[]

==== 유저 응답 삭제

.description
[source]
----
하나의 유저 응답을 삭제하기 위한 API입니다.

HTTP Method : DELETE
End-Point : /api/admin/user-answers/{user_answer_id: Long}
----

.Sample Request
include::{snippets}/admin/userAnswer/deleteOne/http-request.adoc[]

.Sample Response
include::{snippets}/admin/userAnswer/deleteOne/http-response.adoc[]

.Response Body
include::{snippets}/admin/userAnswer/deleteOne/response-body.adoc[]
include::{snippets}/admin/userAnswer/deleteOne/response-fields.adoc[]

=== User API ( /api/admin/users )

==== ADMIN 유저 조회
Expand Down

This file was deleted.

Loading