doc(server): sync server-api with master - #490
Open
bitflicker64 wants to merge 1 commit into
Open
Conversation
bitflicker64
force-pushed
the
doc-sync/server-server-api
branch
2 times, most recently
from
September 5, 2026 19:29
90861e9 to
c94c17c
Compare
Diff every REST resource in hugegraph-api against the docs. Document the endpoints that were missing: login/logout/verify, auth projects, the graphspace default-role and schema-template APIs, graph profile, default graph, nickname update and reload, raft group management, algorithm and computer jobs, the adamic-adar, resource-allocation, edge-existence and count traversers, the index label update, the server profile and API listing, the exception trace switch, the IP allowlist and the Arthas agent. Fix wrong response shapes and status codes for graph create and clone, task cancel, manager check/list/grant/role and single-user query, correct the allowed graph read modes and graph modes, the graphspace required fields, the neighbor-rank top default and the personal-rank depth range, add the missing vertex query and task query parameters, and replace the claim that the HTTPS keystore ships in conf. Also drop task.scheduler_type from the graph creation example. The key is no longer a declared config option, setting it is ignored and only logs a deprecation warning, and the scheduler is picked from the backend type. The note keeps one sentence of history for readers on 1.7.0 and earlier.
bitflicker64
force-pushed
the
doc-sync/server-server-api
branch
from
September 5, 2026 19:36
c94c17c to
abf3a42
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Sync the
hugegraph-server/hugegraph-apiREST surface with master (36811483a).Every
@Path/@GET/@POST/@PUT/@DELETEin the api module was enumerated and mapped to a doc section, so that every documented endpoint still exists and every existing endpoint is documented. Bothcontent/enandcontent/cnare updated.In the table below,
.../api/is short forhugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/, and.../config/forhugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/config/.versionsreported"api": "0.71.0.0"0.72.0.0hugegraph-server/hugegraph-api/pom.xml:205,hugegraph-commons/hugegraph-common/src/main/resources/version.properties:20GET /andGET /apiswere not documented.../api/profile/ProfileAPI.java:64,.../api/profile/ProfileAPI.java:94GET/PUT /exception/traceand its relation toexception.allow_trace.../api/filter/ExceptionFilter.java:84,.../config/ServerOptions.java:464GET/POST/PUT /whiteiplistwith theload/removeactions and thewhite_ip.statusswitch.../api/profile/WhiteIpListAPI.java:54,.../config/ServerOptions.java:89PUT /arthasand the fourarthas.*options it applies.../api/arthas/ArthasAPI.java:38,.../config/ServerOptions.java:432POST /auth/login,DELETE /auth/logout,GET /auth/verify, with the Bearer header requirement and theauth.token_secret/auth.token_expirebehaviour.../api/auth/LoginAPI.java:62,hugegraph-server/hugegraph-test/src/main/java/org/apache/hugegraph/api/LoginApiTest.java:82/auth/projects.../api/auth/ProjectAPI.java:58managers/checkusedtype=WRITEand claimed a"true"string bodytypeis required and limited to SPACE/SPACE_MEMBER/ADMIN, the body is{"check": true}.../api/auth/ManagerAPI.java:202,.../api/auth/ManagerAPI.java:312{"managers": [...]}{"admins": ["admin"]}, andtypeis required.../api/auth/ManagerAPI.java:195manager_creator/manager_create{"user", "type", "graphspace"}.../api/auth/ManagerAPI.java:115{"roles": {"boss": ["READ", ...]}}{"user", "graphspace", "roles"}over ADMIN/SPACE/SPACE_MEMBER/NONE.../api/auth/ManagerAPI.java:261managers/defaultwas missing.../api/auth/ManagerAPI.java:267{"users": [...]}list wrapper; several 204 sections carried a1body.../api/auth/UserAPI.java:134,.../api/auth/UserAPI.java:164name; belongs/accesses list params omitted their filters; modify-user claimeduser_namecan change.../api/auth/UserAPI.java:192,.../api/auth/UserAPI.java:105,.../api/auth/BelongAPI.java:119,.../api/auth/AccessAPI.java:137name,nickname,backend,description; the optional config fields and their defaults are listed.../api/profile/GraphsAPI.java:452,.../api/profile/GraphsAPI.java:527,.../api/profile/GraphsAPI.java:483.../api/profile/GraphsAPI.java:716,hugegraph-server/hugegraph-core/src/main/java/org/apache/hugegraph/type/define/GraphMode.java:46GET .../graphs/profile, the{name}/defaultset/unset andgraphs/defaultread,PUT .../graphs/{name}withaction=update, andPUT .../graphs/managewithaction=reload.../api/profile/GraphsAPI.java:142,.../api/profile/GraphsAPI.java:252,.../api/profile/GraphsAPI.java:306,.../api/profile/GraphsAPI.java:349,.../api/profile/GraphsAPI.java:428.../api/raft/RaftAPI.java:57nicknamenickname.../api/space/GraphSpaceAPI.java:588hugegraph-server/hugegraph-core/src/main/java/org/apache/hugegraph/space/GraphSpace.java:366,.../api/space/GraphSpaceAPI.java:99POST/GET/DELETE /graphspaces/{gs}/role,GET /graphspaces/profileand the five schematemplates endpoints.../api/space/GraphSpaceAPI.java:114,.../api/space/GraphSpaceAPI.java:271,.../api/space/SchemaTemplateAPI.java:57### 3.2heading split the overview list in the en page.../api/traversers/AdamicAdarAPI.java:52,.../api/traversers/ResourceAllocationAPI.java:52,.../api/traversers/EdgeExistenceAPI.java:47,.../api/traversers/CountAPI.java:55{"cancelled": true}body; list/get/delete params were incompleteids,page, thelimitdefault,with_resultandforce, and the full status list.../api/job/TaskAPI.java:203,.../api/job/TaskAPI.java:80,.../api/job/TaskAPI.java:143,.../api/job/TaskAPI.java:165.../api/job/AlgorithmAPI.java:50,hugegraph-server/hugegraph-core/src/main/java/org/apache/hugegraph/job/algorithm/AlgorithmPool.java:46,.../api/job/ComputerAPI.java:50,hugegraph-server/hugegraph-core/src/main/java/org/apache/hugegraph/job/computer/ComputerPool.java:27action=appendoraction=eliminate.../api/schema/IndexLabelAPI.java:97topdefault was 100 andskip_degreewas missing; personal rank depth range was [2, 50]topdefaults to 10,skip_degreedocumented, depth range is [2, 5000].../api/traversers/NeighborRankAPI.java:133,.../api/traversers/NeighborRankAPI.java:131,.../api/traversers/PersonalRankAPI.java:85keep_start_pandoffset, and claimedpageforbids other paramsoffsetonly.../api/graph/VertexAPI.java:254,.../api/graph/VertexAPI.java:267.../api/cypher/CypherAPI.java:139auth.token_secretguidance did not mention the random default; theauth.admin_pacomment described it as PD-onlyauth.admin_pahugegraph-server/hugegraph-core/src/main/java/org/apache/hugegraph/config/AuthOptions.java:71,.../config/ServerOptions.java:481confdirectory already containshugegraph-server.keystorebin/start-hugegraph.shdownloads it on the first HTTPS starthugegraph-server/hugegraph-dist/src/assembly/static/bin/start-hugegraph.sh:84,hugegraph-server/hugegraph-dist/pom.xml:226hugegraph-server/hugegraph-core/src/main/java/org/apache/hugegraph/type/define/GraphMode.java:46"task.scheduler_type": "distributed"for the hstore backend, and the hstore example body carried the keyhugegraph-server/hugegraph-core/src/main/java/org/apache/hugegraph/StandardHugeGraph.java:229,hugegraph-server/hugegraph-core/src/main/java/org/apache/hugegraph/StandardHugeGraph.java:1652Versioning call on the hstore note: the sentence stays, saying the key was needed on 1.7.0 and earlier and is now deprecated and ignored, because the site publishes 1.7 and 1.5 builds and the sibling NPE note on the same page already carries its version history the same way. The "(for version 1.7.0 and earlier)" qualifier on the example heading was dropped instead, since with the key gone that example applies to every version.