api-guidelines icon indicating copy to clipboard operation
api-guidelines copied to clipboard

Update how client's handle `nextlink`

Open markweitzel opened this issue 3 years ago • 3 comments

From convo w/Jeffrey Richter

I don't think we ever created a document on this (but we should update our guidelines). A client should apply its desired api-version to the nextLink either overwriting an api-version if it is there or appending the client's desired api-version if the nextLink does not have an api-version on it already. This is the same for LRO Operation-Location headers (we did address this in the new LRO guidelines).

markweitzel avatar Jun 20 '22 12:06 markweitzel

Can @mikekistler just update the guidelines. I think we're all in agreement on this.

JeffreyRichter avatar Jun 20 '22 21:06 JeffreyRichter

The Azure SDK Guidelines are already very clear on this point.

DO add or replace the api-version query parameter on any URI returned by the service e.g., Operation-Location, next page links, etc., with the service version passed configured on the client.

Do we need more than this?

mikekistler avatar Jun 30 '22 15:06 mikekistler

This sounds good to me. I might change "next page links" to "nextLink".

JeffreyRichter avatar Jun 30 '22 15:06 JeffreyRichter