Skip to content

Documentation update#659

Open
fh-ms wants to merge 4 commits intomainfrom
docs-update
Open

Documentation update#659
fh-ms wants to merge 4 commits intomainfrom
docs-update

Conversation

@fh-ms
Copy link
Copy Markdown
Contributor

@fh-ms fh-ms commented Apr 29, 2026

Summary

Documentation roll-up on the docs-update branch covering four independent improvements:

  • REST API reference (7f8232b) — expand docs/modules/storage/pages/rest-interface/rest-api.adoc with the full set of endpoints, response structures, and worked examples.
  • Spark Java REST service deprecation (16df246) — mark the SparkJava-based REST service as deprecated and steer readers towards the Javalin and Spring Boot alternatives. Removes Spark-specific setup/install instructions from the docs and updates the module's README.md accordingly.
  • Storage queries guide (433a290) — rewrite and substantially expand docs/modules/storage/pages/queries.adoc with examples, comparisons, and best-practice guidance.
  • GigaMap indexer name uniqueness (6fcd977, closes Indexers names clarification #528) — add an IMPORTANT admonition to docs/modules/gigamap/pages/indexing/bitmap/defining.adoc and rewrite the Javadoc on BitmapIndices.add(Indexer) and Indexer.Abstract so the uniqueness contract is discoverable from both the docs site and the API reference. Also fixes the existing @throws IllegalStateException claim on add(Indexer) (the impl throws RuntimeException) and drops a stale "Shortcut for add(indexer.name(), indexer)" reference to a non-existent overload.

@fh-ms fh-ms requested a review from zdenek-jonas April 29, 2026 14:34
@fh-ms fh-ms added the documentation Improvements or additions to documentation label Apr 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Indexers names clarification

2 participants