Copilot commented on code in PR #6233:
URL: https://github.com/apache/shenyu/pull/6233#discussion_r2542361846
##########
shenyu-admin/src/main/java/org/apache/shenyu/admin/model/entity/FieldDO.java:
##########
@@ -46,9 +46,9 @@ public class FieldDO extends BaseDO {
private String fieldDesc;
/**
- * the required whether to require (0 not required, 1 required).
+ * the is_required whether to require (0 not is_required, 1 is_required).
Review Comment:
The javadoc comment is misleading. It should say "whether to require (0 not
required, 1 required)" instead of "whether to require (0 not is_required, 1
is_required)". The variable name change doesn't mean the values or their
meanings have changed.
```suggestion
* whether to require (0 not required, 1 required).
```
##########
shenyu-admin/src/main/java/org/apache/shenyu/admin/model/entity/FieldDO.java:
##########
@@ -130,19 +130,19 @@ public void setFieldDesc(final String fieldDesc) {
/**
* getRequired.
*
- * @return required
+ * @return isRequired
*/
public Boolean getRequired() {
- return required;
+ return isRequired;
}
/**
- * set required.
+ * set is_required.
Review Comment:
The javadoc should be updated to reflect the new parameter name. It should
say "set isRequired" instead of "set is_required" to follow Java naming
conventions in documentation.
##########
shenyu-examples/pom.xml:
##########
@@ -68,6 +68,11 @@
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>${swagger.version}</version>
</dependency>
+ <dependency>
+ <groupId>com.alibaba.fastjson2</groupId>
+ <artifactId>fastjson2</artifactId>
+ <version>${fastjson2.version}</version>
+ </dependency>
Review Comment:
This dependency addition appears unrelated to the PR's stated purpose of
fixing database reserved keywords. The PR title and description mention fixing
field-sqlmap.xml database reserved keywords, but this change adds a fastjson2
dependency to the examples module. This unrelated change should either be
removed or explained in a separate PR.
```suggestion
```
##########
shenyu-admin/src/main/java/org/apache/shenyu/admin/model/entity/ParameterDO.java:
##########
@@ -157,16 +157,16 @@ public void setParamDesc(final String paramDesc) {
* @return required
*/
public Boolean getRequired() {
- return required;
+ return isRequired;
}
/**
* set required.
*
- * @param required whether of require
+ * @param isRequired whether of require
Review Comment:
The parameter name in javadoc should use proper descriptive text instead of
just the variable name. Change "@param isRequired whether of require" to
"@param isRequired whether to require (0 not required, 1 required)" to match
the field's javadoc comment and provide clearer documentation.
```suggestion
* @param isRequired whether to require (0 not required, 1 required)
```
##########
shenyu-admin/src/main/java/org/apache/shenyu/admin/model/entity/FieldDO.java:
##########
@@ -130,19 +130,19 @@ public void setFieldDesc(final String fieldDesc) {
/**
* getRequired.
*
- * @return required
+ * @return isRequired
*/
public Boolean getRequired() {
- return required;
+ return isRequired;
}
/**
- * set required.
+ * set is_required.
*
- * @param required required
+ * @param isRequired is_required
Review Comment:
The parameter name in javadoc should follow Java naming conventions. Change
"@param isRequired is_required" to "@param isRequired whether to require (0 not
required, 1 required)" to be consistent with other javadoc comments and follow
proper documentation style.
##########
shenyu-admin/src/main/java/org/apache/shenyu/admin/model/entity/FieldDO.java:
##########
@@ -277,13 +277,13 @@ public FieldDOBuilder fieldDesc(final String fieldDesc) {
}
/**
- * required.
+ * is_required.
Review Comment:
The javadoc should say "isRequired" instead of "is_required" to follow Java
naming conventions in documentation.
##########
shenyu-admin/src/main/java/org/apache/shenyu/admin/model/entity/FieldDO.java:
##########
@@ -277,13 +277,13 @@ public FieldDOBuilder fieldDesc(final String fieldDesc) {
}
/**
- * required.
+ * is_required.
*
- * @param required required
+ * @param isRequired is_required
Review Comment:
The parameter name in javadoc should follow Java naming conventions and be
descriptive. Change "@param isRequired is_required" to "@param isRequired
whether to require (0 not required, 1 required)" to match the style used
elsewhere in the codebase.
```suggestion
* @param isRequired whether to require (0 not required, 1 required)
```
--
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]
