Skip to content

Commit 625f87d

Browse files
gkorlandCopilot
andcommitted
fix(docs): address review — add /api prefix, fix auth header, clean up README
- Add /api prefix to all curl URLs (graph_entities, chat, list_commits, switch_commit) - Standardize auth header to Bearer format - Rename 'History change' section to 'Commit history' - Remove SEO keywords line Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent cf62eb5 commit 625f87d

1 file changed

Lines changed: 6 additions & 8 deletions

File tree

README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -246,41 +246,39 @@ A C analyzer exists in the source tree, but it is commented out and is not curre
246246

247247
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
248248

249-
Knowledge Graph, Code Analysis, Code Visualization, Dead Code Analysis, Graph Database
250-
251249
## API Reference
252250

253251
### Retrieve a graph
254252

255253
Fetch graph entities from a repository:
256254

257255
```bash
258-
curl -X GET "http://127.0.0.1:5000/graph_entities?repo=<REPO_NAME>" -H "Authorization: ${SECRET_TOKEN}"
256+
curl -X GET "http://127.0.0.1:5000/api/graph_entities?repo=<REPO_NAME>" -H "Authorization: Bearer ${SECRET_TOKEN}"
259257
```
260258

261259
Example:
262260
```bash
263-
curl -X GET "http://127.0.0.1:5000/graph_entities?repo=GraphRAG-SDK" -H "Authorization: ${SECRET_TOKEN}"
261+
curl -X GET "http://127.0.0.1:5000/api/graph_entities?repo=GraphRAG-SDK" -H "Authorization: Bearer ${SECRET_TOKEN}"
264262
```
265263

266264
### Send Query
267265

268266
Query your code graph using natural language:
269267

270268
```bash
271-
curl -X POST http://127.0.0.1:5000/chat -H "Content-Type: application/json" -d '{"repo": "<REPO_NAME>", "msg": "<YOUR_QUESTION>"}' -H "Authorization: ${SECRET_TOKEN}"
269+
curl -X POST http://127.0.0.1:5000/api/chat -H "Content-Type: application/json" -d '{"repo": "<REPO_NAME>", "msg": "<YOUR_QUESTION>"}' -H "Authorization: Bearer ${SECRET_TOKEN}"
272270
```
273271

274-
### History change
272+
### Commit history
275273

276274
List all commits:
277275
```bash
278-
curl -X POST http://127.0.0.1:5000/list_commits -H "Content-Type: application/json" -d '{"repo": "<REPO_NAME>"}' -H "Authorization: ${SECRET_TOKEN}"
276+
curl -X POST http://127.0.0.1:5000/api/list_commits -H "Content-Type: application/json" -d '{"repo": "<REPO_NAME>"}' -H "Authorization: Bearer ${SECRET_TOKEN}"
279277
```
280278

281279
Switch to a specific commit:
282280
```bash
283-
curl -X POST http://127.0.0.1:5000/switch_commit -H "Content-Type: application/json" -d '{"repo": "<REPO_NAME>", "commit": "<COMMIT_HASH>"}' -H "Authorization: ${SECRET_TOKEN}"
281+
curl -X POST http://127.0.0.1:5000/api/switch_commit -H "Content-Type: application/json" -d '{"repo": "<REPO_NAME>", "commit": "<COMMIT_HASH>"}' -H "Authorization: Bearer ${SECRET_TOKEN}"
284282
```
285283

286284
Copyright FalkorDB Ltd. 2025

0 commit comments

Comments
 (0)