This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git
The following commit(s) were added to refs/heads/master by this push:
new dcce377f46 ISIS-3255: updates docs/javadocs is all.
dcce377f46 is described below
commit dcce377f46b5c164aab3b7e5a15aecc38736a45d
Author: Dan Haywood <d...@haywood-associates.co.uk>
AuthorDate: Tue Nov 29 17:47:22 2022 +0000
ISIS-3255: updates docs/javadocs is all.
---
.../HasInteractionId_commandLogEntry.java | 11 +++++++++++
.../HasUsername_recentCommandsByUser.java | 6 ++++++
.../contributions/Object_recentCommands.java | 2 +-
.../dom/mixins/CommandLogEntry_childCommands.java | 2 ++
.../mixins/CommandLogEntry_openResultObject.java | 3 +++
.../mixins/CommandLogEntry_siblingCommands.java | 3 +++
.../subscriber/CommandSubscriberForCommandLog.java | 3 +++
.../extensions/excel/applib/ExcelService.java | 22 ++++++++++++----------
.../excel/applib/service/ExcelServiceDefault.java | 10 +++++++---
.../excel/applib/service/_ExcelServiceHelper.java | 2 --
.../HasInteractionId_executionLogEntries.java | 10 ++++++++++
.../HasUsername_recentExecutionsByUser.java | 5 +++++
.../contributions/Object_recentExecutions.java | 2 +-
.../applib/dom/ExecutionLogEntryType.java | 3 +++
.../ExecutionLogEntry_siblingExecutions.java | 2 ++
.../applib/dom/ExecutionOutboxEntryType.java | 4 ++++
.../applib/restapi/OutboxEvents.java | 10 ++++++++++
.../applib/restapi/OutboxRestApi.java | 4 ++++
.../ContentMappingServiceForOutboxEvents.java | 1 +
19 files changed, 88 insertions(+), 17 deletions(-)
diff --git
a/extensions/core/commandlog/applib/src/main/java/org/apache/causeway/extensions/commandlog/applib/contributions/HasInteractionId_commandLogEntry.java
b/extensions/core/commandlog/applib/src/main/java/org/apache/causeway/extensions/commandlog/applib/contributions/HasInteractionId_commandLogEntry.java
index 275a6fb75f..d3c4fd98a9 100644
---
a/extensions/core/commandlog/applib/src/main/java/org/apache/causeway/extensions/commandlog/applib/contributions/HasInteractionId_commandLogEntry.java
+++
b/extensions/core/commandlog/applib/src/main/java/org/apache/causeway/extensions/commandlog/applib/contributions/HasInteractionId_commandLogEntry.java
@@ -36,6 +36,17 @@ import
org.apache.causeway.extensions.commandlog.applib.dom.CommandLogEntryRepos
import lombok.RequiredArgsConstructor;
/**
+ * Contributes a <code>commandLogEntry</code> property to any object
implementing {@link HasInteractionId}, in other
+ * words the command giving rise or related to the implementing object.
+ *
+ * <p>
+ * For example, the <code>AuditTrailEntry</code> entity (in the <i>audit
trail</i> extension), or the
+ * <code>ExecutionLogEntry</code> entity (in the <i>execution log</i>
extension) both implement
+ * {@link HasInteractionId}.
+ * </p>
+ *
+ *
+ *
* @since 2.x {@index}
*/
@Property(
diff --git
a/extensions/core/commandlog/applib/src/main/java/org/apache/causeway/extensions/commandlog/applib/contributions/HasUsername_recentCommandsByUser.java
b/extensions/core/commandlog/applib/src/main/java/org/apache/causeway/extensions/commandlog/applib/contributions/HasUsername_recentCommandsByUser.java
index 71f44f3a45..76ea8feca1 100644
---
a/extensions/core/commandlog/applib/src/main/java/org/apache/causeway/extensions/commandlog/applib/contributions/HasUsername_recentCommandsByUser.java
+++
b/extensions/core/commandlog/applib/src/main/java/org/apache/causeway/extensions/commandlog/applib/contributions/HasUsername_recentCommandsByUser.java
@@ -35,6 +35,12 @@ import lombok.val;
/**
+ * Contributes the <code>recentCommandsByUser</code> collection to any domain
object implementing {@link HasUsername}.
+ *
+ * <p>
+ * For example the <i>secman</i> extension's <code>ApplicationUser</code>
entity implements this interface.
+ * </p>
+ *
* @since 2.0 {@index}
*/
@Collection(
diff --git
a/extensions/core/commandlog/applib/src/main/java/org/apache/causeway/extensions/commandlog/applib/contributions/Object_recentCommands.java
b/extensions/core/commandlog/applib/src/main/java/org/apache/causeway/extensions/commandlog/applib/contributions/Object_recentCommands.java
index f58e4d6eda..e3073b03f5 100644
---
a/extensions/core/commandlog/applib/src/main/java/org/apache/causeway/extensions/commandlog/applib/contributions/Object_recentCommands.java
+++
b/extensions/core/commandlog/applib/src/main/java/org/apache/causeway/extensions/commandlog/applib/contributions/Object_recentCommands.java
@@ -38,7 +38,7 @@ import
org.apache.causeway.extensions.commandlog.applib.dom.CommandLogEntryRepos
import lombok.RequiredArgsConstructor;
/**
- * This mixin contributes a <tt>recentCommands</tt> action to any domain object
+ * Contributes a <tt>recentCommands</tt> action to any domain object
* (unless also {@link HasInteractionId} - commands don't themselves have
commands).
*
* @since 2.0 {@index}
diff --git
a/extensions/core/commandlog/applib/src/main/java/org/apache/causeway/extensions/commandlog/applib/dom/mixins/CommandLogEntry_childCommands.java
b/extensions/core/commandlog/applib/src/main/java/org/apache/causeway/extensions/commandlog/applib/dom/mixins/CommandLogEntry_childCommands.java
index 424cd30ea1..8cffe3195d 100644
---
a/extensions/core/commandlog/applib/src/main/java/org/apache/causeway/extensions/commandlog/applib/dom/mixins/CommandLogEntry_childCommands.java
+++
b/extensions/core/commandlog/applib/src/main/java/org/apache/causeway/extensions/commandlog/applib/dom/mixins/CommandLogEntry_childCommands.java
@@ -31,6 +31,8 @@ import lombok.RequiredArgsConstructor;
/**
+ * Contributes the <code>childCommands</code> collection to {@link
CommandLogEntry} entity.
+ *
* @since 2.x {@index}
*/
@Collection(
diff --git
a/extensions/core/commandlog/applib/src/main/java/org/apache/causeway/extensions/commandlog/applib/dom/mixins/CommandLogEntry_openResultObject.java
b/extensions/core/commandlog/applib/src/main/java/org/apache/causeway/extensions/commandlog/applib/dom/mixins/CommandLogEntry_openResultObject.java
index 8df411acc1..186ec69f2b 100644
---
a/extensions/core/commandlog/applib/src/main/java/org/apache/causeway/extensions/commandlog/applib/dom/mixins/CommandLogEntry_openResultObject.java
+++
b/extensions/core/commandlog/applib/src/main/java/org/apache/causeway/extensions/commandlog/applib/dom/mixins/CommandLogEntry_openResultObject.java
@@ -33,6 +33,9 @@ import lombok.RequiredArgsConstructor;
import lombok.val;
/**
+ * Contributes an action to open the domain object that was the result of
invoking the command (represented in
+ * persistent form by the {@link CommandLogEntry}).
+ *
* @since 2.x {@index}
*/
@Action(
diff --git
a/extensions/core/commandlog/applib/src/main/java/org/apache/causeway/extensions/commandlog/applib/dom/mixins/CommandLogEntry_siblingCommands.java
b/extensions/core/commandlog/applib/src/main/java/org/apache/causeway/extensions/commandlog/applib/dom/mixins/CommandLogEntry_siblingCommands.java
index 0c1bf8f521..2ddc21c088 100644
---
a/extensions/core/commandlog/applib/src/main/java/org/apache/causeway/extensions/commandlog/applib/dom/mixins/CommandLogEntry_siblingCommands.java
+++
b/extensions/core/commandlog/applib/src/main/java/org/apache/causeway/extensions/commandlog/applib/dom/mixins/CommandLogEntry_siblingCommands.java
@@ -31,6 +31,9 @@ import
org.apache.causeway.extensions.commandlog.applib.dom.CommandLogEntryRepos
import lombok.RequiredArgsConstructor;
/**
+ * Contributes a <code>siblingCommands</code> collection to the {@link
CommandLogEntry}), in other words those
+ * commands to be run in the background that have the same originating
(parent) command.
+ *
* @since 2.x {@index}
*/
@Collection(
diff --git
a/extensions/core/commandlog/applib/src/main/java/org/apache/causeway/extensions/commandlog/applib/subscriber/CommandSubscriberForCommandLog.java
b/extensions/core/commandlog/applib/src/main/java/org/apache/causeway/extensions/commandlog/applib/subscriber/CommandSubscriberForCommandLog.java
index 8cf2cb39e9..867e971ab8 100644
---
a/extensions/core/commandlog/applib/src/main/java/org/apache/causeway/extensions/commandlog/applib/subscriber/CommandSubscriberForCommandLog.java
+++
b/extensions/core/commandlog/applib/src/main/java/org/apache/causeway/extensions/commandlog/applib/subscriber/CommandSubscriberForCommandLog.java
@@ -38,6 +38,9 @@ import lombok.val;
import lombok.extern.log4j.Log4j2;
/**
+ * Implementation of {@link CommandSubscriber} responsible for persisting the
{@link Command} as a
+ * {@link CommandLogEntry}.
+ *
* @since 2.0 {@index}
*/
@Service
diff --git
a/extensions/core/excel/applib/src/main/java/org/apache/causeway/extensions/excel/applib/ExcelService.java
b/extensions/core/excel/applib/src/main/java/org/apache/causeway/extensions/excel/applib/ExcelService.java
index ee15c8a7d9..6293d079b2 100644
---
a/extensions/core/excel/applib/src/main/java/org/apache/causeway/extensions/excel/applib/ExcelService.java
+++
b/extensions/core/excel/applib/src/main/java/org/apache/causeway/extensions/excel/applib/ExcelService.java
@@ -26,6 +26,8 @@ import org.apache.causeway.applib.value.Blob;
import org.apache.causeway.extensions.excel.applib.service.ExcelServiceDefault;
/**
+ *
+ * Provides a set of utilities
* @since 2.0 {@index}
*/
public interface ExcelService {
@@ -51,24 +53,24 @@ public interface ExcelService {
<T> Blob toExcel(List<T> domainObjects, Class<T> cls, String sheetName,
String fileName, InputStream in)
throws ExcelServiceDefault.Exception;
- <T> Blob toExcel(WorksheetContent worksheetContent, String fileName)
throws ExcelServiceDefault.Exception;
+ <T> Blob toExcel(WorksheetContent worksheetContent, String fileName)
throws ExcelService.Exception;
<T> Blob toExcel(WorksheetContent worksheetContent, String fileName,
InputStream in)
throws ExcelServiceDefault.Exception;
- Blob toExcel(List<WorksheetContent> worksheetContents, String fileName)
throws ExcelServiceDefault.Exception;
+ Blob toExcel(List<WorksheetContent> worksheetContents, String fileName)
throws ExcelService.Exception;
Blob toExcel(List<WorksheetContent> worksheetContents, String fileName,
InputStream in)
throws ExcelServiceDefault.Exception;
- <T> Blob toExcelPivot(List<T> domainObjects, Class<T> cls, String
fileName) throws ExcelServiceDefault.Exception;
+ <T> Blob toExcelPivot(List<T> domainObjects, Class<T> cls, String
fileName) throws ExcelService.Exception;
<T> Blob toExcelPivot(List<T> domainObjects, Class<T> cls, String
sheetName, String fileName)
throws ExcelServiceDefault.Exception;
- <T> Blob toExcelPivot(WorksheetContent worksheetContent, String fileName)
throws ExcelServiceDefault.Exception;
+ <T> Blob toExcelPivot(WorksheetContent worksheetContent, String fileName)
throws ExcelService.Exception;
- Blob toExcelPivot(List<WorksheetContent> worksheetContents, String
fileName) throws ExcelServiceDefault.Exception;
+ Blob toExcelPivot(List<WorksheetContent> worksheetContents, String
fileName) throws ExcelService.Exception;
/**
* Returns a list of objects for each line in the spreadsheet, of the
specified type.
@@ -78,21 +80,21 @@ public interface ExcelService {
* view model memento); otherwise the objects will be simple transient
objects.
* </p>
*/
- <T> List<T> fromExcel(Blob excelBlob, Class<T> cls, String sheetName)
throws ExcelServiceDefault.Exception;
+ <T> List<T> fromExcel(Blob excelBlob, Class<T> cls, String sheetName)
throws ExcelService.Exception;
<T> List<T> fromExcel(Blob excelBlob, Class<T> cls, String sheetName, Mode
mode)
throws ExcelServiceDefault.Exception;
- <T> List<T> fromExcel(Blob excelBlob, WorksheetSpec worksheetSpec) throws
ExcelServiceDefault.Exception;
+ <T> List<T> fromExcel(Blob excelBlob, WorksheetSpec worksheetSpec) throws
ExcelService.Exception;
- List<List<?>> fromExcel(Blob excelBlob, List<WorksheetSpec>
worksheetSpecs) throws ExcelServiceDefault.Exception;
+ List<List<?>> fromExcel(Blob excelBlob, List<WorksheetSpec>
worksheetSpecs) throws ExcelService.Exception;
- List<List<?>> fromExcel(Blob excelBlob, WorksheetSpec.Matcher matcher)
throws ExcelServiceDefault.Exception;
+ List<List<?>> fromExcel(Blob excelBlob, WorksheetSpec.Matcher matcher)
throws ExcelService.Exception;
List<List<?>> fromExcel(Blob excelBlob, WorksheetSpec.Matcher matcher,
WorksheetSpec.Sequencer sequencer)
throws ExcelServiceDefault.Exception;
- public static class Exception extends RecoverableException {
+ class Exception extends RecoverableException {
private static final long serialVersionUID = 1L;
diff --git
a/extensions/core/excel/applib/src/main/java/org/apache/causeway/extensions/excel/applib/service/ExcelServiceDefault.java
b/extensions/core/excel/applib/src/main/java/org/apache/causeway/extensions/excel/applib/service/ExcelServiceDefault.java
index e5c5bef3b5..82a8d747eb 100644
---
a/extensions/core/excel/applib/src/main/java/org/apache/causeway/extensions/excel/applib/service/ExcelServiceDefault.java
+++
b/extensions/core/excel/applib/src/main/java/org/apache/causeway/extensions/excel/applib/service/ExcelServiceDefault.java
@@ -40,6 +40,11 @@ import org.apache.causeway.applib.value.Blob;
import org.apache.causeway.commons.internal.collections._Lists;
+/**
+ * Implementation of {@link ExcelService}.
+ *
+ * @since 2.0 {@index}
+ */
@Service
@Named(ExcelServiceDefault.LOGICAL_TYPE_NAME)
@Priority(PriorityPrecedence.MIDPOINT)
@@ -50,14 +55,14 @@ public class ExcelServiceDefault implements ExcelService {
private _ExcelServiceHelper helper;
+ @Inject private ServiceInjector serviceInjector;
+
@PostConstruct
public void init() {
helper = new _ExcelServiceHelper();
serviceInjector.injectServicesInto(helper);
}
- // //////////////////////////////////////
-
@Override
public <T> Blob toExcel(
final List<T> domainObjects,
@@ -207,6 +212,5 @@ public class ExcelServiceDefault implements ExcelService {
return fromExcel(excelBlob, worksheetSpecs);
}
- @Inject private ServiceInjector serviceInjector;
}
diff --git
a/extensions/core/excel/applib/src/main/java/org/apache/causeway/extensions/excel/applib/service/_ExcelServiceHelper.java
b/extensions/core/excel/applib/src/main/java/org/apache/causeway/extensions/excel/applib/service/_ExcelServiceHelper.java
index 05ecf77b22..b5c71bb26f 100644
---
a/extensions/core/excel/applib/src/main/java/org/apache/causeway/extensions/excel/applib/service/_ExcelServiceHelper.java
+++
b/extensions/core/excel/applib/src/main/java/org/apache/causeway/extensions/excel/applib/service/_ExcelServiceHelper.java
@@ -174,8 +174,6 @@ class _ExcelServiceHelper {
}
- // //////////////////////////////////////
-
/**
* Returns a list of objects for each line in the spreadsheet, of the
specified type. The objects are read
diff --git
a/extensions/core/executionlog/applib/src/main/java/org/apache/causeway/extensions/executionlog/applib/contributions/HasInteractionId_executionLogEntries.java
b/extensions/core/executionlog/applib/src/main/java/org/apache/causeway/extensions/executionlog/applib/contributions/HasInteractionId_executionLogEntries.java
index a82dc391c6..f96a6ed5b2 100644
---
a/extensions/core/executionlog/applib/src/main/java/org/apache/causeway/extensions/executionlog/applib/contributions/HasInteractionId_executionLogEntries.java
+++
b/extensions/core/executionlog/applib/src/main/java/org/apache/causeway/extensions/executionlog/applib/contributions/HasInteractionId_executionLogEntries.java
@@ -32,6 +32,16 @@ import
org.apache.causeway.extensions.executionlog.applib.dom.ExecutionLogEntryR
import lombok.RequiredArgsConstructor;
/**
+ * Contributes a <code>executionLogEntries</code> collection to any object
implementing {@link HasInteractionId},
+ * in other words the executions that occurred relating to an
+ * {@link org.apache.causeway.applib.services.iactn.Interaction}.
+ *
+ * <p>
+ * For example, the <code>CommandLogEntry</code> (in the <i>command
log</i> extension) or the
+ * <code>AuditTrailEntry</code> entity (in the <i>audit trail</i>
extension) both implement
+ * {@link HasInteractionId}.
+ * </p>
+ *
* @since 2.x {@index}
*/
@Collection(
diff --git
a/extensions/core/executionlog/applib/src/main/java/org/apache/causeway/extensions/executionlog/applib/contributions/HasUsername_recentExecutionsByUser.java
b/extensions/core/executionlog/applib/src/main/java/org/apache/causeway/extensions/executionlog/applib/contributions/HasUsername_recentExecutionsByUser.java
index 52eb12bc56..f0a33295ea 100644
---
a/extensions/core/executionlog/applib/src/main/java/org/apache/causeway/extensions/executionlog/applib/contributions/HasUsername_recentExecutionsByUser.java
+++
b/extensions/core/executionlog/applib/src/main/java/org/apache/causeway/extensions/executionlog/applib/contributions/HasUsername_recentExecutionsByUser.java
@@ -35,6 +35,11 @@ import lombok.val;
/**
+ * Contributes the <code>recentExecutionsByUser</code> collection to any
domain object implementing {@link HasUsername}.
+ *
+ * <p>
+ * For example the <i>secman</i> extension's <code>ApplicationUser</code>
entity implements this interface.
+ * </p>
* @since 2.0 {@index}
*/
@Collection(
diff --git
a/extensions/core/executionlog/applib/src/main/java/org/apache/causeway/extensions/executionlog/applib/contributions/Object_recentExecutions.java
b/extensions/core/executionlog/applib/src/main/java/org/apache/causeway/extensions/executionlog/applib/contributions/Object_recentExecutions.java
index 848238adfa..73c9a1975d 100644
---
a/extensions/core/executionlog/applib/src/main/java/org/apache/causeway/extensions/executionlog/applib/contributions/Object_recentExecutions.java
+++
b/extensions/core/executionlog/applib/src/main/java/org/apache/causeway/extensions/executionlog/applib/contributions/Object_recentExecutions.java
@@ -38,7 +38,7 @@ import
org.apache.causeway.extensions.executionlog.applib.dom.ExecutionLogEntryR
import lombok.RequiredArgsConstructor;
/**
- * This mixin contributes a <tt>recentCommands</tt> action to any domain object
+ * Contributes a <tt>recentCommands</tt> action to any domain object
* (unless also {@link HasInteractionId} - commands don't themselves have
commands).
*
* @since 2.0 {@index}
diff --git
a/extensions/core/executionlog/applib/src/main/java/org/apache/causeway/extensions/executionlog/applib/dom/ExecutionLogEntryType.java
b/extensions/core/executionlog/applib/src/main/java/org/apache/causeway/extensions/executionlog/applib/dom/ExecutionLogEntryType.java
index dfc8630dd3..c4e46fc76d 100644
---
a/extensions/core/executionlog/applib/src/main/java/org/apache/causeway/extensions/executionlog/applib/dom/ExecutionLogEntryType.java
+++
b/extensions/core/executionlog/applib/src/main/java/org/apache/causeway/extensions/executionlog/applib/dom/ExecutionLogEntryType.java
@@ -19,6 +19,9 @@
package org.apache.causeway.extensions.executionlog.applib.dom;
/**
+ * Whether an {@link ExecutionLogEntry} persists an {@link
ExecutionLogEntryType#ACTION_INVOCATION action invocation}
+ * or a {@link ExecutionLogEntryType#PROPERTY_EDIT property edit}.
+ *
* @since 2.0 {@index}
*/
public enum ExecutionLogEntryType {
diff --git
a/extensions/core/executionlog/applib/src/main/java/org/apache/causeway/extensions/executionlog/applib/dom/mixins/ExecutionLogEntry_siblingExecutions.java
b/extensions/core/executionlog/applib/src/main/java/org/apache/causeway/extensions/executionlog/applib/dom/mixins/ExecutionLogEntry_siblingExecutions.java
index 29c29ffebf..421129dad1 100644
---
a/extensions/core/executionlog/applib/src/main/java/org/apache/causeway/extensions/executionlog/applib/dom/mixins/ExecutionLogEntry_siblingExecutions.java
+++
b/extensions/core/executionlog/applib/src/main/java/org/apache/causeway/extensions/executionlog/applib/dom/mixins/ExecutionLogEntry_siblingExecutions.java
@@ -33,6 +33,8 @@ import lombok.RequiredArgsConstructor;
import lombok.val;
/**
+ * Contributes a <code>siblingExecutions</code> collection to {@link
ExecutionLogEntry}.
+ *
* @since 2.0 {@index}
*/
@Collection(
diff --git
a/extensions/core/executionoutbox/applib/src/main/java/org/apache/causeway/extensions/executionoutbox/applib/dom/ExecutionOutboxEntryType.java
b/extensions/core/executionoutbox/applib/src/main/java/org/apache/causeway/extensions/executionoutbox/applib/dom/ExecutionOutboxEntryType.java
index 8959c05e6c..3a3e4fbe04 100644
---
a/extensions/core/executionoutbox/applib/src/main/java/org/apache/causeway/extensions/executionoutbox/applib/dom/ExecutionOutboxEntryType.java
+++
b/extensions/core/executionoutbox/applib/src/main/java/org/apache/causeway/extensions/executionoutbox/applib/dom/ExecutionOutboxEntryType.java
@@ -19,6 +19,10 @@
package org.apache.causeway.extensions.executionoutbox.applib.dom;
/**
+ * Whether an {@link ExecutionOutboxEntry} persists an
+ * {@link ExecutionOutboxEntryType#ACTION_INVOCATION action invocation} or a
+ * {@link ExecutionOutboxEntryType#PROPERTY_EDIT property edit}.
+ *
* @since 2.0 {@index}
*/
public enum ExecutionOutboxEntryType {
diff --git
a/extensions/core/executionoutbox/applib/src/main/java/org/apache/causeway/extensions/executionoutbox/applib/restapi/OutboxEvents.java
b/extensions/core/executionoutbox/applib/src/main/java/org/apache/causeway/extensions/executionoutbox/applib/restapi/OutboxEvents.java
index 3c483e573f..447cbbb78e 100644
---
a/extensions/core/executionoutbox/applib/src/main/java/org/apache/causeway/extensions/executionoutbox/applib/restapi/OutboxEvents.java
+++
b/extensions/core/executionoutbox/applib/src/main/java/org/apache/causeway/extensions/executionoutbox/applib/restapi/OutboxEvents.java
@@ -44,7 +44,17 @@ import lombok.NoArgsConstructor;
import lombok.Setter;
/**
+ * Wrapper around a collection of {@link ExecutionOutboxEntry outbox entries}.
+ *
+ * <p>
+ * This class is used as the return value of {@link
OutboxRestApi#pending()}. The <i>outbox client</i> calls this
+ * with an HTTP <code>Accept</code> header set to {@link
org.apache.causeway.schema.ixn.v2.InteractionsDto} so that
+ * it is serialized into a list of {@link
org.apache.causeway.applib.services.iactn.Interaction}s for processing.
+ * </p>
+ *
* @since 2.0 {@index}
+ *
+ * @see OutboxRestApi#pending()
*/
@XmlRootElement
@XmlType(
diff --git
a/extensions/core/executionoutbox/applib/src/main/java/org/apache/causeway/extensions/executionoutbox/applib/restapi/OutboxRestApi.java
b/extensions/core/executionoutbox/applib/src/main/java/org/apache/causeway/extensions/executionoutbox/applib/restapi/OutboxRestApi.java
index 61645f7314..2e5986471c 100644
---
a/extensions/core/executionoutbox/applib/src/main/java/org/apache/causeway/extensions/executionoutbox/applib/restapi/OutboxRestApi.java
+++
b/extensions/core/executionoutbox/applib/src/main/java/org/apache/causeway/extensions/executionoutbox/applib/restapi/OutboxRestApi.java
@@ -40,6 +40,10 @@ import lombok.RequiredArgsConstructor;
import lombok.val;
/**
+ * Provides a server-side REST API for the <i>outbox rest client</i> to call,
to first obtain {@link #pending() pending}
+ * {@link ExecutionOutboxEntry outbox entries} to be processed, and then later
to request them to be
+ * {@link #deleteMany(String) deleted}.
+ *
* @since 2.0 {@index}
*/
@Named(OutboxRestApi.LOGICAL_TYPE_NAME)
diff --git
a/extensions/core/executionoutbox/applib/src/main/java/org/apache/causeway/extensions/executionoutbox/applib/spiimpl/ContentMappingServiceForOutboxEvents.java
b/extensions/core/executionoutbox/applib/src/main/java/org/apache/causeway/extensions/executionoutbox/applib/spiimpl/ContentMappingServiceForOutboxEvents.java
index 474df19520..cf3fa5635b 100644
---
a/extensions/core/executionoutbox/applib/src/main/java/org/apache/causeway/extensions/executionoutbox/applib/spiimpl/ContentMappingServiceForOutboxEvents.java
+++
b/extensions/core/executionoutbox/applib/src/main/java/org/apache/causeway/extensions/executionoutbox/applib/spiimpl/ContentMappingServiceForOutboxEvents.java
@@ -35,6 +35,7 @@ import org.apache.causeway.schema.ixn.v2.InteractionsDto;
import lombok.val;
/**
+ * Implementation of {@link ContentMappingService} that is responsible for
serializing a list of
* @since 2.0 {@index}
*/
@Service
