Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: update outdated doc for edge api #276

Merged
merged 4 commits into from
Jun 29, 2023

Conversation

VGalaxies
Copy link
Contributor

@VGalaxies VGalaxies commented Jun 21, 2023

SubTask of [Improvement] RESTful API request/response content need update #260

Fix this page: https://hugegraph.apache.org/cn/docs/clients/restful-api/edge/

I use Postman to test the Edge APIs, and this is the corresponding test configuration collection. By importing and executing it in the order specified in the documentation, theoretically consistent results can be observed.

The server is deployed locally and can be accessed at 127.0.0.1:8080.

By the way, I'm not quite clear about the usage of the keepStartP request parameter in the list API.

EN doc will be synchronized later.

Copy link
Member

@imbajin imbajin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good job


##### Method & Url

```
GET http://127.0.0.1:8080/graphs/hugegraph/graph/edges?vertex_id="1:josh"&direction=BOTH&label=created&properties={}
GET http://127.0.0.1:8080/graphs/hugegraph/graph/edges?vertex_id="1:marko"&label=knows
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why we remove property condiment here? maybe we need provide a demo for users to refer

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because the property parameter did not work in the previous example. Now I have updated this example.

content/cn/docs/clients/restful-api/edge.md Outdated Show resolved Hide resolved

--------------------------------------------------------------------------------

接下来的示例均假设已经创建好了前述的各种schema和vertex信息
接下来的示例需要先根据以下 `groovy` 脚本创建图 `schema`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

可以使用统一的测试用例导入, 但需要确保其他的 case 里是一致的为宜 @liuxiaocs7

你之前也是用的这个 dataset 么

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

大体一致,我这里直接使用了 example.groovy 这个脚本的部分内容,有些细节和 @liuxiaocs7 使用的 schema 不太一样。

Copy link
Member

@imbajin imbajin Jun 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

大体一致,我这里直接使用了 example.groovy 这个脚本的部分内容,有些细节和 @liuxiaocs7 使用的 schema 不太一样。

OK, looks fine to me, wait @liuxiaocs7 to review

Copy link
Member

@liuxiaocs7 liuxiaocs7 Jun 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The previously used schema is a reference to the content of the Loader and made some minor changes, because only the operation of the vertex is involved, here there will be edge operations, i think ok here

@VGalaxies VGalaxies requested a review from imbajin June 26, 2023 06:38
javeme
javeme previously approved these changes Jun 27, 2023
Copy link
Contributor

@javeme javeme left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@javeme
Copy link
Contributor

javeme commented Jun 27, 2023

By the way, I'm not quite clear about the usage of the keepStartP request parameter in the list API.

the keepStartP=true param means a value like "P.gt(18)" is a normal string.

@VGalaxies
Copy link
Contributor Author

By the way, I'm not quite clear about the usage of the keepStartP request parameter in the list API.

the keepStartP=true param means a value like "P.gt(18)" is a normal string.

Got it. I mentioned it in the documentation.

Copy link
Member

@liuxiaocs7 liuxiaocs7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've tested it locally, looks good to me, looking forward to the English documentation update

@VGalaxies
Copy link
Contributor Author

EN doc has been synchronized.

@imbajin imbajin merged commit 59f96c0 into apache:master Jun 29, 2023
github-actions bot pushed a commit that referenced this pull request Jun 29, 2023
* doc: add example for edge properties query

* doc: sync edge api EN doc 59f96c0
github-actions bot pushed a commit to zoroqi/incubator-hugegraph-doc that referenced this pull request Jul 29, 2023
* doc: add example for edge properties query

* doc: sync edge api EN doc 59f96c0
@VGalaxies VGalaxies deleted the fix-edge-response branch December 17, 2023 11:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants