generated from kookmin-sw/cap-template
-
Notifications
You must be signed in to change notification settings - Fork 6
/
docs.html
26 lines (25 loc) · 11.7 KB
/
docs.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>My Project - ReDoc</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="shortcut icon" href="https://fastapi.tiangolo.com/img/favicon.png">
<style>
body {
margin: 0;
padding: 0;
}
</style>
<style data-styled="" data-styled-version="4.4.1"></style>
</head>
<body>
<div id="redoc-container"></div>
<script src="https://cdn.jsdelivr.net/npm/redoc/bundles/redoc.standalone.js"> </script>
<script>
var spec = {"openapi": "3.0.2", "info": {"title": "INOBUS API", "description": "INOBUS capstone project api", "version": "1.0.0"}, "paths": {"/api/v1/organizations/": {"get": {"tags": ["organization"], "summary": "Organization List", "description": "\uc4f0\uc0d8\uc774 \uc124\uce58\ub41c \uae30\uad00\uc758 \ud3ec\uc778\ud2b8\ub85c \ub0b4\ub9bc\ucc28\uc21c\uc73c\ub85c \uc815\ub82c\ub41c \ub9ac\uc2a4\ud2b8 \uc870\ud68c", "operationId": "organization_list_api_v1_organizations__get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"title": "Response Organization List Api V1 Organizations Get", "type": "array", "items": {"$ref": "#/components/schemas/Organization"}}}}}}}}, "/api/v1/organizations/{organization}/devices": {"get": {"tags": ["organization"], "summary": "Organization Detail", "description": "\uc785\ub825\ud55c \uae30\uad00 \uc774\ub984\uc73c\ub85c \uc815\ubcf4 \uc870\ud68c", "operationId": "organization_detail_api_v1_organizations__organization__devices_get", "parameters": [{"required": true, "schema": {"title": "Organization", "type": "string"}, "name": "organization", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"title": "Response Organization Detail Api V1 Organizations Organization Devices Get", "type": "array", "items": {"$ref": "#/components/schemas/Device"}}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/v1/organizations/{organization}/users": {"get": {"tags": ["organization"], "summary": "Organization User List", "description": "\uae30\uad00\uc5d0 \uc18d\ud55c \uac1c\uc778\uc758 \ub9ac\uc2a4\ud2b8 \uc870\ud68c", "operationId": "organization_user_list_api_v1_organizations__organization__users_get", "parameters": [{"required": true, "schema": {"title": "Organization", "type": "string"}, "name": "organization", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"title": "Response Organization User List Api V1 Organizations Organization Users Get", "type": "array", "items": {"$ref": "#/components/schemas/UserOut"}}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/v1/devices/": {"get": {"tags": ["devices"], "summary": "Deivce List", "description": "\ubaa8\ub4e0 \uc4f0\uc0d8 \uae30\uae30\uc758 \ub9ac\uc2a4\ud2b8 \uc870\ud68c", "operationId": "deivce_list_api_v1_devices__get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"title": "Response Deivce List Api V1 Devices Get", "type": "array", "items": {"$ref": "#/components/schemas/Device"}}}}}}}}, "/api/v1/devices/nearby": {"get": {"tags": ["devices"], "summary": "Device Nearby List", "description": "\uc0ac\uc6a9\uc790 \uadfc\ucc98 \uc4f0\uc0d8 \ub9ac\uc2a4\ud2b8 \ubc18\ud658", "operationId": "device_nearby_list_api_v1_devices_nearby_get", "parameters": [{"required": true, "schema": {"title": "Latitude", "type": "number"}, "name": "latitude", "in": "query"}, {"required": true, "schema": {"title": "Longitude", "type": "number"}, "name": "longitude", "in": "query"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"title": "Response Device Nearby List Api V1 Devices Nearby Get", "type": "array", "items": {"$ref": "#/components/schemas/Device"}}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/v1/users/{uid}": {"get": {"tags": ["users"], "summary": "User Detail", "description": "\uc0ac\uc6a9\uc790 \uc2dd\ubcc4\uc790 \uae30\ubc18 \uc0ac\uc6a9\uc790 \ud3ec\uc778\ud2b8 \uc815\ubcf4 \ubc18\ud658", "operationId": "user_detail_api_v1_users__uid__get", "parameters": [{"required": true, "schema": {"title": "Uid", "type": "string"}, "name": "uid", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UserOut"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/v1/users/{uid}/tickets": {"get": {"tags": ["users"], "summary": "User Tickets", "description": "\uc0ac\uc6a9\uc790 \uc2dd\ubcc4\uc790 \uae30\ubc18 \ud604\uc7ac\ub2ec\uc758 \ucd94\ucca8\uad8c \ubcf4\uc720\ub7c9 \ubc18\ud658", "operationId": "user_tickets_api_v1_users__uid__tickets_get", "parameters": [{"required": true, "schema": {"title": "Uid", "type": "string"}, "name": "uid", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UserTicket"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/v1/users/{uid}/history": {"get": {"tags": ["users"], "summary": "User History", "description": "\uc720\uc800\uac00 \uc6d4\ubcc4 \ud3ec\uc778\ud2b8 \uc2e4\uc801 \uc870\ud68c(\ucd5c\uadfc 6\uac1c\uc6d4)", "operationId": "user_history_api_v1_users__uid__history_get", "parameters": [{"required": true, "schema": {"title": "Uid", "type": "string"}, "name": "uid", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/v1/rewards/insert_cup": {"post": {"tags": ["rewards"], "summary": "Insert Cup", "description": "\uc4f0\uc0d8\uae30\uae30\uc5d0 \uc7ac\ud65c\uc6a9\ucef5 \ud22c\uc785\uc2dc \ub4f1\ub85d", "operationId": "insert_cup_api_v1_rewards_insert_cup_post", "parameters": [{"required": true, "schema": {"title": "Device Id", "type": "string"}, "name": "device_id", "in": "query"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/v1/rewards/person_reward": {"post": {"tags": ["rewards"], "summary": "Person Reward", "description": "\uc4f0\uc0d8\uae30\uae30\uc5d0\uc11c \ucf54\ub4dc\ub97c \ud1b5\ud574 \ud3ec\uc778\ud2b8 \uc801\ub9bd", "operationId": "person_reward_api_v1_rewards_person_reward_post", "parameters": [{"required": true, "schema": {"title": "Device Id", "type": "string"}, "name": "device_id", "in": "query"}, {"required": true, "schema": {"title": "Uid", "type": "string"}, "name": "uid", "in": "query"}, {"required": true, "schema": {"title": "Data Id", "type": "string"}, "name": "data_id", "in": "query"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UserOut"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/ping": {"get": {"summary": "Ping", "operationId": "ping_ping_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}}}}}, "components": {"schemas": {"Device": {"title": "Device", "required": ["name", "model", "organization", "install_date", "latitude", "longitude"], "type": "object", "properties": {"_id": {"title": " Id", "type": "string"}, "name": {"title": "Name", "type": "string"}, "model": {"title": "Model", "type": "string"}, "organization": {"title": "Organization", "type": "string"}, "install_date": {"title": "Install Date", "type": "string"}, "latitude": {"title": "Latitude", "type": "number"}, "longitude": {"title": "Longitude", "type": "number"}, "location_description": {"title": "Location Description", "type": "string"}, "point": {"title": "Point", "type": "integer", "default": 0}}, "description": "\uc4f0\uc0d8 \uae30\uae30\uc758 \ud3ec\uc778\ud2b8 \ub370\uc774\ud130 \ubaa8\ub378", "example": {"_id": "60901b909232236ad8c4f0d6", "name": "\uad6d\ubbfc\uc4f0\uc0d81\ud638", "model": "model_1", "organization": "11111b909232236ad8c4f0d6", "install_date": "2021-05-23 17:48:41", "latitude": 37.61090337619938, "longitude": 126.99727816928652, "location_description": "\uad6d\ubbfc\ub300\ud559\uad50 \ubbf8\ub798\uad00 4\uce35 \uc790\uc728\uc8fc\ud589\uc2a4\ud29c\ub514\uc624 \uc55e", "point": 377}}, "HTTPValidationError": {"title": "HTTPValidationError", "type": "object", "properties": {"detail": {"title": "Detail", "type": "array", "items": {"$ref": "#/components/schemas/ValidationError"}}}}, "Organization": {"title": "Organization", "required": ["name"], "type": "object", "properties": {"_id": {"title": " Id", "type": "string"}, "name": {"title": "Name", "type": "string", "description": "\uae30\uad00\uba85"}, "point": {"title": "Point", "type": "integer", "description": "\uae30\uad00\uc758 \ub204\uc801 \ud3ec\uc778\ud2b8", "default": 0}, "homepage": {"title": "Homepage", "maxLength": 2083, "minLength": 1, "type": "string", "description": "\uae30\uad00 \ud648\ud398\uc774\uc9c0", "format": "uri"}, "phone": {"title": "Phone", "type": "string", "description": "\uae30\uad00 \uc804\ud654\ubc88\ud638"}}, "description": "\uc4f0\uc0d8 \uae30\uae30\uc758 \ud3ec\uc778\ud2b8 \ub370\uc774\ud130 \ubaa8\ub378", "example": {"_id": "60901b909232236ad8c4f0d6", "name": "\uad6d\ubbfc\ub300\ud559\uad50", "point": 0, "homepage": "http://kookmin.ac.kr/", "phone": "02-910-4114"}}, "UserOut": {"title": "UserOut", "required": ["_id", "uid", "user_name"], "type": "object", "properties": {"_id": {"title": " Id", "type": "string"}, "uid": {"title": "Uid", "type": "string", "description": "\uc0ac\uc6a9\uc790\uc758 Firebase \uc2dd\ubcc4\uc790"}, "user_name": {"title": "User Name", "type": "string", "description": "\uc0ac\uc6a9\uc790\uc758 \ub2c9\ub124\uc784"}, "point": {"title": "Point", "type": "integer", "description": "\uc720\uc800\uc758 \ub204\uc801 \ud3ec\uc778\ud2b8"}}, "description": "User Response \ubaa8\ub378", "example": {"_id": "60901b909232236ad8c4f0d6", "uid": "FUdQwmmu4gUGuEOm2UtGY0Hb9o71", "user_name": "\uc6b0\uc8fc\ucd5c\uac15\uac1c\ubc1c\uc790 \ubc15\uc815\uc12d", "point": 0}}, "UserTicket": {"title": "UserTicket", "required": ["user_name", "ticket"], "type": "object", "properties": {"user_name": {"title": "User Name", "type": "string", "description": "\uc720\uc800 \ub2c9\ub124\uc784"}, "ticket": {"title": "Ticket", "type": "integer", "description": "\uc720\uc800\uc758 \ub204\uc801 \ucd94\ucca8\uad8c"}}, "description": "User Ticket \ubaa8\ub378", "example": {"user_name": "\uc6b0\uc8fc\ucd5c\uac15\uac1c\ubc1c\uc790 \ubc15\uc815\uc12d", "ticket": 2}}, "ValidationError": {"title": "ValidationError", "required": ["loc", "msg", "type"], "type": "object", "properties": {"loc": {"title": "Location", "type": "array", "items": {"type": "string"}}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}}}}};
Redoc.init(spec, {}, document.getElementById("redoc-container"));
</script>
</body>
</html>