bitflicker64 commented on code in PR #557: URL: https://github.com/apache/hugegraph-doc/pull/557#discussion_r4435960373
########## content/en/docs/clients/restful-api/_index.md: ########## @@ -1,18 +1,17 @@ --- title: "HugeGraph RESTful API" linkTitle: "RESTful API" -weight: 1 +weight: 2 search_keywords: [HugeGraph REST API, RESTful API, OpenAPI] search_boost: 1.7 description: "HugeGraph RESTful API reference for graph, schema, vertex, and edge operations." --- -> This section documents the REST API on current master. For historical APIs, switch to the versioned [HugeGraph 1.7 RESTful API documentation](https://hugegraph.apache.org/versions/1.7/docs/clients/restful-api/) or Review Comment: **Minor: version notes removed from REST pages that the navigation change doesn't touch.** This banner said the section documents the REST API on current master, and linked the 1.7 and 1.5 RESTful API docs. The PR also removes similar notes: - the version note in `auth.md`; - the master/1.7/1.5 note in `graphs.md`, together with the "`POST /graphs` is not the graph-creation endpoint" warning and the note about older `GET /apis` paths; - the CN copies of all of these. Latest maps to master, so a reader running a 1.7 server loses the hint that these pages describe unreleased behavior. Please keep these notes unless removing them is intended; if it is, a sentence in the PR description would help. ########## content/en/docs/clients/restful-api/cypher.md: ########## @@ -91,24 +90,87 @@ POST /graphspaces/{graphspace}/graphs/{graph}/cypher Note: -> It is not in JSON format, but a plain text Cypher statement. +> The request body contains the raw Cypher text statement rather than a JSON object. However, because the server endpoint uses `@Consumes(APPLICATION_JSON)`, requests must include `-H "Content-Type: application/json"` (requests sent with `text/plain` are rejected with HTTP 415). Review Comment: **Minor: "rather than a JSON object" can mislead.** The same endpoint also parses a JSON object body (`CypherAPI#post`; see 9.1.3). A raw query whose first character is `{`, `[`, `"` or a digit is treated as JSON and can be rejected with 400. Suggested wording: "a raw Cypher string (a JSON object body is also accepted; see 9.1.3)". The CN copy has the same sentence. ########## content/en/docs/clients/client/hugegraph-client.md: ########## @@ -167,7 +556,7 @@ The constraint information that PropertyKey allows to define includes: name, dat |------------------------------------|------------------------------------------------| | userdata(String key, Object value) | The same key, the latter will cover the former | -##### 2.2.2 Create PropertyKey +##### 6.2.2 Create PropertyKey Review Comment: **Minor: old deep-section anchors are still lost.** `{#22-propertykey}` keeps the old anchor for this group, but subsections such as `6.2.2 Create PropertyKey` don't keep theirs. The old page generated `#222-create-propertykey`, so bookmarked or shared deep links from the old `clients/hugegraph-client/` page now land at the top of the page. The same happens on the CN page. If old deep links should keep working, add explicit IDs for the renumbered subsections in the same way, for example `{#222-create-propertykey}`. -- 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]
