Skip to content
This repository was archived by the owner on Jul 7, 2025. It is now read-only.

Commit 29efecb

Browse files
committed
#30 includes text re migration and timeline in documentation section, @dret, @fpalombini pl review.
1 parent 280f3e3 commit 29efecb

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

draft-ietf-httpapi-deprecation-header.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,12 +109,12 @@ This specification places no restrictions on the representation of the linked de
109109

110110
## Documentation
111111

112-
The purpose of the `Deprecation` header field is to provide a hint about deprecation to the resource consumer. Upon reception of the `Deprecation` header field, the client developer can look up the resource's documentation in order to find deprecation related information. The resource provider can provide a link to the resource documentation using a `Link` header field with relation type `deprecation` as shown below:
112+
The purpose of the `Deprecation` header field is to provide a hint about deprecation to the resource consumer. Upon reception of the `Deprecation` header field, the client developer can look up the resource's documentation in order to find deprecation related information. The documentation MAY provide a guide and timeline to migrate away from the deprecated resource to a new resource(s) replacing the deprecated resource, if applicable. The resource provider can provide a link to the resource documentation using a `Link` header field with relation type `deprecation` as shown below:
113113

114114
Link: <https://developer.example.com/deprecation>;
115115
rel="deprecation"; type="text/html"
116116

117-
In this example the linked content provides additional information about deprecation of the resource context. There is no Deprecation header field in the response, and thus the resource is not (yet) deprecated. However, the resource already exposes a link where information is available describing how deprecation is managed for the resource. This may be the documentation explaining the use of the Deprecation header field, and also explaining under which circumstances and with which policies (announcement before deprecation; continued operation after deprecation) deprecation might take place.
117+
In this example the linked content provides additional information about deprecation of the resource context. There is no Deprecation header field in the response, and thus the resource is not (yet) deprecated. However, the resource already exposes a link where information is available describing how deprecation is managed for the resource. This may be the documentation explaining the use of the Deprecation header field, and also explaining under which circumstances and with which policies (announcement before deprecation; continued operation after deprecation) deprecation might take place.
118118

119119
The following example uses the same link header field, but also announces a deprecation date using a Deprecation header field:
120120

0 commit comments

Comments
 (0)