Repository: syncope
Updated Branches:
  refs/heads/2_0_X c7d5d2fc5 -> 5f381e176
  refs/heads/master 36e5aa901 -> 6498a0bf7


[SYNCOPE-1274] Add documentation for errors, X-Application-Error-Code, 
X-Application-Error-Info, X-Syncope-Null-Priority-Async


Project: http://git-wip-us.apache.org/repos/asf/syncope/repo
Commit: http://git-wip-us.apache.org/repos/asf/syncope/commit/5f381e17
Tree: http://git-wip-us.apache.org/repos/asf/syncope/tree/5f381e17
Diff: http://git-wip-us.apache.org/repos/asf/syncope/diff/5f381e17

Branch: refs/heads/2_0_X
Commit: 5f381e17632e5e865865c02b2ac3dfe067eb0a67
Parents: c7d5d2f
Author: Francesco Chicchiriccò <ilgro...@apache.org>
Authored: Mon Feb 19 10:52:39 2018 +0100
Committer: Francesco Chicchiriccò <ilgro...@apache.org>
Committed: Mon Feb 19 10:52:39 2018 +0100

----------------------------------------------------------------------
 .../rest/api/service/AccessTokenService.java    | 15 +++----
 .../rest/api/service/AnyObjectService.java      | 26 ++++++++----
 .../common/rest/api/service/AnyService.java     | 32 +++++++++++----
 .../common/rest/api/service/GroupService.java   | 26 ++++++++----
 .../common/rest/api/service/JAXRSService.java   | 17 ++++++++
 .../common/rest/api/service/RealmService.java   | 42 +++++++++++++-------
 .../common/rest/api/service/UserService.java    | 32 +++++++++++----
 7 files changed, 138 insertions(+), 52 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/syncope/blob/5f381e17/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/AccessTokenService.java
----------------------------------------------------------------------
diff --git 
a/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/AccessTokenService.java
 
b/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/AccessTokenService.java
index 24f242b..e585403 100644
--- 
a/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/AccessTokenService.java
+++ 
b/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/AccessTokenService.java
@@ -54,13 +54,14 @@ public interface AccessTokenService extends JAXRSService {
      */
     @ApiOperation(value = "", authorizations = {
         @Authorization(value = "BasicAuthentication") })
-    @ApiResponses(
-            @ApiResponse(code = 204,
-                    message = "JWT successfully generated", responseHeaders = {
-                @ResponseHeader(name = RESTHeaders.TOKEN, response = 
String.class,
-                        description = "Generated JWT")
-                , @ResponseHeader(name = RESTHeaders.TOKEN_EXPIRE, response = 
String.class,
-                        description = "Expiration of the generated JWT") }))
+    @ApiResponses({
+        @ApiResponse(code = 204,
+                message = "JWT successfully generated", responseHeaders = {
+                    @ResponseHeader(name = RESTHeaders.TOKEN, response = 
String.class,
+                            description = "Generated JWT")
+                    , @ResponseHeader(name = RESTHeaders.TOKEN_EXPIRE, 
response = String.class,
+                            description = "Expiration of the generated JWT") })
+        , @ApiResponse(code = 401, message = "Invalid username or password") })
     @POST
     @Path("login")
     @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })

http://git-wip-us.apache.org/repos/asf/syncope/blob/5f381e17/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/AnyObjectService.java
----------------------------------------------------------------------
diff --git 
a/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/AnyObjectService.java
 
b/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/AnyObjectService.java
index 8bd75cc..5a88467 100644
--- 
a/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/AnyObjectService.java
+++ 
b/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/AnyObjectService.java
@@ -72,11 +72,15 @@ public interface AnyObjectService extends 
AnyService<AnyObjectTO> {
      * @return Response object featuring Location header of created any object 
as well as the any
      * object itself enriched with propagation status information
      */
-    @ApiImplicitParams(
-            @ApiImplicitParam(name = RESTHeaders.PREFER, paramType = "header", 
dataType = "string",
-                    value = "Allows the client to specify a preference for the 
result to be returned from the server",
-                    defaultValue = "return-content", allowableValues = 
"return-content, return-no-content",
-                    allowEmptyValue = true))
+    @ApiImplicitParams({
+        @ApiImplicitParam(name = RESTHeaders.PREFER, paramType = "header", 
dataType = "string",
+                value = "Allows the client to specify a preference for the 
result to be returned from the server",
+                defaultValue = "return-content", allowableValues = 
"return-content, return-no-content",
+                allowEmptyValue = true)
+        , @ApiImplicitParam(name = RESTHeaders.NULL_PRIORITY_ASYNC, paramType 
= "header", dataType = "boolean",
+                value = "If 'true', instructs the propagation process not to 
wait for completion when communicating"
+                + " with External Resources with no priority set",
+                defaultValue = "false", allowEmptyValue = true) })
     @ApiResponses(
             @ApiResponse(code = 201,
                     message = "Any object successfully created enriched with 
propagation status information, as Entity,"
@@ -108,7 +112,11 @@ public interface AnyObjectService extends 
AnyService<AnyObjectTO> {
         , @ApiImplicitParam(name = HttpHeaders.IF_MATCH, paramType = "header", 
dataType = "string",
                 value = "When the provided ETag value does not match the 
latest modification date of the entity, "
                 + "an error is reported and the requested operation is not 
performed.",
-                allowEmptyValue = true) })
+                allowEmptyValue = true)
+        , @ApiImplicitParam(name = RESTHeaders.NULL_PRIORITY_ASYNC, paramType 
= "header", dataType = "boolean",
+                value = "If 'true', instructs the propagation process not to 
wait for completion when communicating"
+                + " with External Resources with no priority set",
+                defaultValue = "false", allowEmptyValue = true) })
     @ApiResponses({
         @ApiResponse(code = 200,
                 message = "Any object successfully updated enriched with 
propagation status information, as Entity",
@@ -141,7 +149,11 @@ public interface AnyObjectService extends 
AnyService<AnyObjectTO> {
         , @ApiImplicitParam(name = HttpHeaders.IF_MATCH, paramType = "header", 
dataType = "string",
                 value = "When the provided ETag value does not match the 
latest modification date of the entity, "
                 + "an error is reported and the requested operation is not 
performed.",
-                allowEmptyValue = true) })
+                allowEmptyValue = true)
+        , @ApiImplicitParam(name = RESTHeaders.NULL_PRIORITY_ASYNC, paramType 
= "header", dataType = "boolean",
+                value = "If 'true', instructs the propagation process not to 
wait for completion when communicating"
+                + " with External Resources with no priority set",
+                defaultValue = "false", allowEmptyValue = true) })
     @ApiResponses({
         @ApiResponse(code = 200,
                 message = "Any object successfully updated enriched with 
propagation status information, as Entity",

http://git-wip-us.apache.org/repos/asf/syncope/blob/5f381e17/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/AnyService.java
----------------------------------------------------------------------
diff --git 
a/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/AnyService.java
 
b/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/AnyService.java
index 2b9ff04..2a2fb64 100644
--- 
a/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/AnyService.java
+++ 
b/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/AnyService.java
@@ -153,7 +153,11 @@ public interface AnyService<TO extends AnyTO> extends 
JAXRSService {
         , @ApiImplicitParam(name = HttpHeaders.IF_MATCH, paramType = "header", 
dataType = "string",
                 value = "When the provided ETag value does not match the 
latest modification date of the entity, "
                 + "an error is reported and the requested operation is not 
performed.",
-                allowEmptyValue = true) })
+                allowEmptyValue = true)
+        , @ApiImplicitParam(name = RESTHeaders.NULL_PRIORITY_ASYNC, paramType 
= "header", dataType = "boolean",
+                value = "If 'true', instructs the propagation process not to 
wait for completion when communicating"
+                + " with External Resources with no priority set",
+                defaultValue = "false", allowEmptyValue = true) })
     @ApiResponses({
         @ApiResponse(code = 200,
                 message = "User, Group or Any Object successfully deleted 
enriched with propagation status information,"
@@ -186,7 +190,11 @@ public interface AnyService<TO extends AnyTO> extends 
JAXRSService {
         , @ApiImplicitParam(name = HttpHeaders.IF_MATCH, paramType = "header", 
dataType = "string",
                 value = "When the provided ETag value does not match the 
latest modification date of the entity, "
                 + "an error is reported and the requested operation is not 
performed.",
-                allowEmptyValue = true) })
+                allowEmptyValue = true)
+        , @ApiImplicitParam(name = RESTHeaders.NULL_PRIORITY_ASYNC, paramType 
= "header", dataType = "boolean",
+                value = "If 'true', instructs the propagation process not to 
wait for completion when communicating"
+                + " with External Resources with no priority set",
+                defaultValue = "false", allowEmptyValue = true) })
     @ApiResponses({
         @ApiResponse(code = 200, message = "Bulk action result", response = 
BulkActionResult.class)
         , @ApiResponse(code = 204,
@@ -217,7 +225,11 @@ public interface AnyService<TO extends AnyTO> extends 
JAXRSService {
         , @ApiImplicitParam(name = HttpHeaders.IF_MATCH, paramType = "header", 
dataType = "string",
                 value = "When the provided ETag value does not match the 
latest modification date of the entity, "
                 + "an error is reported and the requested operation is not 
performed.",
-                allowEmptyValue = true) })
+                allowEmptyValue = true)
+        , @ApiImplicitParam(name = RESTHeaders.NULL_PRIORITY_ASYNC, paramType 
= "header", dataType = "boolean",
+                value = "If 'true', instructs the propagation process not to 
wait for completion when communicating"
+                + " with External Resources with no priority set",
+                defaultValue = "false", allowEmptyValue = true) })
     @ApiResponses({
         @ApiResponse(code = 200, message = "Bulk action result", response = 
BulkActionResult.class)
         , @ApiResponse(code = 204,
@@ -240,11 +252,15 @@ public interface AnyService<TO extends AnyTO> extends 
JAXRSService {
      * @param bulkAction list of any object ids against which the bulk action 
will be performed.
      * @return Response object featuring BulkActionResult as Entity
      */
-    @ApiImplicitParams(
-            @ApiImplicitParam(name = RESTHeaders.PREFER, paramType = "header", 
dataType = "string",
-                    value = "Allows the client to specify a preference for the 
result to be returned from the server",
-                    defaultValue = "return-content", allowableValues = 
"return-content, return-no-content",
-                    allowEmptyValue = true))
+    @ApiImplicitParams({
+        @ApiImplicitParam(name = RESTHeaders.PREFER, paramType = "header", 
dataType = "string",
+                value = "Allows the client to specify a preference for the 
result to be returned from the server",
+                defaultValue = "return-content", allowableValues = 
"return-content, return-no-content",
+                allowEmptyValue = true)
+        , @ApiImplicitParam(name = RESTHeaders.NULL_PRIORITY_ASYNC, paramType 
= "header", dataType = "boolean",
+                value = "If 'true', instructs the propagation process not to 
wait for completion when communicating"
+                + " with External Resources with no priority set",
+                defaultValue = "false", allowEmptyValue = true) })
     @ApiResponses({
         @ApiResponse(code = 200, message = "Bulk action result", response = 
BulkActionResult.class)
         , @ApiResponse(code = 204,

http://git-wip-us.apache.org/repos/asf/syncope/blob/5f381e17/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/GroupService.java
----------------------------------------------------------------------
diff --git 
a/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/GroupService.java
 
b/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/GroupService.java
index 197c755..a67f744 100644
--- 
a/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/GroupService.java
+++ 
b/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/GroupService.java
@@ -77,11 +77,15 @@ public interface GroupService extends AnyService<GroupTO> {
      * @return Response object featuring Location header of created group as 
well as the any
      * object itself enriched with propagation status information
      */
-    @ApiImplicitParams(
-            @ApiImplicitParam(name = RESTHeaders.PREFER, paramType = "header", 
dataType = "string",
-                    value = "Allows the client to specify a preference for the 
result to be returned from the server",
-                    defaultValue = "return-content", allowableValues = 
"return-content, return-no-content",
-                    allowEmptyValue = true))
+    @ApiImplicitParams({
+        @ApiImplicitParam(name = RESTHeaders.PREFER, paramType = "header", 
dataType = "string",
+                value = "Allows the client to specify a preference for the 
result to be returned from the server",
+                defaultValue = "return-content", allowableValues = 
"return-content, return-no-content",
+                allowEmptyValue = true)
+        , @ApiImplicitParam(name = RESTHeaders.NULL_PRIORITY_ASYNC, paramType 
= "header", dataType = "boolean",
+                value = "If 'true', instructs the propagation process not to 
wait for completion when communicating"
+                + " with External Resources with no priority set",
+                defaultValue = "false", allowEmptyValue = true) })
     @ApiResponses(
             @ApiResponse(code = 201,
                     message = "Group successfully created enriched with 
propagation status information, as Entity,"
@@ -113,7 +117,11 @@ public interface GroupService extends AnyService<GroupTO> {
         , @ApiImplicitParam(name = HttpHeaders.IF_MATCH, paramType = "header", 
dataType = "string",
                 value = "When the provided ETag value does not match the 
latest modification date of the entity, "
                 + "an error is reported and the requested operation is not 
performed.",
-                allowEmptyValue = true) })
+                allowEmptyValue = true)
+        , @ApiImplicitParam(name = RESTHeaders.NULL_PRIORITY_ASYNC, paramType 
= "header", dataType = "boolean",
+                value = "If 'true', instructs the propagation process not to 
wait for completion when communicating"
+                + " with External Resources with no priority set",
+                defaultValue = "false", allowEmptyValue = true) })
     @ApiResponses({
         @ApiResponse(code = 200,
                 message = "Group successfully updated enriched with 
propagation status information, as Entity",
@@ -146,7 +154,11 @@ public interface GroupService extends AnyService<GroupTO> {
         , @ApiImplicitParam(name = HttpHeaders.IF_MATCH, paramType = "header", 
dataType = "string",
                 value = "When the provided ETag value does not match the 
latest modification date of the entity, "
                 + "an error is reported and the requested operation is not 
performed.",
-                allowEmptyValue = true) })
+                allowEmptyValue = true)
+        , @ApiImplicitParam(name = RESTHeaders.NULL_PRIORITY_ASYNC, paramType 
= "header", dataType = "boolean",
+                value = "If 'true', instructs the propagation process not to 
wait for completion when communicating"
+                + " with External Resources with no priority set",
+                defaultValue = "false", allowEmptyValue = true) })
     @ApiResponses({
         @ApiResponse(code = 200,
                 message = "Group successfully updated enriched with 
propagation status information, as Entity",

http://git-wip-us.apache.org/repos/asf/syncope/blob/5f381e17/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/JAXRSService.java
----------------------------------------------------------------------
diff --git 
a/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/JAXRSService.java
 
b/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/JAXRSService.java
index f613370..f074995 100644
--- 
a/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/JAXRSService.java
+++ 
b/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/JAXRSService.java
@@ -18,6 +18,23 @@
  */
 package org.apache.syncope.common.rest.api.service;
 
+import io.swagger.annotations.ApiResponse;
+import io.swagger.annotations.ApiResponses;
+import io.swagger.annotations.ResponseHeader;
+import org.apache.syncope.common.lib.to.ErrorTO;
+import org.apache.syncope.common.rest.api.RESTHeaders;
+
+@ApiResponses(
+        @ApiResponse(code = 400,
+                message = "An error occurred; HTTP status code can vary 
depending on the actual error: "
+                + "400, 403, 404, 409, 412",
+                response = ErrorTO.class,
+                responseHeaders = {
+                    @ResponseHeader(name = RESTHeaders.ERROR_CODE, response = 
String.class,
+                            description = "Error code")
+                    , @ResponseHeader(name = RESTHeaders.ERROR_INFO, response 
= String.class,
+                            description = "Error message") })
+)
 public interface JAXRSService {
 
     String PARAM_FIQL = "fiql";

http://git-wip-us.apache.org/repos/asf/syncope/blob/5f381e17/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/RealmService.java
----------------------------------------------------------------------
diff --git 
a/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/RealmService.java
 
b/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/RealmService.java
index c5a5cb8..4e0751e 100644
--- 
a/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/RealmService.java
+++ 
b/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/RealmService.java
@@ -79,11 +79,15 @@ public interface RealmService extends JAXRSService {
      * @return Response object featuring Location header of created realm as 
well as the realm itself
      * enriched with propagation status information
      */
-    @ApiImplicitParams(
-            @ApiImplicitParam(name = RESTHeaders.PREFER, paramType = "header", 
dataType = "string",
-                    value = "Allows the client to specify a preference for the 
result to be returned from the server",
-                    defaultValue = "return-content", allowableValues = 
"return-content, return-no-content",
-                    allowEmptyValue = true))
+    @ApiImplicitParams({
+        @ApiImplicitParam(name = RESTHeaders.PREFER, paramType = "header", 
dataType = "string",
+                value = "Allows the client to specify a preference for the 
result to be returned from the server",
+                defaultValue = "return-content", allowableValues = 
"return-content, return-no-content",
+                allowEmptyValue = true)
+        , @ApiImplicitParam(name = RESTHeaders.NULL_PRIORITY_ASYNC, paramType 
= "header", dataType = "boolean",
+                value = "If 'true', instructs the propagation process not to 
wait for completion when communicating"
+                + " with External Resources with no priority set",
+                defaultValue = "false", allowEmptyValue = true) })
     @ApiResponses(
             @ApiResponse(code = 201,
                     message = "Realm successfully created enriched with 
propagation status information, as Entity,"
@@ -108,11 +112,15 @@ public interface RealmService extends JAXRSService {
      * @param realmTO realm to be stored
      * @return Response object featuring the updated realm enriched with 
propagation status information
      */
-    @ApiImplicitParams(
-            @ApiImplicitParam(name = RESTHeaders.PREFER, paramType = "header", 
dataType = "string",
-                    value = "Allows the client to specify a preference for the 
result to be returned from the server",
-                    defaultValue = "return-content", allowableValues = 
"return-content, return-no-content",
-                    allowEmptyValue = true))
+    @ApiImplicitParams({
+        @ApiImplicitParam(name = RESTHeaders.PREFER, paramType = "header", 
dataType = "string",
+                value = "Allows the client to specify a preference for the 
result to be returned from the server",
+                defaultValue = "return-content", allowableValues = 
"return-content, return-no-content",
+                allowEmptyValue = true)
+        , @ApiImplicitParam(name = RESTHeaders.NULL_PRIORITY_ASYNC, paramType 
= "header", dataType = "boolean",
+                value = "If 'true', instructs the propagation process not to 
wait for completion when communicating"
+                + " with External Resources with no priority set",
+                defaultValue = "false", allowEmptyValue = true) })
     @ApiResponses({
         @ApiResponse(code = 200,
                 message = "Realm successfully updated enriched with 
propagation status information, as Entity",
@@ -134,11 +142,15 @@ public interface RealmService extends JAXRSService {
      * @param fullPath realm path
      * @return Response object featuring the deleted realm enriched with 
propagation status information
      */
-    @ApiImplicitParams(
-            @ApiImplicitParam(name = RESTHeaders.PREFER, paramType = "header", 
dataType = "string",
-                    value = "Allows the client to specify a preference for the 
result to be returned from the server",
-                    defaultValue = "return-content", allowableValues = 
"return-content, return-no-content",
-                    allowEmptyValue = true))
+    @ApiImplicitParams({
+        @ApiImplicitParam(name = RESTHeaders.PREFER, paramType = "header", 
dataType = "string",
+                value = "Allows the client to specify a preference for the 
result to be returned from the server",
+                defaultValue = "return-content", allowableValues = 
"return-content, return-no-content",
+                allowEmptyValue = true)
+        , @ApiImplicitParam(name = RESTHeaders.NULL_PRIORITY_ASYNC, paramType 
= "header", dataType = "boolean",
+                value = "If 'true', instructs the propagation process not to 
wait for completion when communicating"
+                + " with External Resources with no priority set",
+                defaultValue = "false", allowEmptyValue = true) })
     @ApiResponses({
         @ApiResponse(code = 200,
                 message = "Realm successfully deleted enriched with 
propagation status information, as Entity",

http://git-wip-us.apache.org/repos/asf/syncope/blob/5f381e17/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/UserService.java
----------------------------------------------------------------------
diff --git 
a/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/UserService.java
 
b/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/UserService.java
index 86bbb73..ca193e3 100644
--- 
a/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/UserService.java
+++ 
b/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/UserService.java
@@ -76,11 +76,15 @@ public interface UserService extends AnyService<UserTO> {
      * @return Response object featuring Location header of created user as 
well as the user itself
      * enriched with propagation status information
      */
-    @ApiImplicitParams(
-            @ApiImplicitParam(name = RESTHeaders.PREFER, paramType = "header", 
dataType = "string",
-                    value = "Allows the client to specify a preference for the 
result to be returned from the server",
-                    defaultValue = "return-content", allowableValues = 
"return-content, return-no-content",
-                    allowEmptyValue = true))
+    @ApiImplicitParams({
+        @ApiImplicitParam(name = RESTHeaders.PREFER, paramType = "header", 
dataType = "string",
+                value = "Allows the client to specify a preference for the 
result to be returned from the server",
+                defaultValue = "return-content", allowableValues = 
"return-content, return-no-content",
+                allowEmptyValue = true)
+        , @ApiImplicitParam(name = RESTHeaders.NULL_PRIORITY_ASYNC, paramType 
= "header", dataType = "boolean",
+                value = "If 'true', instructs the propagation process not to 
wait for completion when communicating"
+                + " with External Resources with no priority set",
+                defaultValue = "false", allowEmptyValue = true) })
     @ApiResponses(
             @ApiResponse(code = 201,
                     message = "User successfully created enriched with 
propagation status information, as Entity,"
@@ -114,7 +118,11 @@ public interface UserService extends AnyService<UserTO> {
         , @ApiImplicitParam(name = HttpHeaders.IF_MATCH, paramType = "header", 
dataType = "string",
                 value = "When the provided ETag value does not match the 
latest modification date of the entity, "
                 + "an error is reported and the requested operation is not 
performed.",
-                allowEmptyValue = true) })
+                allowEmptyValue = true)
+        , @ApiImplicitParam(name = RESTHeaders.NULL_PRIORITY_ASYNC, paramType 
= "header", dataType = "boolean",
+                value = "If 'true', instructs the propagation process not to 
wait for completion when communicating"
+                + " with External Resources with no priority set",
+                defaultValue = "false", allowEmptyValue = true) })
     @ApiResponses({
         @ApiResponse(code = 200,
                 message = "User successfully updated enriched with propagation 
status information, as Entity",
@@ -147,7 +155,11 @@ public interface UserService extends AnyService<UserTO> {
         , @ApiImplicitParam(name = HttpHeaders.IF_MATCH, paramType = "header", 
dataType = "string",
                 value = "When the provided ETag value does not match the 
latest modification date of the entity, "
                 + "an error is reported and the requested operation is not 
performed.",
-                allowEmptyValue = true) })
+                allowEmptyValue = true)
+        , @ApiImplicitParam(name = RESTHeaders.NULL_PRIORITY_ASYNC, paramType 
= "header", dataType = "boolean",
+                value = "If 'true', instructs the propagation process not to 
wait for completion when communicating"
+                + " with External Resources with no priority set",
+                defaultValue = "false", allowEmptyValue = true) })
     @ApiResponses({
         @ApiResponse(code = 200,
                 message = "User successfully updated enriched with propagation 
status information, as Entity",
@@ -180,7 +192,11 @@ public interface UserService extends AnyService<UserTO> {
         , @ApiImplicitParam(name = HttpHeaders.IF_MATCH, paramType = "header", 
dataType = "string",
                 value = "When the provided ETag value does not match the 
latest modification date of the entity, "
                 + "an error is reported and the requested operation is not 
performed.",
-                allowEmptyValue = true) })
+                allowEmptyValue = true)
+        , @ApiImplicitParam(name = RESTHeaders.NULL_PRIORITY_ASYNC, paramType 
= "header", dataType = "boolean",
+                value = "If 'true', instructs the propagation process not to 
wait for completion when communicating"
+                + " with External Resources with no priority set",
+                defaultValue = "false", allowEmptyValue = true) })
     @ApiResponses({
         @ApiResponse(code = 200,
                 message = "User successfully updated enriched with propagation 
status information, as Entity",

Reply via email to