api-guidelines
api-guidelines copied to clipboard
microsoft
Microsoft REST API Guidelines
We should add guidelines that require new services to start with managed identity, explicitly discourage the use of connection strings, etc. We're always telling that to service teams during reviews,...
From [this comment](https://github.com/microsoft/api-guidelines/pull/517/files#r1577056082) on #517 > It would be nice to include a little more specificity into what a "significant amount of time" mean. Perhaps something like "the amount of...
Nesting complicates the user experience and should only be used when necessary. We should add guidance to use flat structures unless there is some significant value to nesting, with some...
`/admin` should be added in the future.
Our current `ConsiderationsForServiceDesign` includes this statement in the [PUT with additional long-running processing](https://github.com/microsoft/api-guidelines/blob/3fdf4261ec1d785ba78a3479f66d98d10e1933ad/azure/ConsiderationsForServiceDesign.md#put-with-additional-long-running-processing) section: > If the resource supports ETags, the response may contain an etag header and possibly an...
I am looking at Azure API guidelines - Collections section. https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#collections > **YOU SHOULD** use `value` as the name of the top-level array field unless a more appropriate name is...
This came up in a conversation with an API producer recently. I am familiar with several approaches for unschematized models, but I'm not aware of them being written down. These...
_Originally posted by @mmtayyar in https://github.com/CVEProject/cve-schema/issues/283_ _Originally posted by @mmtayyar in https://github.com/microsoft/api-guidelines/issues/531_
