Skip to content

docs: Surface Cypher in overviews + minor repo cleanup#1393

Merged
bplatz merged 3 commits into
mainfrom
docs/cleanup
Jul 5, 2026
Merged

docs: Surface Cypher in overviews + minor repo cleanup#1393
bplatz merged 3 commits into
mainfrom
docs/cleanup

Conversation

@bplatz

@bplatz bplatz commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Small docs + housekeeping pass.

Docs: Cypher (openCypher) is a supported read/write surface alongside JSON-LD Query and SPARQL, but several overview/reference docs still enumerated only "JSON-LD and SPARQL". Updated the query, transaction, getting-started, and CLI/API docs to name all three languages and document the previously-missing CLI (--cypher / --format cypher) and HTTP (Content-Type: application/cypher) entry points.

Cleanup:

  • Removed scripts/import-memory-repro.sh (one-off debug repro) and its dangling doc-comment reference
  • Untracked .cursor/ editor config and added it to .gitignore (kept locally)

bplatz added 2 commits June 30, 2026 07:25
Cypher (openCypher) is a supported read/write surface alongside JSON-LD
Query and SPARQL, but several overview and reference docs still enumerated
only "JSON-LD and SPARQL". Update them to name all three languages and
document the previously-missing CLI and HTTP Cypher entry points.

- query/README.md: add Cypher as a third query language with examples
- getting-started quickstarts + tutorial + concepts: name all three surfaces
- api/endpoints.md, api/overview.md, operations/running-fluree.md:
  document Content-Type: application/cypher on the ledger-scoped routes
- transactions overview/README: add Cypher as a write format
- cli/query.md, cli/update.md, cli/README.md: document --cypher /
  --format cypher and the format auto-detection rules
- drop "openCypher subset" phrasing in favor of the support matrix
- Delete scripts/import-memory-repro.sh (one-off cgroup OOM repro) and
  drop its now-dangling reference from the stress_upload_memory doc comment
- Untrack .cursor/ and gitignore it (kept locally, editor-specific)
@bplatz bplatz requested review from aaj3f and zonotope June 30, 2026 11:29

@aaj3f aaj3f left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

👍

with `Content-Type: application/cypher` to the ledger-scoped query endpoint:

```bash
curl -X POST http://localhost:8090/v1/fluree/query/mydb/main \

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should this be mydb:main?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Addressed in 463c548

The greedy /query/*ledger tail captures the path literally, so the
slash form resolved to a ledger named 'mydb/main'. Match the colon
convention used everywhere else in the docs.
@bplatz bplatz merged commit 36de546 into main Jul 5, 2026
13 checks passed
@bplatz bplatz deleted the docs/cleanup branch July 5, 2026 12:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants