natas_hw
/
dolphinscheduler
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[improvement][api] Fix typo for controllers (#15438) 

Co-authored-by: fuchanghai <changhaifu@apache.org>
Co-authored-by: Rick Cheng <rickchengx@gmail.com>
This commit is contained in:
sunsongyang 2024-01-24 10:39:35 +08:00 committed by GitHub
parent 5a7deb28f7
commit 95ae0036f6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
22 changed files with 35 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/controller/AlertGroupController.java
View File

@ -77,7 +77,7 @@ public class AlertGroupController extends BaseController {
* @param description description
* @return create result code
*/
@Operation(summary = "createAlertgroup", description = "CREATE_ALERT_GROUP_NOTES")
@Operation(summary = "createAlertGroup", description = "CREATE_ALERT_GROUP_NOTES")
@Parameters({
@Parameter(name = "groupName", description = "GROUP_NAME", required = true, schema = @Schema(implementation = String.class)),
@Parameter(name = "description", description = "DESC", schema = @Schema(implementation = String.class)),
@ -100,7 +100,7 @@ public class AlertGroupController extends BaseController {
* @param loginUser login user
* @return alert group list
*/
@Operation(summary = "listAlertgroupById", description = "QUERY_ALERT_GROUP_LIST_NOTES")
@Operation(summary = "listAlertGroupById", description = "QUERY_ALERT_GROUP_LIST_NOTES")
@GetMapping(value = "/list")
@ResponseStatus(HttpStatus.OK)
@ApiException(QUERY_ALL_ALERTGROUP_ERROR)
@ -116,7 +116,7 @@ public class AlertGroupController extends BaseController {
* @param loginUser login user
* @return normal alert group list
*/
@Operation(summary = "listNormalAlertgroupById", description = "QUERY_ALERT_GROUP_LIST_NOTES")
@Operation(summary = "listNormalAlertGroupById", description = "QUERY_ALERT_GROUP_LIST_NOTES")
@GetMapping(value = "/normal-list")
@ResponseStatus(HttpStatus.OK)
@ApiException(QUERY_ALL_ALERTGROUP_ERROR)
@ -155,7 +155,7 @@ public class AlertGroupController extends BaseController {
}
/**
* check alarm group detail by Id
* check alarm group detail by id
*
* @param loginUser login user
* @param id alert group id
@ -185,7 +185,7 @@ public class AlertGroupController extends BaseController {
* @param description description
* @return update result code
*/
@Operation(summary = "updateAlertgroup", description = "UPDATE_ALERT_GROUP_NOTES")
@Operation(summary = "updateAlertGroup", description = "UPDATE_ALERT_GROUP_NOTES")
@Parameters({
@Parameter(name = "id", description = "ALERT_GROUP_ID", required = true, schema = @Schema(implementation = int.class, example = "100")),
@Parameter(name = "groupName", description = "GROUP_NAME", required = true, schema = @Schema(implementation = String.class)),
@ -212,7 +212,7 @@ public class AlertGroupController extends BaseController {
* @param id alert group id
* @return delete result code
*/
@Operation(summary = "delAlertgroupById", description = "DELETE_ALERT_GROUP_BY_ID_NOTES")
@Operation(summary = "delAlertGroupById", description = "DELETE_ALERT_GROUP_BY_ID_NOTES")
@Parameters({
@Parameter(name = "id", description = "ALERT_GROUP_ID", required = true, schema = @Schema(implementation = int.class, example = "100"))
})

2
dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/controller/BaseController.java
View File

@ -151,7 +151,7 @@ public class BaseController {
/**
* return the data use Map format, for example, passing the value of key, value, passing a value
* eg. "/user/add" then return user name: zhangsan
* e.g. "/user/add" then return username: zhangsan
*
* @param msg message
* @param object success object data

4
dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/controller/CloudController.java
View File

@ -56,10 +56,10 @@ public class CloudController extends BaseController {
private CloudService cloudService;
/**
* get datafactory list
* get data factory list
*
* @param loginUser login user
* @return datafactory name list
* @return data factory name list
*/
@Operation(summary = "listDataFactory", description = "LIST_DATA_FACTORY")
@GetMapping(value = "/azure/datafactory/factories")

2
dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/controller/ClusterController.java
View File

@ -81,7 +81,7 @@ public class ClusterController extends BaseController {
@PostMapping(value = "/create")
@ResponseStatus(HttpStatus.CREATED)
@ApiException(CREATE_CLUSTER_ERROR)
public Result<Long> createProject(@Parameter(hidden = true) @RequestAttribute(value = Constants.SESSION_USER) User loginUser,
public Result<Long> createCluster(@Parameter(hidden = true) @RequestAttribute(value = Constants.SESSION_USER) User loginUser,
@RequestParam("name") String name,
@RequestParam("config") String config,
@RequestParam(value = "description", required = false) String description) {

6
dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/controller/DataSourceController.java
View File

@ -261,7 +261,7 @@ public class DataSourceController extends BaseController {
*
* @param loginUser login user
* @param name data source name
* @return true if data source name not exists.otherwise return false
* @return true if data source name not exists, otherwise return false
*/
@Operation(summary = "verifyDataSourceName", description = "VERIFY_DATA_SOURCE_NOTES")
@Parameters({
@ -281,9 +281,9 @@ public class DataSourceController extends BaseController {
*
* @param loginUser login user
* @param userId user id
* @return unauthed data source result code
* @return unauthorized data source result code
*/
@Operation(summary = "unauthDatasource", description = "UNAUTHORIZED_DATA_SOURCE_NOTES")
@Operation(summary = "unauthorizedDatasource", description = "UNAUTHORIZED_DATA_SOURCE_NOTES")
@Parameters({
@Parameter(name = "userId", description = "USER_ID", required = true, schema = @Schema(implementation = int.class, example = "100"))
})

2
dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/controller/DynamicTaskTypeController.java
View File

@ -62,7 +62,7 @@ public class DynamicTaskTypeController extends BaseController {
* @param loginUser login user
* @return dynamic task category list
*/
@Operation(summary = "listTaskCates", description = "LIST_TASK_TYPE_CATES")
@Operation(summary = "listTaskCategories", description = "LIST_TASK_TYPE_CATEGORIES")
@GetMapping(value = "/taskCategories")
@ResponseStatus(HttpStatus.OK)
@ApiException(LIST_TASK_TYPE_ERROR)

2
dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/controller/K8sNamespaceController.java
View File

@ -163,7 +163,7 @@ public class K8sNamespaceController extends BaseController {
*
* @param loginUser login user
* @param userId user id
* @return the namespaces which user have not permission to see
* @return the namespaces which user have no permission to see
*/
@Operation(summary = "queryUnauthorizedNamespace", description = "QUERY_UNAUTHORIZED_NAMESPACE_NOTES")
@Parameters({

2
dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/controller/LoginController.java
View File

@ -161,7 +161,7 @@ public class LoginController extends BaseController {
return Result.success();
}
@Operation(summary = "signOut", description = "SIGNOUT_NOTES")
@Operation(summary = "signOut", description = "SIGN_OUT_NOTES")
@PostMapping(value = "/signOut")
@ApiException(SIGN_OUT_ERROR)
public Result signOut(@Parameter(hidden = true) @RequestAttribute(value = Constants.SESSION_USER) User loginUser,

2
dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/controller/MonitorController.java
View File

@ -89,7 +89,7 @@ public class MonitorController extends BaseController {
* query database state
*
* @param loginUser login user
* @return data base state
* @return database state
*/
@Operation(summary = "queryDatabaseState", description = "QUERY_DATABASE_STATE_NOTES")
@GetMapping(value = "/databases")

2
dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/controller/ProjectController.java
View File

@ -217,7 +217,7 @@ public class ProjectController extends BaseController {
*
* @param loginUser login user
* @param userId user id
* @return the projects which user have not permission to see
* @return the projects which user have no permission to see
*/
@Operation(summary = "queryUnauthorizedProject", description = "QUERY_UNAUTHORIZED_PROJECT_NOTES")
@Parameters({

2
dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/controller/ResourcesController.java
View File

@ -316,7 +316,7 @@ public class ResourcesController extends BaseController {
*
* @param loginUser login user
* @param fileName resource full name
* @param tenantCode tenantcode of the owner of the resource
* @param tenantCode tenantCode of the owner of the resource
* @param type resource type
* @return true if the resource name not exists, otherwise return false
*/

2
dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/controller/SchedulerController.java
View File

@ -243,7 +243,7 @@ public class SchedulerController extends BaseController {
*
* @param loginUser login user
* @param projectCode project code
* @param id scheule id
* @param id schedule id
* @return delete result code
*/
@Operation(summary = "deleteScheduleById", description = "DELETE_SCHEDULE_NOTES")

4
dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/controller/TaskGroupController.java
View File

@ -83,11 +83,11 @@ public class TaskGroupController extends BaseController {
@ApiException(CREATE_TASK_GROUP_ERROR)
public Result createTaskGroup(@Parameter(hidden = true) @RequestAttribute(value = Constants.SESSION_USER) User loginUser,
@RequestParam("name") String name,
@RequestParam(value = "projectCode", required = false, defaultValue = "0") Long projectcode,
@RequestParam(value = "projectCode", required = false, defaultValue = "0") Long projectCode,
@RequestParam("description") String description,
@RequestParam("groupSize") Integer groupSize) {
Map<String, Object> result =
taskGroupService.createTaskGroup(loginUser, projectcode, name, description, groupSize);
taskGroupService.createTaskGroup(loginUser, projectCode, name, description, groupSize);
return returnDataList(result);
}

8
dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/controller/TenantController.java
View File

@ -101,7 +101,7 @@ public class TenantController extends BaseController {
* @param pageSize page size
* @return tenant list page
*/
@Operation(summary = "queryTenantlistPaging", description = "QUERY_TENANT_LIST_PAGING_NOTES")
@Operation(summary = "queryTenantListPaging", description = "QUERY_TENANT_LIST_PAGING_NOTES")
@Parameters({
@Parameter(name = "searchVal", description = "SEARCH_VAL", schema = @Schema(implementation = String.class)),
@Parameter(name = "pageNo", description = "PAGE_NO", required = true, schema = @Schema(implementation = int.class, example = "1")),
@ -110,7 +110,7 @@ public class TenantController extends BaseController {
@GetMapping()
@ResponseStatus(HttpStatus.OK)
@ApiException(QUERY_TENANT_LIST_PAGING_ERROR)
public Result<PageInfo<Tenant>> queryTenantlistPaging(@Parameter(hidden = true) @RequestAttribute(value = Constants.SESSION_USER) User loginUser,
public Result<PageInfo<Tenant>> queryTenantListPaging(@Parameter(hidden = true) @RequestAttribute(value = Constants.SESSION_USER) User loginUser,
@RequestParam(value = "searchVal", required = false) String searchVal,
@RequestParam("pageNo") Integer pageNo,
@RequestParam("pageSize") Integer pageSize) {
@ -126,11 +126,11 @@ public class TenantController extends BaseController {
* @param loginUser login user
* @return tenant list
*/
@Operation(summary = "queryTenantlist", description = "QUERY_TENANT_LIST_NOTES")
@Operation(summary = "queryTenantList", description = "QUERY_TENANT_LIST_NOTES")
@GetMapping(value = "/list")
@ResponseStatus(HttpStatus.OK)
@ApiException(QUERY_TENANT_LIST_ERROR)
public Result<List<Tenant>> queryTenantlist(@Parameter(hidden = true) @RequestAttribute(value = Constants.SESSION_USER) User loginUser) {
public Result<List<Tenant>> queryTenantList(@Parameter(hidden = true) @RequestAttribute(value = Constants.SESSION_USER) User loginUser) {
List<Tenant> tenants = tenantService.queryTenantList(loginUser);
return Result.success(tenants);
}

2
dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/controller/WorkFlowLineageController.java
View File

@ -111,7 +111,7 @@ public class WorkFlowLineageController extends BaseController {
* @param projectCode project codes which taskCode belong
* @param processDefinitionCode project code which taskCode belong
* @param taskCode task definition code
* @return Result of task can be delete or not
* @return Result of task can be deleted or not
*/
@Operation(summary = "verifyTaskCanDelete", description = "VERIFY_TASK_CAN_DELETE")
@Parameters({

2
dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/controller/WorkerGroupController.java
View File

@ -75,7 +75,7 @@ public class WorkerGroupController extends BaseController {
@Parameter(name = "name", description = "WORKER_GROUP_NAME", required = true, schema = @Schema(implementation = String.class)),
@Parameter(name = "addrList", description = "WORKER_ADDR_LIST", required = true, schema = @Schema(implementation = String.class)),
@Parameter(name = "description", description = "WORKER_DESC", required = false, schema = @Schema(implementation = String.class)),
@Parameter(name = "otherParamsJson", description = "WORKER_PARMS_JSON", required = false, schema = @Schema(implementation = String.class)),
@Parameter(name = "otherParamsJson", description = "WORKER_PARAMS_JSON", required = false, schema = @Schema(implementation = String.class)),
})
@PostMapping()
@ResponseStatus(HttpStatus.OK)

2
dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/controller/v2/ProcessTaskRelationV2Controller.java
View File

@ -113,7 +113,7 @@ public class ProcessTaskRelationV2Controller extends BaseController {
*/
@Operation(summary = "update", description = "UPDATE_PROCESS_TASK_RELATION_NOTES")
@Parameters({
@Parameter(name = "code", description = "DOWMSTREAM_TASK_DEFINITION_CODE", schema = @Schema(implementation = long.class, example = "123456", required = true))
@Parameter(name = "code", description = "DOWNSTREAM_TASK_DEFINITION_CODE", schema = @Schema(implementation = long.class, example = "123456", required = true))
})
@PutMapping(value = "/{code}")
@ResponseStatus(HttpStatus.OK)

2
dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/controller/v2/ProjectV2Controller.java
View File

@ -184,7 +184,7 @@ public class ProjectV2Controller extends BaseController {
*
* @param loginUser login user
* @param userId user id
* @return the projects which user have not permission to see
* @return the projects which user have no permission to see
*/
@Operation(summary = "queryUnauthorizedProject", description = "QUERY_UNAUTHORIZED_PROJECT_NOTES")
@Parameters({

2
dolphinscheduler-api/src/main/resources/i18n/messages.properties
View File

@ -193,7 +193,7 @@ PROCESS_DEFINITION_DESC=process definition desc
PROCESS_DEFINITION_TAG=process definition related opertation
PROCESS_DEFINITION_CODE=process definition code
PROCESS_DEFINITION_CODE_LIST=process definition code list
SIGNOUT_NOTES=logout
SIGN_OUT_NOTES=logout
USER_PASSWORD=user password
UPDATE_PROCESS_INSTANCE_NOTES=update process instance
QUERY_PROCESS_INSTANCE_LIST_NOTES=query process instance list

2
dolphinscheduler-api/src/main/resources/i18n/messages_en_US.properties
View File

@ -202,7 +202,7 @@ PROCESS_DEFINITION_CONNECTS=process definition node connects info (json format)
PROCESS_INSTANCE_CONNECTS=process instance node connects info (json format)
PROCESS_DEFINITION_DESC=process definition desc
PROCESS_DEFINITION_TAG=process definition related operation
SIGNOUT_NOTES=logout
SIGN_OUT_NOTES=logout
USER_PASSWORD=user password
UPDATE_PROCESS_INSTANCE_NOTES=update process instance
QUERY_PROCESS_INSTANCE_LIST_NOTES=query process instance list

2
dolphinscheduler-api/src/main/resources/i18n/messages_zh_CN.properties
View File

@ -191,7 +191,7 @@ PROCESS_DEFINITION_CONNECTS=流程定义节点图标连接信息(json格式)
PROCESS_INSTANCE_CONNECTS=流程实例节点图标连接信息(json格式)
PROCESS_DEFINITION_DESC=流程定义描述信息
PROCESS_DEFINITION_TAG=流程定义相关操作
SIGNOUT_NOTES=退出登录
SIGN_OUT_NOTES=退出登录
USER_PASSWORD=用户密码
UPDATE_PROCESS_INSTANCE_NOTES=更新流程实例
QUERY_PROCESS_INSTANCE_LIST_NOTES=查询流程实例列表

4
dolphinscheduler-api/src/test/java/org/apache/dolphinscheduler/api/controller/TenantControllerTest.java
View File

@ -69,7 +69,7 @@ public class TenantControllerTest extends AbstractControllerTest {
}
@Test
public void testQueryTenantlistPaging() throws Exception {
public void testQueryTenantListPaging() throws Exception {
MultiValueMap<String, String> paramsMap = new LinkedMultiValueMap<>();
paramsMap.add("pageNo", "1");
paramsMap.add("searchVal", "tenant");
@ -145,7 +145,7 @@ public class TenantControllerTest extends AbstractControllerTest {
}
@Test
public void testQueryTenantlist() throws Exception {
public void testQueryTenantList() throws Exception {
MvcResult mvcResult = mockMvc.perform(get("/tenants/list")
.header(SESSION_ID, sessionId))