Skip to content

Commit a746b93

Browse files
fix: typo ErrorResponse
1 parent ff07817 commit a746b93

1 file changed

Lines changed: 30 additions & 32 deletions

File tree

src/main/java/dev/resms/model/ErrorResponse.java

Lines changed: 30 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,16 @@
33
import lombok.Getter;
44

55
/**
6-
* <h1>Error Response Model</h1>
7-
*
8-
* <p>This class represents an error response received from the ReSMS API when an operation fails.
9-
* It extends the base {@link Response} class and contains detailed error information including
10-
* an error name and message.</p>
11-
*
12-
* <p>Error responses are automatically translated into appropriate exception types by the
13-
* {@link dev.resms.api.ReSMSApiClient}, so clients typically interact with exceptions rather
14-
* than directly with this class.</p>
15-
*
16-
* <p>Example of a typical API error response JSON structure:</p>
6+
* This class represents an error response received from the ReSMS API when an operation fails. It
7+
* extends the base {@link Response} class and contains detailed error information including an
8+
* error name and message.
9+
*
10+
* <p>Error responses are automatically translated into appropriate exception types by the {@link
11+
* dev.resms.api.ReSMSApiClient}, so clients typically interact with exceptions rather than directly
12+
* with this class.
13+
*
14+
* <p>Example of a typical API error response JSON structure:
15+
*
1716
* <pre>
1817
* {
1918
* "status": "error",
@@ -23,9 +22,7 @@
2322
* }
2423
* }
2524
* </pre>
26-
*
27-
* @author ReSMS Development Team
28-
* @version 1.0.1
25+
*
2926
* @since 1.0.0
3027
* @see dev.resms.model.Response
3128
* @see dev.resms.exception.ReSMSException
@@ -34,39 +31,40 @@
3431
@Getter
3532
public class ErrorResponse extends Response {
3633
/**
37-
* <p>The error details containing the error name and message.</p>
38-
*
39-
* <p>This field is populated by the API response and provides detailed information
40-
* about what went wrong during the API call.</p>
41-
*
34+
* The error details containing the error name and message.
35+
*
36+
* <p>This field is populated by the API response and provides detailed information about what
37+
* went wrong during the API call.
38+
*
4239
* @see ErrorDetails
4340
*/
4441
private ErrorDetails error;
4542

4643
/**
44+
*
45+
*
4746
* <h2>Error Details</h2>
48-
*
49-
* <p>This nested class contains the specific details of an error returned by the API.
50-
* It includes a standardized error name (which can be used for programmatic error handling)
51-
* and a human-readable error message.</p>
47+
*
48+
* <p>This nested class contains the specific details of an error returned by the API. It includes
49+
* a standardized error name (which can be used for programmatic error handling) and a
50+
* human-readable error message.
5251
*/
5352
@Getter
5453
public static class ErrorDetails {
5554
/**
56-
* <p>The standardized name of the error.</p>
57-
*
55+
* The standardized name of the error.
56+
*
5857
* <p>This field contains a machine-readable identifier for the error type, such as
59-
* "INVALID_API_KEY" or "INSUFFICIENT_SMS_QUOTA". It can be used for programmatic
60-
* error handling and routing to the appropriate exception type.</p>
58+
* "INVALID_API_KEY" or "INSUFFICIENT_SMS_QUOTA". It can be used for programmatic error handling
59+
* and routing to the appropriate exception type.
6160
*/
6261
private String name;
6362

6463
/**
65-
* <p>A human-readable description of the error.</p>
66-
*
67-
* <p>This field contains a detailed message explaining what went wrong and,
68-
* when applicable, how to fix the issue. This message is typically forwarded
69-
* to the exception that is thrown.</p>
64+
* A human-readable description of the error.
65+
*
66+
* <p>This field contains a detailed message explaining what went wrong and, when applicable,
67+
* how to fix the issue. This message is typically forwarded to the exception that is thrown.
7068
*/
7169
private String message;
7270
}

0 commit comments

Comments
 (0)