Skip to content

Commit d7df055

Browse files
committed
Add javadoc
1 parent 1300d3f commit d7df055

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

api/src/main/java/com/inrupt/client/ClientHttpException.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@
2020
*/
2121
package com.inrupt.client;
2222

23+
/**
24+
* A runtime exception representing an HTTP error response carrying a structured representation of the problem. The
25+
* problem description is embedded in a {@link ProblemDetails} instance.
26+
*/
2327
public class ClientHttpException extends InruptClientException {
2428
private final ProblemDetails problemDetails;
2529

api/src/main/java/com/inrupt/client/ProblemDetails.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,11 @@
2222

2323
import java.net.URI;
2424

25+
/**
26+
* A data class representing a structured problem description sent by the server on error response.
27+
*
28+
* @see <a href="https://www.rfc-editor.org/rfc/rfc9457">RFC 9457 Problem Details for HTTP APIs</a>
29+
*/
2530
public class ProblemDetails {
2631
public static final String MIME_TYPE = "application/problem+json";
2732
public static final String DEFAULT_TYPE = "about:blank";

0 commit comments

Comments
 (0)