Skip to content

Commit

Permalink
#30 @fpalombini, @dret please review this change regarding documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sdatspun2 committed Aug 22, 2024
1 parent 29efecb commit 25738aa
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion draft-ietf-httpapi-deprecation-header.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ The purpose of the `Deprecation` header field is to provide a hint about depreca
Link: <https://developer.example.com/deprecation>;
rel="deprecation"; type="text/html"

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.
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 under which circumstances and with which policies deprecation might take place. For example, a policy may indicate that deprecation of a resource(s) will always be signaled in the dedicated places at least N days ahead of the planned deprecation date and then only the resource(s) would be deprecated. Or a policy may indicate that resource(s) would be deprecated first and then only be signaled as deprecated at dedicated places. The documentation in addition to the deprecation policy may also provide a migration guide exaplaining to consumers of the resource how to migrate to a new resource(s) or an alternate resource(s) before the deprecation date. Such policy and documentation would be very useful to consumers of the resource to plan ahead and migrate successfully.

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

Expand Down

1 comment on commit 25738aa

@dret
Copy link
Collaborator

@dret dret commented on 25738aa Aug 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. Thanks!

Please sign in to comment.