1 line
8.5 KiB
JSON
1 line
8.5 KiB
JSON
{"openapi":"3.0.0","paths":{"/":{},"/database/type":{"get":{"operationId":"DatabaseController_findTypeList","parameters":[],"responses":{"200":{"description":""}},"tags":["dashboard"]}},"/database/data":{"get":{"operationId":"DatabaseController_findData","parameters":[{"name":"datasetType","required":true,"in":"query","schema":{"type":"string"}},{"name":"databaseId","required":true,"in":"query","schema":{"type":"number"}},{"name":"datasetId","required":true,"in":"query","schema":{"type":"number"}},{"name":"tableName","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["dashboard"]}},"/database/info/{id}":{"get":{"operationId":"DatabaseController_findOneInfo","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["dashboard"]}},"/database":{"post":{"operationId":"DatabaseController_create","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDatabaseDto"}}}},"responses":{"201":{"description":""}},"tags":["dashboard"]},"get":{"operationId":"DatabaseController_findAll","parameters":[],"responses":{"200":{"description":""}},"tags":["dashboard"]}},"/database/test":{"post":{"operationId":"DatabaseController_testConnection","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDatabaseDto"}}}},"responses":{"201":{"description":""}},"tags":["dashboard"]}},"/database/execute":{"post":{"operationId":"DatabaseController_executeQuery","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryExecuteDto"}}}},"responses":{"201":{"description":""}},"tags":["dashboard"]}},"/database/{id}":{"get":{"operationId":"DatabaseController_findOne","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["dashboard"]},"put":{"operationId":"DatabaseController_update","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDatabaseDto"}}}},"responses":{"200":{"description":""}},"tags":["dashboard"]},"delete":{"operationId":"DatabaseController_remove","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["dashboard"]}},"/dataset":{},"/dataset/{id}":{},"/widget":{},"/widget/{id}":{},"/dashboard":{},"/dashboard/{id}":{},"/template":{},"/template/{id}":{},"/template/recommend":{},"/template/dashboard":{},"/component/seed":{},"/component":{},"/component/{id}":{},"/user/userinfo":{"get":{"operationId":"UserController_findOne","summary":"해당유저정보 가져오기","parameters":[],"responses":{"200":{"description":""}},"tags":["유저 API"],"security":[{"AccessKey":[]}]}},"/user/change-info":{"patch":{"operationId":"UserController_updateUsername","summary":"유저정보 수정","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserDto"}}}},"responses":{"200":{"description":""}},"tags":["유저 API"],"security":[{"AccessKey":[]}]}},"/user/delete-account":{"delete":{"operationId":"UserController_deleteUser","summary":" 해당유저 삭제 ","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserDto"}}}},"responses":{"200":{"description":""}},"tags":["유저 API"],"security":[{"AccessKey":[]}]}},"/user/get-access-token":{"post":{"operationId":"UserController_reissuanceAccessToken","summary":"AccessToken 재 발급","parameters":[],"responses":{"201":{"description":""}},"tags":["유저 API"]}},"/user/get-dashboard":{"get":{"operationId":"UserController_findDashboardId","summary":"해당유정의 대시보드 목록 가져오기","parameters":[],"responses":{"200":{"description":""}},"tags":["유저 API"],"security":[{"AccessKey":[]}]}},"/login/signin":{"post":{"operationId":"LoginController_logIn","summary":" 로그인 ","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginUserDto"}}}},"responses":{"201":{"description":""}},"tags":["로그인 관련 API"]}},"/login/signup":{"post":{"operationId":"LoginController_create","summary":"회원가입","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLoginDto"}}}},"responses":{"201":{"description":""}},"tags":["로그인 관련 API"]}},"/login/signout":{"post":{"operationId":"LoginController_signOut","summary":"로그아웃","parameters":[],"responses":{"201":{"description":""}},"tags":["로그인 관련 API"]}},"/share-url/share-on/{dashboardId}":{"post":{"operationId":"ShareUrlController_checkShareUrlOn","summary":"공유 url On","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShareUrlOnDto"}}}},"responses":{"201":{"description":""}},"tags":["url공유화 API"],"security":[{"AccessKey":[]}]}},"/share-url/share-off/{dashboardId}":{"post":{"operationId":"ShareUrlController_checkShareUrlOff","summary":"공유 url Off","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShareUrlOnDto"}}}},"responses":{"201":{"description":""}},"tags":["url공유화 API"],"security":[{"AccessKey":[]}]}},"/share-url/share-dashboard/{uuid}":{"get":{"operationId":"ShareUrlController_shareDashboardInfo","summary":"공유 url 접속","parameters":[],"responses":{"200":{"description":""}},"tags":["url공유화 API"]}}},"info":{"title":"NestJS Study API Docs","description":"NestJS Study API description","version":"1.0.0","contact":{}},"tags":[{"name":"유저 API","description":""},{"name":"url공유화 API","description":""},{"name":"로그인 관련 API","description":""},{"name":"dashboard","description":""}],"servers":[],"components":{"securitySchemes":{"AccessKey":{"scheme":"bearer","bearerFormat":"JWT","type":"http","description":"Enter jwt token","in":"header"}},"schemas":{"CreateDatabaseDto":{"type":"object","properties":{"name":{"type":"string","example":"mysql 데이터베이스","description":"데이터베이스 이름"},"description":{"type":"string","example":"상세 내용","description":"데이터베이스 상세 내용"},"connectionConfig":{"type":"string","example":"{}","description":"설정 JSON 상세"},"engine":{"type":"string","example":"mysql","description":"데이터베이스 엔진"},"type":{"type":"string","example":"mysql","description":"데이터베이스 구분"},"timezone":{"type":"string","example":"Asia/Seoul","description":"서비스 타임존"}},"required":["name","description","connectionConfig","engine","type","timezone"]},"QueryExecuteDto":{"type":"object","properties":{"id":{"type":"number","example":"1","description":"database id"},"query":{"type":"string","example":"select * from sample_table1","description":"실행 쿼리"}},"required":["id","query"]},"UpdateDatabaseDto":{"type":"object","properties":{}},"CreateDatasetDto":{"type":"object","properties":{}},"UpdateDatasetDto":{"type":"object","properties":{}},"CreateWidgetDto":{"type":"object","properties":{}},"UpdateWidgetDto":{"type":"object","properties":{}},"CreateDashboardDto":{"type":"object","properties":{}},"UpdateDashboardDto":{"type":"object","properties":{}},"CreateTemplateDto":{"type":"object","properties":{}},"UpdateTemplateDto":{"type":"object","properties":{}},"CreateComponentDto":{"type":"object","properties":{}},"UpdateComponentDto":{"type":"object","properties":{}},"UpdateUserDto":{"type":"object","properties":{"userId":{"type":"string","description":"유저Id"},"password":{"type":"string","description":"유저password"},"email":{"type":"string","description":"유저email"}}},"CreateUserDto":{"type":"object","properties":{"userId":{"type":"string","description":"유저Id"},"password":{"type":"string","description":"유저password"},"email":{"type":"string","description":"유저email"}},"required":["userId","password","email"]},"LoginUserDto":{"type":"object","properties":{"userId":{"type":"string","description":"유저Id"},"password":{"type":"string","description":"유저password"}},"required":["userId","password"]},"CreateLoginDto":{"type":"object","properties":{}},"ShareUrlOnDto":{"type":"object","properties":{"userId":{"type":"string","description":"유저Id"},"endDate":{"type":"string","description":"공유 url 공유기간"}},"required":["userId","endDate"]}}}} |