Home Original page

[retry-after] Clarify that header value must not use <http-date> by mikeharder · Pull Request #553 · microsoft/api-guidelines

@mikeharder

@mikeharder

mikekistler

<a href="#lro-status-monitor-no-resource-result" name="lro-status-monitor-no-resource-result">:no_entry:</a> **DO NOT** include a `result` property in the status monitor for a long-running operation that is not an action-type long-running operation.

<a href="#lro-status-monitor-retry-after" name="lro-status-monitor-retry-after">:white_check_mark:</a> **DO** include a `retry-after` header in the response if the operation is not complete. The value of this header should be an integer number of seconds that the client should wait before polling the status monitor again.
<a href="#lro-status-monitor-retry-after" name="lro-status-monitor-retry-after">:white_check_mark:</a> **DO** include a `retry-after` header in the response if the operation is not complete. The value of this header must be a non-negative integer number of seconds that the client should wait before polling the status monitor again. The value of this header must not be an `<http-date>` string, even though `<http-date>` is also allowed in the HTTP spec.

Choose a reason for hiding this comment

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

This particular guideline only applies to LRO status monitor responses, and I think we want to make this guidance apply to any time a service returns retry-after. I recommend adding a new guideline in the section titled "HTTP Query Parameters and Header Values".