Skip to content

Commit c5aaebe

Browse files
committed
Update RFC references and remove unused TODO comment
Replaced outdated RFC 2616 references with RFC 9110 in the `Error` class to ensure accuracy and compliance with current specifications. Also removed an obsolete TODO comment from the `PlaceAttribute` class since it was no longer relevant. These changes improve documentation clarity and maintainability.
1 parent 2986073 commit c5aaebe

File tree

2 files changed

+5
-7
lines changed

2 files changed

+5
-7
lines changed

extensions/familysearch/familysearch-api-model/src/main/java/org/familysearch/platform/Error.java

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,7 @@
3535
@Schema(description = "A common representation of an error on the FamilySearch platform.")
3636
public class Error {
3737

38-
// TODO: Fix links to RFC 2616 and RFC 2616, Section 10 (HTTP Status Code Definitions)
39-
@Schema(description = "The error code. Interpreted per RFC 2616, Section 10 (HTTP Status Code Definitions).")
38+
@Schema(description = "The error code. Interpreted per [RFC 9110, Section 15 (Status Codes)](https://www.rfc-editor.org/rfc/rfc9110.html#name-status-codes).")
4039
private Integer code;
4140

4241
@Schema(description = "A text label associated with the error code.")
@@ -49,18 +48,18 @@ public class Error {
4948
private String stacktrace;
5049

5150
/**
52-
* The error code. Intepreted per <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html">RFC 2616, Section 10 (HTTP Status Code Definitions)</a>.
51+
* The error code. Interpreted per <a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-status-codes">RFC 9110, Section 15 (Status Codes)</a>.
5352
*
54-
* @return The error code. Intepreted per <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html">RFC 2616, Section 10 (HTTP Status Code Definitions)</a>.
53+
* @return The error code. Interpreted per <a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-status-codes">RFC 9110, Section 15 (Status Codes)</a>.
5554
*/
5655
public Integer getCode() {
5756
return code;
5857
}
5958

6059
/**
61-
* The error code. Intepreted per <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html">RFC 2616, Section 10 (HTTP Status Code Definitions)</a>.
60+
* The error code. Interpreted per <a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-status-codes">RFC 9110, Section 15 (Status Codes)</a>.
6261
*
63-
* @param code The error code. Intepreted per <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html">RFC 2616, Section 10 (HTTP Status Code Definitions)</a>.
62+
* @param code The error code. Interpreted per <a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-status-codes">RFC 9110, Section 15 (Status Codes)</a>.
6463
*/
6564
public void setCode(Integer code) {
6665
this.code = code;

extensions/familysearch/familysearch-api-model/src/main/java/org/familysearch/platform/places/PlaceAttribute.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818
/**
1919
* @author Ryan Heaton
2020
*/
21-
// TODO: Travis - This class is not used in the current version of the FamilySearch API. It is not clear if it is still needed.
2221
public class PlaceAttribute {
2322

2423
private String attributeId;

0 commit comments

Comments
 (0)