api-guidelines
api-guidelines copied to clipboard
microsoft
Microsoft REST API Guidelines
I recently had to try to give feedback on API design, but... I found myself emotionally reacting to the inflexibility of a particular guidance I was giving about the naming...
Create a new pattern on how to design Graph API for modeling a resource with defined state machine
Hello team, In the https://github.com/microsoft/api-guidelines/blob/vNext/graph/patterns/dictionary.md, it mentioned that the keys must be defined by the client. However, there were only examples for client to specify a single key (by appending...
In our [naming guidelines](https://github.com/microsoft/api-guidelines/blob/vNext/graph/GuidelinesGraph.md#naming), we say this about two-letter acronyms: > ☑️ SHOULD case two-letter acronyms with the same case. We also don't say anything specific about two-letter abbreviations. I...
There are situations where a query-like operation must accept inputs that are too complex or bulky to pass in the query string, and since GET cannot accept a request body,...
Context Graph.Json is used to model properties or payload of which the shape is unknown. This makes it really difficult for clients to do anything useful with it. The vast...
Clarify when to group stuff in a complex type
We identified two distinct types of the soft DELETE behavior: 1) when an item flagged as deleted and 2) when an item is moved to a 'recycle bin' location. These...