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

[feat] 즐길거리, 먹거리에 대한 스타디움명 문서를 수정한다. #101

Merged
merged 1 commit into from
Nov 28, 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
61 changes: 31 additions & 30 deletions src/main/resources/static/docs/open-api-3.0.1.json
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@
},
"examples" : {
"chatbot/guide" : {
"value" : "{\n \"isSuccess\" : true,\n \"code\" : \"200\",\n \"message\" : \"가이드 챗봇 답변을 가져오는 데 성공했습니다.\",\n \"payload\" : {\n \"answer\" : \"각 구장에 위치한 굿즈샵에서 원하는 응원 도구를 구매할 수 있어요!\\n잠실 야구장의 경우, 지하철 2호선 '종합운동장역' 6번 출구 앞에 위치한 야구 용품샵 '유니크 스포츠'를 이용할 수 있어요! 홈팀인 엘지 트윈스와 두산 베어스의 굿즈 뿐만 아니라, 원정팀들의 굿즈도 있으니 한 번 방문해보세요!\\n종합운동장역을 나가기 전, 역사에 위치한 ‘라커디움파크 종합운동장역점’에서도 굿즈를 판매 중이에요!\",\n \"imgUrl\" : null,\n \"linkName\" : null,\n \"link\" : null\n }\n}"
"value" : "{\n \"isSuccess\" : true,\n \"code\" : \"200\",\n \"message\" : \"가이드 챗봇 답변을 가져오는 데 성공했습니다.\",\n \"payload\" : {\n \"answers\" : [ \"각 구장에 위치한 굿즈샵에서 원하는 응원 도구를 구매할 수 있어요!\", \"잠실 야구장의 경우, 지하철 2호선 '종합운동장역' 6번 출구 앞에 위치한 야구 용품샵 '유니크 스포츠'를 이용할 수 있어요! 홈팀인 엘지 트윈스와 두산 베어스의 굿즈 뿐만 아니라, 원정팀들의 굿즈도 있으니 한 번 방문해보세요!\", \"종합운동장역을 나가기 전, 역사에 위치한 ‘라커디움파크 종합운동장역점’에서도 굿즈를 판매 중이에요!\" ],\n \"imgUrl\" : null\n }\n}"
}
}
}
Expand Down Expand Up @@ -1064,37 +1064,22 @@
}
}
},
"GetGuideChatbotAnswerResponse" : {
"title" : "GetGuideChatbotAnswerResponse",
"required" : [ "code", "isSuccess", "message", "payload" ],
"SaveTopRankedZoneResponseDto" : {
"title" : "SaveTopRankedZoneResponseDto",
"required" : [ "code", "isSuccess", "message" ],
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "응답 코드"
},
"payload" : {
"required" : [ "answer" ],
"required" : [ "resultId" ],
"type" : "object",
"properties" : {
"imgUrl" : {
"type" : "string",
"description" : "이미지 URL",
"nullable" : true
},
"answer" : {
"type" : "string",
"description" : "답변"
},
"link" : {
"type" : "string",
"description" : "링크 URL",
"nullable" : true
},
"linkName" : {
"type" : "string",
"description" : "링크 버튼 이름",
"nullable" : true
"resultId" : {
"type" : "number",
"description" : "저장된 결과 ID"
}
},
"description" : "응답 데이터"
Expand All @@ -1109,22 +1094,38 @@
}
}
},
"SaveTopRankedZoneResponseDto" : {
"title" : "SaveTopRankedZoneResponseDto",
"required" : [ "code", "isSuccess", "message" ],
"GetGuideChatbotAnswerResponse" : {
"title" : "GetGuideChatbotAnswerResponse",
"required" : [ "code", "isSuccess", "message", "payload" ],
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "응답 코드"
},
"payload" : {
"required" : [ "resultId" ],
"required" : [ "answers" ],
"type" : "object",
"properties" : {
"resultId" : {
"type" : "number",
"description" : "저장된 결과 ID"
"imgUrl" : {
"type" : "string",
"description" : "이미지 URL",
"nullable" : true
},
"answers" : {
"type" : "array",
"description" : "답변 목록",
"items" : {
"oneOf" : [ {
"type" : "object"
}, {
"type" : "boolean"
}, {
"type" : "string"
}, {
"type" : "number"
} ]
}
}
},
"description" : "응답 데이터"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ public void getSuitableEntertainments() throws Exception {
.tag("Stadium")
.description("해당 구장의 즐길거리 목록을 조회한다.")
.queryParameters(
parameterWithName("stadiumName").description("구장명 [예시 : 잠실종합운동장]"),
parameterWithName("stadiumName").description("구장명 [예시 : 잠실종합운동장 (잠실)]"),
parameterWithName("boundary").description("구장 영역 (내부 or 외부) [예시 : 내부]")
)
.responseFields(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ public void getSuitableFoods() throws Exception {
.tag("Stadium")
.description("해당 구장의 음식 목록을 조회한다.")
.queryParameters(
parameterWithName("stadiumName").description("구장명 [예시 : 잠실종합운동장]"),
parameterWithName("stadiumName").description("구장명 [예시 : 잠실종합운동장 (잠실)]"),
parameterWithName("boundary").description("구장 영역(내부 or 외부) [예시 : 내부]"),
parameterWithName("course").description("구장 코스(식사 or 후식) - 내부일때는 꼭 입력해주세요 [예시 : 후식]").optional()
)
Expand Down

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Loading