Skip to content

Enhance documentation#231

Merged
otaviojava merged 21 commits into
mainfrom
documentation
May 14, 2026
Merged

Enhance documentation#231
otaviojava merged 21 commits into
mainfrom
documentation

Conversation

@otaviojava
Copy link
Copy Markdown
Contributor

This pull request introduces the new Communication API to Jakarta NoSQL, providing a minimal and extensible foundation for interacting with various NoSQL database models (key-value, document, column, and graph) while preserving native database semantics. The changes include comprehensive documentation updates, new API module exports, and detailed package-level descriptions for each communication model.

Introduction of the Communication API:

  • Added the Communication API, which defines a minimal, extensible, and provider-neutral foundation for low-level operations (store, retrieve, replace, remove) across NoSQL databases, with an emphasis on extensibility and preservation of native database semantics. [1] [2] [3] [4]

Documentation and Usage Examples:

  • Expanded the README.adoc with detailed explanations and code samples for the key-value, document, column, and graph communication models, illustrating how to interact with each NoSQL paradigm using the new API.
  • Updated the changelog to reflect the introduction of the Communication API.

API and Module Enhancements:

  • Enhanced the module-info.java to export new communication model packages (document, keyvalue, column, graph) and provided a detailed module-level description of the Communication API’s purpose and design principles.

Package-Level Documentation:

  • Added comprehensive JavaDoc to the root communication package and each subpackage, clearly describing the intent, design, and extensibility of the Communication API, with specific focus on the graph communication model. [1] [2]

otaviojava added 21 commits May 13, 2026 17:09
@otaviojava otaviojava merged commit 16fafc5 into main May 14, 2026
3 checks passed
@otaviojava otaviojava deleted the documentation branch May 14, 2026 18:30
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.

1 participant