imbajin commented on code in PR #500: URL: https://github.com/apache/hugegraph-doc/pull/500#discussion_r4106428227
########## content/en/docs/clients/restful-api/auth.md: ########## @@ -8,6 +8,13 @@ description: "Authentication REST API: Manage users, roles, permissions, and acc > **Version Change Notice**: > - 1.7.0+: Auth API paths use GraphSpace format, such as > `/graphspaces/DEFAULT/auth/users`, and group/target IDs match their names > (e.g., `admin`) > - 1.5.x and earlier: Auth API paths include graph name, and group/target IDs > use format like `-69:grant`. See [HugeGraph 1.5.x RESTful > API](https://github.com/apache/hugegraph-doc/tree/release-1.5.0) +> +> Group paths are the exception in 1.7.0: there `GroupAPI` is served at `/auth/groups` +> with no GraphSpace prefix, while on 1.5.x it carried the graph name +> (`/graphs/{graph}/auth/groups`) like the other auth APIs. The +> `/graphspaces/{graphspace}/auth/groups` forms below need a build that includes +> [apache/hugegraph#3096](https://github.com/apache/hugegraph/pull/3096), which is newer +> than the 1.7.0 release. On 1.7.0 the prefixed group path returns 404. Review Comment: 🧹 Minor: The route is unregistered on 1.7.0, but 404 is not unconditional. The 1.7.0 server runs `AuthenticationFilter` as `@PreMatching` before route matching and returns 401 for missing credentials (or 403 for a denied IP). Please describe the path as unregistered, or qualify the 404 as the result after authentication checks pass; mirror the correction in Chinese. ########## content/en/docs/clients/restful-api/auth.md: ########## @@ -246,6 +253,10 @@ GET http://localhost:8080/graphspaces/DEFAULT/auth/users/boss/role Groups grant corresponding resource permissions, and users are assigned to different groups, thereby having different resource permissions. The group interface includes APIs for creating groups, deleting groups, modifying groups, and querying group-related information. +> `GroupAPI` itself is served at `/auth/groups` with no GraphSpace prefix, and that is +> the only group path on 1.7.0. The `/graphspaces/DEFAULT/auth/groups` form used below +> needs a build containing [apache/hugegraph#3096](https://github.com/apache/hugegraph/pull/3096). + Review Comment: 🧹 Minor: The examples below are marked as requiring #3096 but still use `-69:all`/`-69:grant`. In `GraphSpaceGroupAPI.JsonGroup.build`, the server generates the persisted scoped group name from the GraphSpace prefix and a UUID, so these IDs do not identify the created GraphSpace group. Please update the response and follow-up requests to use the returned scoped ID, or mark the examples as legacy; mirror the correction in Chinese. -- 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]
