api-guidelines
api-guidelines copied to clipboard
microsoft
Microsoft REST API Guidelines
I am adding a new file to document some of the graph conventions we have around properties. This PR is documenting the convention that read-only properties can be "updated" so...
This PR adds basic guidance for naming in Azure REST APIs. Some of this is borrowed from the Microsoft and Graph API guidelines and some on naming discussions we've had...
In our examples we use BadRequest error code which supposed to be in camel case and potentially use predefined enum type https://github.com/microsoft/api-guidelines/blob/vNext/graph/GuidelinesGraph.md#error-handling
For client development, it is preferred that clients don't do validation on requests and instead let the service validate and return any errors. The justification for this is that the...
In order to ensure we have proper coverage when creating linters, cadl libraries, etc. we need to be able to link back to specific rules within the the guidelines.
This PR contains two change requests: 1. The current guidelines say to use PATCH for create and update and to use PUT for wholesale create/update. I personally find it challenging...
I think we do NOT want to recommend the LRO pattern for very long-running operations (VLRO) because the client will effectively hang if polling to completion to make forward progress....
For client development, it is important to know what a service will return in the following situation: 1. In service v1, there is a resource Foo with one property Bar,...
In working with service teams, we need to add a way for them to indicate an API or part of their service has been deprecated. The API case is quite...