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

Added LRO & Substring guidelines

Open JeffreyRichter opened this issue 2 years ago • 1 comments

JeffreyRichter avatar Jan 17 '24 18:01 JeffreyRichter

@mikekistler, I want to address this comment: https://github.com/microsoft/api-guidelines/pull/517#pullrequestreview-1833128238

This is a wholesale rewrite of the guideline text but all the old guidelines remain. I struggled without how to get the guidelines across in a simplified manner. I untimately settled on what worked during our discussions with my Word document. That is, the HTTP requests/responses themselves in the new guidelines SHOW exactly what to do as opposed to explaining via text what to do. I think this makes it easier to follow and is more prescriptive for service teams.

If you pick some text guideline that was there before and read the new guidelines, I'm very sure you'll find the issue still covered but by way of prescriptive example.

JeffreyRichter avatar Jan 19 '24 17:01 JeffreyRichter

@markcowl @allenjzhang For your awareness. Once these guidelines are finalized we should add support in TypeSpec for the new patterns.

mikekistler avatar Apr 09 '24 02:04 mikekistler

A comment on status property in the response of the PUT, for "PUT to resource with additional long-running processing". https://github.com/microsoft/api-guidelines/pull/517#discussion_r1554827307

I don't think we should add the status to resource properties. It would be status monitor property.

weidongxu-microsoft avatar Apr 09 '24 08:04 weidongxu-microsoft