From 3f574b135a36541204c16bb00ae054ef5cf003f9 Mon Sep 17 00:00:00 2001 From: ysh Date: Fri, 20 Sep 2024 16:53:16 +0900 Subject: [PATCH] api-docs.json update --- api-docs.json | 705 +++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 635 insertions(+), 70 deletions(-) diff --git a/api-docs.json b/api-docs.json index 1712732..35205ab 100644 --- a/api-docs.json +++ b/api-docs.json @@ -5,7 +5,9 @@ "version": "1.0", "title": "Api Documentation", "termsOfService": "urn:tos", - "contact": {}, + "contact": { + + }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0" @@ -34,6 +36,10 @@ "name": "open-api-web-mvc-resource", "description": "Open Api Web Mvc Resource" }, + { + "name": "event-listener-controller", + "description": "Event Listener Controller" + }, { "name": "workflow-history-controller", "description": "Workflow History Controller" @@ -65,19 +71,22 @@ "tags": [ "basic-error-controller" ], - "summary": "errorHtml", - "operationId": "errorHtmlUsingGET", + "summary": "error", + "operationId": "errorUsingGET", "consumes": [ "application/json" ], "produces": [ - "text/html" + "*/*" ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ModelAndView" + "type": "object", + "additionalProperties": { + "type": "object" + } } }, "401": { @@ -95,19 +104,22 @@ "tags": [ "basic-error-controller" ], - "summary": "errorHtml", - "operationId": "errorHtmlUsingHEAD", + "summary": "error", + "operationId": "errorUsingHEAD", "consumes": [ "application/json" ], "produces": [ - "text/html" + "*/*" ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ModelAndView" + "type": "object", + "additionalProperties": { + "type": "object" + } } }, "401": { @@ -125,19 +137,22 @@ "tags": [ "basic-error-controller" ], - "summary": "errorHtml", - "operationId": "errorHtmlUsingPOST", + "summary": "error", + "operationId": "errorUsingPOST", "consumes": [ "application/json" ], "produces": [ - "text/html" + "*/*" ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ModelAndView" + "type": "object", + "additionalProperties": { + "type": "object" + } } }, "201": { @@ -158,19 +173,22 @@ "tags": [ "basic-error-controller" ], - "summary": "errorHtml", - "operationId": "errorHtmlUsingPUT", + "summary": "error", + "operationId": "errorUsingPUT", "consumes": [ "application/json" ], "produces": [ - "text/html" + "*/*" ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ModelAndView" + "type": "object", + "additionalProperties": { + "type": "object" + } } }, "201": { @@ -191,19 +209,22 @@ "tags": [ "basic-error-controller" ], - "summary": "errorHtml", - "operationId": "errorHtmlUsingDELETE", + "summary": "error", + "operationId": "errorUsingDELETE", "consumes": [ "application/json" ], "produces": [ - "text/html" + "*/*" ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ModelAndView" + "type": "object", + "additionalProperties": { + "type": "object" + } } }, "401": { @@ -221,19 +242,347 @@ "tags": [ "basic-error-controller" ], - "summary": "errorHtml", - "operationId": "errorHtmlUsingOPTIONS", + "summary": "error", + "operationId": "errorUsingOPTIONS", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "additionalProperties": { + "type": "object" + } + } + }, + "401": { + "description": "Unauthorized" + }, + "204": { + "description": "No Content" + }, + "403": { + "description": "Forbidden" + } + } + }, + "patch": { + "tags": [ + "basic-error-controller" + ], + "summary": "error", + "operationId": "errorUsingPATCH", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "additionalProperties": { + "type": "object" + } + } + }, + "401": { + "description": "Unauthorized" + }, + "204": { + "description": "No Content" + }, + "403": { + "description": "Forbidden" + } + } + } + }, + "/eventlistener": { + "post": { + "tags": [ + "event-listener-controller" + ], + "summary": "registEventListner", + "operationId": "registEventListnerUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "requestEventListenerDto", + "description": "requestEventListenerDto", + "required": true, + "schema": { + "$ref": "#/definitions/RequestEventListenerDto" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«long»" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/eventlistener/list": { + "get": { + "tags": [ + "event-listener-controller" + ], + "summary": "getEventListenerList", + "operationId": "getEventListenerListUsingGET", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«ResponseEventListenerDto»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/eventlistener/run/{eventListenerIdx}": { + "get": { + "tags": [ + "event-listener-controller" + ], + "summary": "runEventListener", + "operationId": "runEventListenerUsingGET", "consumes": [ "application/json" ], "produces": [ - "text/html" + "*/*" + ], + "parameters": [ + { + "name": "eventListenerIdx", + "in": "path", + "description": "eventListenerIdx", + "required": true, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«boolean»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/eventlistener/workflowDetail/{workflowIdx}/{evnetListenerYn}": { + "get": { + "tags": [ + "event-listener-controller" + ], + "summary": "getWorkflowDetail", + "operationId": "getWorkflowDetailUsingGET", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "name": "workflowIdx", + "in": "path", + "description": "workflowIdx", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "evnetListenerYn", + "in": "path", + "description": "evnetListenerYn", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«WorkflowDetailResDto»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/eventlistener/workflowList/{eventListenerYn}": { + "get": { + "tags": [ + "event-listener-controller" + ], + "summary": "getWorkflowList", + "operationId": "getWorkflowListUsingGET", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "name": "eventListenerYn", + "in": "path", + "description": "eventListenerYn", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«WorkflowListResDto»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/eventlistener/{eventListenerIdx}": { + "get": { + "tags": [ + "event-listener-controller" + ], + "summary": "detailEventListener", + "operationId": "detailEventListenerUsingGET", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "name": "eventListenerIdx", + "in": "path", + "description": "eventListenerIdx", + "required": true, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«ResponseEventListenerDto»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + }, + "delete": { + "tags": [ + "event-listener-controller" + ], + "summary": "deleteEventListner", + "operationId": "deleteEventListnerUsingDELETE", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "name": "eventListenerIdx", + "in": "path", + "description": "eventListenerIdx", + "required": true, + "type": "integer", + "format": "int64" + } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ModelAndView" + "$ref": "#/definitions/ResponseWrapper«boolean»" } }, "401": { @@ -249,21 +598,40 @@ }, "patch": { "tags": [ - "basic-error-controller" + "event-listener-controller" ], - "summary": "errorHtml", - "operationId": "errorHtmlUsingPATCH", + "summary": "updateEventListner", + "operationId": "updateEventListnerUsingPATCH", "consumes": [ "application/json" ], "produces": [ - "text/html" + "*/*" + ], + "parameters": [ + { + "name": "eventListenerIdx", + "in": "path", + "description": "eventListenerIdx", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "in": "body", + "name": "requestEventListenerDto", + "description": "requestEventListenerDto", + "required": true, + "schema": { + "$ref": "#/definitions/RequestEventListenerDto" + } + } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ModelAndView" + "$ref": "#/definitions/ResponseWrapper«boolean»" } }, "401": { @@ -614,7 +982,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ResponseWrapper«long»" + "$ref": "#/definitions/ResponseWrapper«boolean»" } }, "401": { @@ -675,6 +1043,38 @@ } } }, + "/ossType/filter/list": { + "get": { + "tags": [ + "oss-type-controller" + ], + "summary": "getOssTypeFilteredList", + "operationId": "getOssTypeFilteredListUsingGET", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«OssTypeDto»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, "/ossType/list": { "get": { "tags": [ @@ -823,7 +1223,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ResponseWrapper«long»" + "$ref": "#/definitions/ResponseWrapper«boolean»" } }, "401": { @@ -1052,6 +1452,13 @@ "required": true, "type": "integer", "format": "int64" + }, + { + "name": "dataType", + "in": "query", + "description": "dataType", + "required": true, + "type": "string" } ], "responses": { @@ -1079,7 +1486,7 @@ "workflow-controller" ], "summary": "getWorkflowList", - "operationId": "getWorkflowListUsingGET", + "operationId": "getWorkflowListUsingGET_1", "consumes": [ "application/json" ], @@ -1105,6 +1512,48 @@ } } }, + "/workflow/log/{workflowIdx}": { + "get": { + "tags": [ + "workflow-controller" + ], + "summary": "getWorkflowLog", + "operationId": "getWorkflowLogUsingGET", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "name": "workflowIdx", + "in": "path", + "description": "workflowIdx", + "required": true, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResponseWrapper«List«WorkflowLogResDto»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, "/workflow/name/duplicate": { "get": { "tags": [ @@ -1753,7 +2202,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ResponseWrapper«long»" + "$ref": "#/definitions/ResponseWrapper«boolean»" } }, "401": { @@ -1913,7 +2362,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ResponseWrapper«Void»" + "$ref": "#/definitions/ResponseWrapper«boolean»" } }, "401": { @@ -1962,7 +2411,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ResponseWrapper«long»" + "$ref": "#/definitions/ResponseWrapper«boolean»" } }, "401": { @@ -1979,6 +2428,28 @@ } }, "definitions": { + "WorkflowDto": { + "type": "object", + "properties": { + "ossIdx": { + "type": "integer", + "format": "int64" + }, + "script": { + "type": "string" + }, + "workflowIdx": { + "type": "integer", + "format": "int64" + }, + "workflowName": { + "type": "string" + }, + "workflowPurpose": { + "type": "string" + } + } + }, "ResponseWrapper«OssDto»": { "type": "object", "properties": { @@ -1997,44 +2468,68 @@ } } }, - "WorkflowDto": { + "WorkflowStageTypeDto": { "type": "object", "properties": { - "ossIdx": { + "workflowStageTypeDesc": { + "type": "string" + }, + "workflowStageTypeIdx": { "type": "integer", "format": "int64" }, - "script": { + "workflowStageTypeName": { "type": "string" - }, - "workflowIdx": { + } + } + }, + "ResponseWrapper«List«WorkflowListResDto»»": { + "type": "object", + "properties": { + "code": { "type": "integer", - "format": "int64" + "format": "int32" }, - "workflowName": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/WorkflowListResDto" + } + }, + "detail": { "type": "string" }, - "workflowPurpose": { + "message": { "type": "string" } } }, - "WorkflowStageTypeDto": { + "ResponseEventListenerDto": { "type": "object", "properties": { - "workflowStageTypeDesc": { + "eventListenerCallUrl": { "type": "string" }, - "workflowStageTypeIdx": { + "eventListenerDesc": { + "type": "string" + }, + "eventListenerIdx": { "type": "integer", "format": "int64" }, - "workflowStageTypeName": { + "eventListenerName": { + "type": "string" + }, + "eventListenerUrl": { "type": "string" + }, + "workflowIdx": { + "type": "integer", + "format": "int64" } } }, - "ResponseWrapper«List«WorkflowListResDto»»": { + "ResponseWrapper«List«ResponseEventListenerDto»»": { "type": "object", "properties": { "code": { @@ -2044,7 +2539,7 @@ "data": { "type": "array", "items": { - "$ref": "#/definitions/WorkflowListResDto" + "$ref": "#/definitions/ResponseEventListenerDto" } }, "detail": { @@ -2058,6 +2553,9 @@ "WorkflowParamDto": { "type": "object", "properties": { + "eventListenerYn": { + "type": "string" + }, "paramIdx": { "type": "integer", "format": "int64" @@ -2074,6 +2572,27 @@ } } }, + "ResponseWrapper«List«WorkflowLogResDto»»": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/WorkflowLogResDto" + } + }, + "detail": { + "type": "string" + }, + "message": { + "type": "string" + } + } + }, "ResponseWrapper«object»": { "type": "object", "properties": { @@ -2271,23 +2790,54 @@ "WorkflowHistoryDto": { "type": "object", "properties": { - "runDate": { + "data": { + "type": "string" + }, + "dataType": { + "type": "string" + }, + "date": { "type": "string", "format": "date-time" }, - "runScript": { + "userId": { "type": "string" }, - "runUserId": { + "workflowHistoryIdx": { + "type": "integer", + "format": "int64" + }, + "workflowIdx": { + "type": "integer", + "format": "int64" + } + } + }, + "RequestEventListenerDto": { + "type": "object", + "properties": { + "eventListenerDesc": { "type": "string" }, - "workflowHistoryIdx": { + "eventListenerIdx": { "type": "integer", "format": "int64" }, + "eventListenerName": { + "type": "string" + }, + "eventListenerUrl": { + "type": "string" + }, "workflowIdx": { "type": "integer", "format": "int64" + }, + "workflowParams": { + "type": "array", + "items": { + "$ref": "#/definitions/WorkflowParamDto" + } } } }, @@ -2309,7 +2859,7 @@ "type": "integer", "format": "int64" }, - "workflowStageTypeIdx": { + "workflowStageIdx": { "type": "integer", "format": "int64" } @@ -2580,6 +3130,24 @@ } } }, + "ResponseWrapper«ResponseEventListenerDto»": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "data": { + "$ref": "#/definitions/ResponseEventListenerDto" + }, + "detail": { + "type": "string" + }, + "message": { + "type": "string" + } + } + }, "OssTypeDto": { "type": "object", "properties": { @@ -2595,6 +3163,18 @@ } } }, + "WorkflowLogResDto": { + "type": "object", + "properties": { + "buildIdx": { + "type": "integer", + "format": "int32" + }, + "buildLog": { + "type": "string" + } + } + }, "ResponseWrapper«WorkflowStageDto»": { "type": "object", "properties": { @@ -2668,21 +3248,6 @@ } } } - }, - "ResponseWrapper«Void»": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "detail": { - "type": "string" - }, - "message": { - "type": "string" - } - } } } } \ No newline at end of file