Skip to content

Commit d9b39f3

Browse files
authored
Add missing API docs (#1044)
1 parent da00c6c commit d9b39f3

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

project-management/src/main/java/life/qbic/projectmanagement/application/api/AsyncProjectService.java

+18-3
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@
2323
public interface AsyncProjectService {
2424

2525
/**
26-
* Submits a project update request and returns a reactive {@link Mono< ProjectUpdateResponse >}
26+
* Submits a project update request and returns a reactive {@link Mono<ProjectUpdateResponse>}
2727
* object immediately.
2828
* <p>
29-
* The method is non-blocking.
29+
* The method implementation must be non-blocking.
3030
* <p>
3131
* The implementing class must ensure to be able to process all implementing classes of the
3232
* {@link UpdateRequestBody} interface contained in the request.
@@ -47,6 +47,20 @@ Mono<ProjectUpdateResponse> update(
4747
throws UnknownRequestException, RequestFailedException, AccessDeniedException;
4848

4949

50+
/**
51+
* Submits a project creation request and returns a {@link Mono<ProjectCreationResponse>}
52+
* immediately.
53+
* <p>
54+
* This implementation must be non-blocking.
55+
*
56+
* @param request the request with information required for project creation.
57+
* @return {@link Mono<ProjectCreationResponse>} object publishing an
58+
* {@link ProjectCreationResponse} on success.
59+
* @throws UnknownRequestException if an unknown request has been used in the service call
60+
* @throws RequestFailedException if the request was not successfully executed
61+
* @throws AccessDeniedException if the user has insufficient rights
62+
* @since 1.9.0
63+
*/
5064
Mono<ProjectCreationResponse> create(ProjectCreationRequest request)
5165
throws UnknownRequestException, RequestFailedException, AccessDeniedException;
5266

@@ -191,7 +205,8 @@ public String requestId() {
191205
* @param responseBody the information that was updated.
192206
* @since 1.9.0
193207
*/
194-
record ProjectUpdateResponse(String projectId, UpdateResponseBody responseBody, String requestId) {
208+
record ProjectUpdateResponse(String projectId, UpdateResponseBody responseBody,
209+
String requestId) {
195210

196211
public ProjectUpdateResponse {
197212
if (projectId == null) {

0 commit comments

Comments
 (0)