Skip to content

DOC-827 | Graph Analytics: Clarify descriptions and endpoint URL paths #841

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.

Sign up for GitHub

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

Open
nerpaula wants to merge 3 commits into
base: main
Choose a base branch
from
Open

DOC-827 | Graph Analytics: Clarify descriptions and endpoint URL paths #841

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
73a95f7
better description for endpoints URLs
nerpaula Nov 27, 2025
445eea5
Updated endpoint URLs and examples for clarity and structure; separat…
nerpaula Dec 10, 2025
b0a69fc
Add endpoint shortcode, improve example values
Simran-B Dec 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 27 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -484,11 +484,36 @@ If you want to place a remark in the source files that should not end up in the
generated output, you can use a comment as follows:

```markdown
{{% comment %}}
{{< comment >}}
Content or reminder that should not be rendered.
{{% /comment %}}
{{< /comment >}}
```

#### Endpoints

You can display endpoint URLs of HTTP APIs with some formatting to make them
look neater:

```markdown
{{< endpoint "METHOD" "https://<PLACEHOLDER>:8529/path/{PARAM}/action">}}
```

Available positional parameters:

1. The HTTP method. Possible values: `HEAD`, `GET`, `POST`, `PATCH`, `PUT`, `DELETE`,
or empty string (`""`) to omit the method.

2. The URL, which can include the protocol, host, port, path, and query parameters.

You can wrap path parameters that the user is supposed to fill in with curly
braces, e.g. `{GRAPH_ID}`. This is rendered as `:GRAPH_ID` for compatibility
with tools like Postman and it is highlighted to make it visually distinct
from static parts of the URL.

You can wrap any other placeholders that the user is supposed to substitute
in angled brackets, e.g. `<EXTERNAL_ENDPOINT>`. This is rendered verbatim and
it is highlighted to make it visually distinct from static parts of the URL.

#### Special shortcodes

The following shortcodes also exist but are rarely used:
Expand Down
Loading