Copilot commented on code in PR #2969:
URL: https://github.com/apache/hugegraph/pull/2969#discussion_r2935053836
##########
hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/traversers/SameNeighborsAPI.java:
##########
@@ -43,6 +43,8 @@
import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.common.collect.ImmutableMap;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.tags.Tag;
Review Comment:
`Parameter`/`Schema` are imported but not used anywhere in this file, which
will fail checkstyle's `UnusedImports`. Please remove these imports or add the
intended Swagger annotations.
##########
hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/traversers/EdgesAPI.java:
##########
@@ -87,7 +88,7 @@ public String list(@Context GraphManager manager,
public String shards(@Context GraphManager manager,
@PathParam("graphspace") String graphSpace,
@PathParam("graph") String graph,
- @QueryParam("split_size") long splitSize) {
+ @Parameter(description = "The split size for shards")
@QueryParam("split_size") long splitSize) {
Review Comment:
This parameter line exceeds the project's 100-character Checkstyle
`LineLength` limit (style/checkstyle.xml), which will fail the build. Please
wrap `@Parameter` / `@QueryParam` / the variable declaration onto separate
lines.
##########
hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/traversers/RingsAPI.java:
##########
@@ -40,6 +40,7 @@
import com.codahale.metrics.annotation.Timed;
+import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
Review Comment:
`Parameter` is imported but not used anywhere in this file, which will fail
checkstyle's `UnusedImports`. Please remove the import or add the intended
Swagger annotations.
##########
hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/traversers/ShortestPathAPI.java:
##########
@@ -62,22 +63,22 @@ public class ShortestPathAPI extends API {
@Timed
@Produces(APPLICATION_JSON_WITH_CHARSET)
public String get(@Context GraphManager manager,
- @PathParam("graphspace") String graphSpace,
- @PathParam("graph") String graph,
- @QueryParam("source") String source,
- @QueryParam("target") String target,
- @QueryParam("direction") String direction,
- @QueryParam("label") String edgeLabel,
- @QueryParam("max_depth") int depth,
- @QueryParam("max_degree")
+ @Parameter(description = "The graph space name")
@PathParam("graphspace") String graphSpace,
+ @Parameter(description = "The graph name")
@PathParam("graph") String graph,
+ @Parameter(description = "The source vertex ID")
@QueryParam("source") String source,
+ @Parameter(description = "The target vertex ID")
@QueryParam("target") String target,
Review Comment:
These method-parameter lines exceed the project's 100-character Checkstyle
`LineLength` limit (style/checkstyle.xml), which will fail the build. Please
wrap the parameter annotations/definitions across multiple lines (e.g., place
`@Parameter` on its own line as done elsewhere).
##########
hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/auth/ManagerAPI.java:
##########
@@ -113,9 +115,9 @@ public String createManager(@Context GraphManager manager,
@Timed
@Consumes(APPLICATION_JSON)
public void delete(@Context GraphManager manager,
- @PathParam("graphspace") String graphSpace,
- @QueryParam("user") String user,
- @QueryParam("type") HugePermission type) {
+ @Parameter(description = "The graph space name")
@PathParam("graphspace") String graphSpace,
+ @Parameter(description = "The user name")
@QueryParam("user") String user,
+ @Parameter(description = "The manager type: SPACE,
SPACE_MEMBER, or ADMIN") @QueryParam("type") HugePermission type) {
Review Comment:
This method signature line exceeds the project's 100-character Checkstyle
`LineLength` limit (style/checkstyle.xml), which will fail the build. Please
wrap the parameter annotations/definition across multiple lines.
##########
hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/traversers/SingleSourceShortestPathAPI.java:
##########
@@ -39,6 +39,7 @@
import com.codahale.metrics.annotation.Timed;
+import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
Review Comment:
`Parameter` is imported but not used anywhere in this file, which will fail
checkstyle's `UnusedImports`. Please remove the import or add the intended
Swagger annotations.
##########
hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/traversers/AllShortestPathsAPI.java:
##########
@@ -62,22 +63,22 @@ public class AllShortestPathsAPI extends API {
@Timed
@Produces(APPLICATION_JSON_WITH_CHARSET)
public String get(@Context GraphManager manager,
- @PathParam("graphspace") String graphSpace,
- @PathParam("graph") String graph,
- @QueryParam("source") String source,
- @QueryParam("target") String target,
- @QueryParam("direction") String direction,
- @QueryParam("label") String edgeLabel,
- @QueryParam("max_depth") int depth,
- @QueryParam("max_degree")
+ @Parameter(description = "The graph space name")
@PathParam("graphspace") String graphSpace,
+ @Parameter(description = "The graph name")
@PathParam("graph") String graph,
+ @Parameter(description = "The source vertex ID")
@QueryParam("source") String source,
+ @Parameter(description = "The target vertex ID")
@QueryParam("target") String target,
Review Comment:
These method-parameter lines exceed the project's 100-character Checkstyle
`LineLength` limit (style/checkstyle.xml), which will fail the build. Please
wrap the parameter annotations/definitions across multiple lines (e.g., place
`@Parameter` on its own line as done elsewhere).
##########
hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/traversers/VerticesAPI.java:
##########
@@ -60,9 +61,9 @@ public class VerticesAPI extends API {
@Compress
@Produces(APPLICATION_JSON_WITH_CHARSET)
public String list(@Context GraphManager manager,
- @PathParam("graphspace") String graphSpace,
- @PathParam("graph") String graph,
- @QueryParam("ids") List<String> stringIds) {
+ @Parameter(description = "The graph space name")
@PathParam("graphspace") String graphSpace,
+ @Parameter(description = "The graph name")
@PathParam("graph") String graph,
+ @Parameter(description = "The vertex IDs")
@QueryParam("ids") List<String> stringIds) {
Review Comment:
The `list()` method signature contains parameter lines that exceed the
project's 100-character Checkstyle `LineLength` limit (style/checkstyle.xml),
which will fail the build. Please wrap these parameters/annotations onto
separate lines.
##########
hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/auth/AccessAPI.java:
##########
@@ -99,10 +101,10 @@ public String update(@Context GraphManager manager,
@Timed
@Produces(APPLICATION_JSON_WITH_CHARSET)
public String list(@Context GraphManager manager,
- @PathParam("graphspace") String graphSpace,
- @QueryParam("group") String group,
- @QueryParam("target") String target,
- @QueryParam("limit") @DefaultValue("100") long limit) {
+ @Parameter(description = "The graph space name")
@PathParam("graphspace") String graphSpace,
+ @Parameter(description = "The group id to filter by")
@QueryParam("group") String group,
+ @Parameter(description = "The target id to filter by")
@QueryParam("target") String target,
+ @Parameter(description = "The limit of results to
return") @QueryParam("limit") @DefaultValue("100") long limit) {
Review Comment:
This method signature line exceeds the project's 100-character Checkstyle
`LineLength` limit (style/checkstyle.xml), which will fail the build. Please
wrap the parameter annotations/definition across multiple lines.
##########
hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/traversers/TemplatePathsAPI.java:
##########
@@ -41,6 +41,8 @@
import com.codahale.metrics.annotation.Timed;
import com.fasterxml.jackson.annotation.JsonProperty;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.tags.Tag;
Review Comment:
`Parameter`/`Schema` are imported but not used anywhere in this file, which
will fail checkstyle's `UnusedImports`. Please remove these imports or add the
intended Swagger annotations.
##########
hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/traversers/RaysAPI.java:
##########
@@ -40,6 +40,7 @@
import com.codahale.metrics.annotation.Timed;
+import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
Review Comment:
`Parameter` is imported but not used anywhere in this file, which will fail
checkstyle's `UnusedImports`. Please remove the import or add the intended
Swagger annotations.
##########
hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/auth/UserAPI.java:
##########
@@ -101,8 +103,8 @@ public String update(@Context GraphManager manager,
@Timed
@Produces(APPLICATION_JSON_WITH_CHARSET)
public String list(@Context GraphManager manager,
- @PathParam("graphspace") String graphSpace,
- @QueryParam("limit") @DefaultValue("100") long limit) {
+ @Parameter(description = "The graph space name")
@PathParam("graphspace") String graphSpace,
+ @Parameter(description = "The limit of results to
return") @QueryParam("limit") @DefaultValue("100") long limit) {
LOG.debug("GraphSpace [{}] list users", graphSpace);
Review Comment:
This method signature line exceeds the project's 100-character Checkstyle
`LineLength` limit (style/checkstyle.xml), which will fail the build. Please
wrap the parameter annotations/definition across multiple lines.
##########
hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/traversers/ResourceAllocationAPI.java:
##########
@@ -34,6 +34,7 @@
import com.codahale.metrics.annotation.Timed;
import com.google.common.collect.ImmutableMap;
+import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
Review Comment:
`Parameter` is imported but not used anywhere in this file, which will fail
checkstyle's `UnusedImports`. Please remove the import or add the intended
Swagger annotations.
##########
hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/auth/GroupAPI.java:
##########
@@ -100,7 +102,7 @@ public String update(@Context GraphManager manager,
@Produces(APPLICATION_JSON_WITH_CHARSET)
@RolesAllowed({"admin"})
public String list(@Context GraphManager manager,
- @QueryParam("limit") @DefaultValue("100") long limit) {
+ @Parameter(description = "The limit of results to
return") @QueryParam("limit") @DefaultValue("100") long limit) {
LOG.debug("list groups");
Review Comment:
This method signature line exceeds the project's 100-character Checkstyle
`LineLength` limit (style/checkstyle.xml), which will fail the build. Please
wrap the parameter annotations/definition across multiple lines.
##########
hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/auth/TargetAPI.java:
##########
@@ -99,8 +101,8 @@ public String update(@Context GraphManager manager,
@Timed
@Produces(APPLICATION_JSON_WITH_CHARSET)
public String list(@Context GraphManager manager,
- @PathParam("graphspace") String graphSpace,
- @QueryParam("limit") @DefaultValue("100") long limit) {
+ @Parameter(description = "The graph space name")
@PathParam("graphspace") String graphSpace,
+ @Parameter(description = "The limit of results to
return") @QueryParam("limit") @DefaultValue("100") long limit) {
Review Comment:
This method signature line exceeds the project's 100-character Checkstyle
`LineLength` limit (style/checkstyle.xml), which will fail the build. Please
wrap the parameter annotations/definition across multiple lines.
##########
hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/traversers/AdamicAdarAPI.java:
##########
@@ -34,6 +34,7 @@
import com.codahale.metrics.annotation.Timed;
import com.google.common.collect.ImmutableMap;
+import io.swagger.v3.oas.annotations.Parameter;
Review Comment:
`Parameter` is imported but not used anywhere in this file, which will fail
checkstyle's `UnusedImports`. Please remove the import or add the intended
Swagger annotations.
##########
hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/auth/ProjectAPI.java:
##########
@@ -89,9 +91,9 @@ public String create(@Context GraphManager manager,
@Consumes(APPLICATION_JSON)
@Produces(APPLICATION_JSON_WITH_CHARSET)
public String update(@Context GraphManager manager,
- @PathParam("graphspace") String graphSpace,
- @PathParam("id") String id,
- @QueryParam("action") String action,
+ @Parameter(description = "The graph space name")
@PathParam("graphspace") String graphSpace,
+ @Parameter(description = "The project id")
@PathParam("id") String id,
+ @Parameter(description = "The action to perform:
add_graph, remove_graph, or empty for description update")
@QueryParam("action") String action,
Review Comment:
This method signature line exceeds the project's 100-character Checkstyle
`LineLength` limit (style/checkstyle.xml), which will fail the build. Please
wrap the parameter annotations/definition across multiple lines.
##########
hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/traversers/EdgeExistenceAPI.java:
##########
@@ -34,6 +34,7 @@
import com.codahale.metrics.annotation.Timed;
import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
Review Comment:
`Parameter` is imported but not used anywhere in this file, which will fail
checkstyle's `UnusedImports`. Please remove the import or add the intended
Swagger annotations.
##########
hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/auth/BelongAPI.java:
##########
@@ -98,10 +100,10 @@ public String update(@Context GraphManager manager,
@Timed
@Produces(APPLICATION_JSON_WITH_CHARSET)
public String list(@Context GraphManager manager,
- @PathParam("graphspace") String graphSpace,
- @QueryParam("user") String user,
- @QueryParam("group") String group,
- @QueryParam("limit") @DefaultValue("100") long limit) {
+ @Parameter(description = "The graph space name")
@PathParam("graphspace") String graphSpace,
+ @Parameter(description = "The user id to filter by")
@QueryParam("user") String user,
+ @Parameter(description = "The group id to filter by")
@QueryParam("group") String group,
+ @Parameter(description = "The limit of results to
return") @QueryParam("limit") @DefaultValue("100") long limit) {
Review Comment:
This method signature line exceeds the project's 100-character Checkstyle
`LineLength` limit (style/checkstyle.xml), which will fail the build. Please
wrap the parameter annotations/definition across multiple lines.
##########
hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/traversers/CrosspointsAPI.java:
##########
@@ -35,6 +35,7 @@
import com.codahale.metrics.annotation.Timed;
+import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
Review Comment:
`Parameter` is imported but not used anywhere in this file, which will fail
checkstyle's `UnusedImports`. Please remove the import or add the intended
Swagger annotations.
##########
hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/traversers/WeightedShortestPathAPI.java:
##########
@@ -62,22 +63,22 @@ public class WeightedShortestPathAPI extends API {
@Timed
@Produces(APPLICATION_JSON_WITH_CHARSET)
public String get(@Context GraphManager manager,
- @PathParam("graphspace") String graphSpace,
- @PathParam("graph") String graph,
- @QueryParam("source") String source,
- @QueryParam("target") String target,
- @QueryParam("direction") String direction,
- @QueryParam("label") String edgeLabel,
- @QueryParam("weight") String weight,
- @QueryParam("max_degree")
+ @Parameter(description = "The graph space name")
@PathParam("graphspace") String graphSpace,
+ @Parameter(description = "The graph name")
@PathParam("graph") String graph,
+ @Parameter(description = "The source vertex ID")
@QueryParam("source") String source,
+ @Parameter(description = "The target vertex ID")
@QueryParam("target") String target,
Review Comment:
These method-parameter lines exceed the project's 100-character Checkstyle
`LineLength` limit (style/checkstyle.xml), which will fail the build. Please
wrap the parameter annotations/definitions across multiple lines (e.g., place
`@Parameter` on its own line as done elsewhere).
--
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]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
