fuweng11 commented on code in PR #11350: URL: https://github.com/apache/inlong/pull/11350#discussion_r1802432438
########## inlong-manager/manager-pojo/src/main/java/org/apache/inlong/manager/pojo/transform/TransformFunctionDocResponse.java: ########## @@ -0,0 +1,44 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.inlong.manager.pojo.transform; + +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import lombok.AllArgsConstructor; +import lombok.Data; +import lombok.NoArgsConstructor; + +/** + * Response of transform function Docs + */ +@Data +@NoArgsConstructor +@AllArgsConstructor +@ApiModel("Response of transform function Doc") +public class TransformFunctionDocResponse { + + @ApiModelProperty("transform function names") Review Comment: ```suggestion @ApiModelProperty("Transform function name") ``` ########## inlong-manager/manager-pojo/src/main/java/org/apache/inlong/manager/pojo/transform/TransformFunctionDocResponse.java: ########## @@ -0,0 +1,44 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.inlong.manager.pojo.transform; + +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import lombok.AllArgsConstructor; +import lombok.Data; +import lombok.NoArgsConstructor; + +/** + * Response of transform function Docs + */ +@Data +@NoArgsConstructor +@AllArgsConstructor +@ApiModel("Response of transform function Doc") +public class TransformFunctionDocResponse { + + @ApiModelProperty("transform function names") + private String names; Review Comment: ```suggestion private String name; ``` ########## inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/openapi/OpenTransformFunctionController.java: ########## @@ -0,0 +1,54 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.inlong.manager.web.controller.openapi; + +import org.apache.inlong.manager.pojo.common.PageResult; +import org.apache.inlong.manager.pojo.common.Response; +import org.apache.inlong.manager.pojo.transform.TransformFunctionDocRequest; +import org.apache.inlong.manager.pojo.transform.TransformFunctionDocResponse; +import org.apache.inlong.manager.service.transform.TransformFunctionDocService; + +import io.swagger.annotations.Api; +import io.swagger.annotations.ApiOperation; +import org.springframework.validation.annotation.Validated; +import org.springframework.web.bind.annotation.RequestBody; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestMethod; +import org.springframework.web.bind.annotation.RestController; + +import javax.annotation.Resource; + +/** + * Open InLong transform function controller + */ +@RestController +@RequestMapping("/openapi/transform") +@Api(tags = "Open-TransformFunction-API") +public class OpenTransformFunctionController { Review Comment: Please use `OpenStreamTransformController`.Add API under `OpenStreamTransformController`. ########## inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/openapi/OpenTransformFunctionController.java: ########## @@ -0,0 +1,54 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.inlong.manager.web.controller.openapi; + +import org.apache.inlong.manager.pojo.common.PageResult; +import org.apache.inlong.manager.pojo.common.Response; +import org.apache.inlong.manager.pojo.transform.TransformFunctionDocRequest; +import org.apache.inlong.manager.pojo.transform.TransformFunctionDocResponse; +import org.apache.inlong.manager.service.transform.TransformFunctionDocService; + +import io.swagger.annotations.Api; +import io.swagger.annotations.ApiOperation; +import org.springframework.validation.annotation.Validated; +import org.springframework.web.bind.annotation.RequestBody; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestMethod; +import org.springframework.web.bind.annotation.RestController; + +import javax.annotation.Resource; + +/** + * Open InLong transform function controller + */ +@RestController +@RequestMapping("/openapi/transform") Review Comment: ```suggestion @RequestMapping("/openapi") ``` ########## inlong-manager/manager-pojo/src/main/java/org/apache/inlong/manager/pojo/transform/TransformFunctionDocResponse.java: ########## @@ -0,0 +1,44 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.inlong.manager.pojo.transform; + +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import lombok.AllArgsConstructor; +import lombok.Data; +import lombok.NoArgsConstructor; + +/** + * Response of transform function Docs + */ +@Data +@NoArgsConstructor +@AllArgsConstructor +@ApiModel("Response of transform function Doc") +public class TransformFunctionDocResponse { + + @ApiModelProperty("transform function names") + private String names; + + @ApiModelProperty("transform function explanation") Review Comment: ```suggestion @ApiModelProperty("Transform function explanation") ``` ########## inlong-manager/manager-pojo/src/main/java/org/apache/inlong/manager/pojo/transform/TransformFunctionDocResponse.java: ########## @@ -0,0 +1,44 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.inlong.manager.pojo.transform; + +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import lombok.AllArgsConstructor; +import lombok.Data; +import lombok.NoArgsConstructor; + +/** + * Response of transform function Docs + */ +@Data +@NoArgsConstructor +@AllArgsConstructor +@ApiModel("Response of transform function Doc") +public class TransformFunctionDocResponse { + + @ApiModelProperty("transform function names") + private String names; + + @ApiModelProperty("transform function explanation") + private String explanation; + + @ApiModelProperty("transform function examples") Review Comment: ```suggestion @ApiModelProperty("Transform function examples") ``` ########## inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/transform/TransformFunctionDocService.java: ########## @@ -0,0 +1,36 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.inlong.manager.service.transform; + +import org.apache.inlong.manager.pojo.common.PageResult; +import org.apache.inlong.manager.pojo.transform.TransformFunctionDocRequest; +import org.apache.inlong.manager.pojo.transform.TransformFunctionDocResponse; +/** + * Service layer interface for transform function docs + */ +public interface TransformFunctionDocService { + + /** + * Query the transform function information. + * + * @param request the TransformFunctionDocRequest request + * @return list of TransformFunctionDocResponse + */ + PageResult<TransformFunctionDocResponse> getFunctionDocs(TransformFunctionDocRequest request); Review Comment: ```suggestion PageResult<TransformFunctionDocResponse> listByCondition(TransformFunctionDocRequest request); ``` ########## inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/openapi/OpenTransformFunctionController.java: ########## @@ -0,0 +1,54 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.inlong.manager.web.controller.openapi; + +import org.apache.inlong.manager.pojo.common.PageResult; +import org.apache.inlong.manager.pojo.common.Response; +import org.apache.inlong.manager.pojo.transform.TransformFunctionDocRequest; +import org.apache.inlong.manager.pojo.transform.TransformFunctionDocResponse; +import org.apache.inlong.manager.service.transform.TransformFunctionDocService; + +import io.swagger.annotations.Api; +import io.swagger.annotations.ApiOperation; +import org.springframework.validation.annotation.Validated; +import org.springframework.web.bind.annotation.RequestBody; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestMethod; +import org.springframework.web.bind.annotation.RestController; + +import javax.annotation.Resource; + +/** + * Open InLong transform function controller + */ +@RestController +@RequestMapping("/openapi/transform") +@Api(tags = "Open-TransformFunction-API") +public class OpenTransformFunctionController { + + @Resource + private TransformFunctionDocService transformFunctionDocService; + + @RequestMapping(value = "/function/docs", method = RequestMethod.POST) Review Comment: ```suggestion @RequestMapping(value = "/transform/function/list", method = RequestMethod.POST) ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
