You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hugegraph.apache.org by "lokidundun (via GitHub)" <gi...@apache.org> on 2026/03/14 04:45:24 UTC
[PR] Improve: Add the desc of the vars in swagger-ui [hugegraph]
lokidundun opened a new pull request, #2969:
URL: https://github.com/apache/hugegraph/pull/2969
<!--
Thank you very much for contributing to Apache HugeGraph, we are happy that you want to help us improve it!
Here are some tips for you:
1. If this is your first time, please read the [contributing guidelines](https://github.com/apache/hugegraph/blob/master/CONTRIBUTING.md)
2. If a PR fix/close an issue, type the message "close xxx" (xxx is the link of related
issue) in the content, GitHub will auto link it (Required)
3. Name the PR title in "Google Commit Format", start with "feat | fix | perf | refactor | doc | chore",
such like: "feat(core): support the PageRank algorithm" or "fix: wrong break in the compute loop" (module is optional)
skip it if you are unsure about which is the best component.
4. One PR address one issue, better not to mix up multiple issues.
5. Put an `x` in the `[ ]` to mark the item as CHECKED. `[x]` (or click it directly after
published)
-->
## Purpose of the PR
- close #2335
<!--
Please explain more context in this section, clarify why the changes are needed.
e.g:
- If you propose a new API, clarify the use case for a new API.
- If you fix a bug, you can clarify why it is a bug, and should be associated with an issue.
-->
## Main Changes
<!-- Please clarify what changes you are proposing. The purpose of this section is to outline the changes and how this PR fixes the issue. These change logs are helpful for better and faster reviews.)
For example:
- If you introduce a new feature, please show detailed design here or add the link of design documentation.
- If you refactor some codes with changing classes, showing the class hierarchy will help reviewers.
- If there is a discussion in the mailing list, please add the link. -->
## Verifying these changes
<!-- Please pick the proper options below -->
- [ ] Trivial rework / code cleanup without any test coverage. (No Need)
- [ ] Already covered by existing tests, such as *(please modify tests here)*.
- [ ] Need tests and can be verified as follows:
- xxx
## Does this PR potentially affect the following parts?
<!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. -->
- [ ] Dependencies ([add/update license](https://hugegraph.apache.org/docs/contribution-guidelines/contribute/#321-check-licenses) info & [regenerate_known_dependencies.sh](../install-dist/scripts/dependency/regenerate_known_dependencies.sh)) <!-- Don't forget to add/update the info in "LICENSE" & "NOTICE" files (both in root & dist module) -->
- [ ] Modify configurations
- [ ] The public API
- [ ] Other affects (typed here)
- [ ] Nope
## Documentation Status
<!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. -->
- [ ] `Doc - TODO` <!-- Your PR changes impact docs and you will update later -->
- [ ] `Doc - Done` <!-- Related docs have been already added or updated -->
- [ ] `Doc - No Need` <!-- Your PR changes don't impact/need docs -->
--
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: commits-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] refactor: add the desc of the vars in swagger-ui [hugegraph]
Posted by "imbajin (via GitHub)" <gi...@apache.org>.
imbajin commented on PR #2969:
URL: https://github.com/apache/hugegraph/pull/2969#issuecomment-4060180378
THX, style could ref https://github.com/apache/hugegraph/wiki/The-style-config-for-HugeGraph-in-IDEA
--
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: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [PR] refactor: add the desc of the vars in swagger-ui [hugegraph]
Posted by "Copilot (via GitHub)" <gi...@apache.org>.
Copilot commented on code in PR #2969:
URL: https://github.com/apache/hugegraph/pull/2969#discussion_r2936797341
##########
hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/graph/VertexAPI.java:
##########
@@ -225,14 +238,24 @@ public String update(@Context GraphManager manager,
@RolesAllowed({"space", "$graphspace=$graphspace $owner=$graph " +
"$action=vertex_read"})
public String list(@Context GraphManager manager,
+ @Parameter(description = "The graph space name")
@PathParam("graphspace") String graphSpace,
+ @Parameter(description = "The graph name")
@PathParam("graph") String graph,
+ @Parameter(description = "Filter by vertex label")
@QueryParam("label") String label,
+ @Parameter(description = "Filter by vertex properties in JSON format, " +
+ "e.g., {\"key1\": \"value1\", \"key2\": \"value2\"}")
Review Comment:
This wrapped `@Parameter` description line exceeds the 100-character Checkstyle LineLength limit (style/checkstyle.xml max=100) because the continuation line is indented to align under `description =` and also contains many escaped quotes. This will fail `maven-checkstyle-plugin` during the validate phase. Please shorten the example or split the example string further so each physical line stays <= 100 characters.
--
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: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [PR] refactor: add the desc of the vars in swagger-ui [hugegraph]
Posted by "Copilot (via GitHub)" <gi...@apache.org>.
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: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [PR] refactor: add the desc of the vars in swagger-ui [hugegraph]
Posted by "lokidundun (via GitHub)" <gi...@apache.org>.
lokidundun commented on PR #2969:
URL: https://github.com/apache/hugegraph/pull/2969#issuecomment-4060208379
> THX, style could ref https://github.com/apache/hugegraph/wiki/The-style-config-for-HugeGraph-in-IDEA
Thanks for the guide! I'll refer to this style config in IDEA to keep my code consistent with the project's standards.
--
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: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [PR] refactor: add the desc of the vars in swagger-ui [hugegraph]
Posted by "Copilot (via GitHub)" <gi...@apache.org>.
Copilot commented on code in PR #2969:
URL: https://github.com/apache/hugegraph/pull/2969#discussion_r2938111908
##########
hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/profile/GraphsAPI.java:
##########
@@ -154,12 +161,15 @@ public void drop(@Context GraphManager manager,
@Produces(APPLICATION_JSON_WITH_CHARSET)
@RolesAllowed({"analyst"})
public Object reload(@Context GraphManager manager,
+ @Parameter(
+ description = "The action map containing 'action' key with value" +
+ " 'reload'")
Review Comment:
The @Parameter(description=...) line here is likely over Checkstyle's 100-character LineLength limit due to indentation + the long string. Please wrap/split the description string across additional lines (or shorten it) so this file passes Checkstyle.
##########
hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/metrics/MetricsAPI.java:
##########
@@ -207,7 +210,9 @@ public String all(@Context GraphManager manager,
@Produces(APPLICATION_TEXT_WITH_CHARSET)
@RolesAllowed({"space", "$owner= $action=metrics_read"})
@Operation(summary = "get all statistics metrics")
- public String statistics(@QueryParam("type") String type) {
+ public String statistics(@Parameter(description = "Output format type: 'json' for JSON format, " +
+ "other values for Prometheus format")
+ @QueryParam("type") String type) {
Review Comment:
This method signature line is likely to exceed the repository's 100-character Checkstyle LineLength limit (style/checkstyle.xml). Please wrap the `@Parameter` annotation onto its own line(s) (consistent with other endpoints in this class) so the file passes Checkstyle.
--
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: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [PR] refactor: add the desc of the vars in swagger-ui [hugegraph]
Posted by "imbajin (via GitHub)" <gi...@apache.org>.
imbajin merged PR #2969:
URL: https://github.com/apache/hugegraph/pull/2969
--
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: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [PR] refactor: add the desc of the vars in swagger-ui [hugegraph]
Posted by "Copilot (via GitHub)" <gi...@apache.org>.
Copilot commented on code in PR #2969:
URL: https://github.com/apache/hugegraph/pull/2969#discussion_r2936742665
##########
hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/profile/GraphsAPI.java:
##########
@@ -138,8 +142,11 @@ public Object get(@Context GraphManager manager,
@Produces(APPLICATION_JSON_WITH_CHARSET)
@RolesAllowed({"space"})
public void drop(@Context GraphManager manager,
+ @Parameter(description = "The graph space name")
@PathParam("graphspace") String graphSpace,
+ @Parameter(description = "The graph name")
@PathParam("name") String name,
+ @Parameter(description = "Confirmation message to drop the graph, must be: " + CONFIRM_DROP)
Review Comment:
This `@Parameter` description line exceeds the project's 100-character Checkstyle LineLength limit. Please wrap/shorten the description (e.g., move the constant mention to a separate line or describe it without string concatenation) to avoid build failures.
##########
hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/profile/GraphsAPI.java:
##########
@@ -177,9 +185,13 @@ public Object reload(@Context GraphManager manager,
@Produces(APPLICATION_JSON_WITH_CHARSET)
@RolesAllowed({"space"})
public Object create(@Context GraphManager manager,
+ @Parameter(description = "The graph space name")
@PathParam("graphspace") String graphSpace,
+ @Parameter(description = "The graph name to create")
@PathParam("name") String name,
+ @Parameter(description = "The graph name to clone from (optional)")
@QueryParam("clone_graph_name") String clone,
+ @Parameter(description = "The graph configuration options including 'backend', 'serializer', 'store', and optionally 'description'")
Review Comment:
This `@Parameter` description line is longer than the 100-character Checkstyle limit. Please wrap the description across lines or shorten it so the file passes Checkstyle.
##########
hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/schema/PropertyKeyAPI.java:
##########
@@ -100,9 +104,15 @@ public String create(@Context GraphManager manager,
"$action=property_key_write"})
@RedirectFilter.RedirectMasterRole
public String update(@Context GraphManager manager,
+ @Parameter(description = "The graph space name")
@PathParam("graphspace") String graphSpace,
+ @Parameter(description = "The graph name")
@PathParam("graph") String graph,
+ @Parameter(description = "The property key name")
@PathParam("name") String name,
+ @Parameter(description = "Action to perform: 'append' to add new properties, " +
+ "'remove' to delete existing properties, " +
+ "'clear' to clear OLAP property data")
Review Comment:
The first line of this multi-line `@Parameter` description is likely to exceed the 100-character Checkstyle LineLength limit due to indentation + string content. Please reflow the annotation (e.g., break after "@Parameter(" or shorten the text) so each line stays within 100 characters.
--
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: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org