[OAK-11] Document and tighten contract of Microkernel API

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Won't Fix
• Component/s: mk
• Labels: api documentation
• Assignee: Julian Reschke
• Reporter: Michael Dürig
• Created: 13/Mar/12 11:40
• Updated: 10/Aug/15 10:09
• Resolved: 10/Aug/15 10:09

Description

We should do a review of the Microkernel API with the goal to clarify, disambiguate and document its contract.

Issue Links

• incorporates: OAK-75 specify format and semantics of 'filter' parameter in MicroKernel API
• incorporates: OAK-114 MicroKernel API: specify retention policy for old revisions
• incorporates: OAK-496 More specific error reporting for Microkernel.commit
• incorporates: OAK-674 Clarify MicroKernel.commit()
• incorporates: OAK-48 MicroKernel.getNodes() should return null for not existing nodes instead of throwing an exception
• incorporates: OAK-116 MicroKernel API: clarify semantics of getNodes depth, offset and count parameters
• incorporates: OAK-120 MicroKernel API: specific retention policy of binaries
• incorporates: OAK-142 MicroKernel API: returning the :hash property should be optional
• incorporates: OAK-1331 MicroKernel API: clarify semantics of `read` method
• incorporates: OAK-2160 mk.getRevisionHistory: clarify since parameter
• incorporates: OAK-239 MicroKernel.getRevisionHistory: maxEntries behavior should be documented
• is related to: OAK-442 Concurrently adding nodes fails with CommitFailedException