-
@Documented @Retention(SOURCE) @Target({METHOD,TYPE}) @Repeatable(List.class) public @interface SimpleErrorResponse
Contains metadata about the unsuccessful HTTP response of REST-based microservice.- Since:
- 0.1
- Author:
- nedis
- See Also:
ModelExceptionErrorResponse
-
-
Required Element Summary
Required Elements Modifier and Type Required Element Description intstatusReturns the status code.
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description StringdescriptionReturns the error description.StringexampleErrorMessageReturns the example of error message.IncludeDescriptionincludeDescriptionReturns the included description if it is necessary add a complex formatted description.
-
-
-
-
description
String description
Returns the error description.- Returns:
- the error description
- Default:
- ""
-
-
-
includeDescription
IncludeDescription includeDescription
Returns the included description if it is necessary add a complex formatted description.- Returns:
- the included description
- Default:
- @io.rxmicro.documentation.IncludeDescription(resource="")
-
-
-
exampleErrorMessage
String exampleErrorMessage
Returns the example of error message.- Returns:
- the example of error message
- Default:
- ""
-
-