api-guidelines
api-guidelines copied to clipboard
Microsoft REST API Guidelines
The Azure guidelines refer to http://aka.ms/AzBreakingChangesPolicy/ which shows as a broken link Please consider either making the Breaking Changes policy a public document, or give read access permissions to all...
- [ ] Probably needs more examples of one-to-many - [ ] Missing discussion of containment, although I can't decide how important that is.
About the unknownFutureValue from [Evovable enums](https://github.com/microsoft/api-guidelines/blob/vNext/graph/patterns/evolvable-enums.md), I have some questions regarding to how it works. 1. Do developers need to convert the values after unknownFutureValue to unknownFutureValue in the code?...
Add guidance for naming of properties, parameters, etc to the Azure API Guidelines. We can probably borrow some of the guidance the MS Graph team has written: https://github.com/microsoft/api-guidelines/blob/vNext/graph/GuidelinesGraph.md#naming
HTTP services are required to include a `WWW-Authenticate` header in a `401 Unauthorized` response per [RFC 7235](https://datatracker.ietf.org/doc/html/rfc7235#section-3.1): > The server generating a 401 response MUST send a WWW-Authenticate header field...
In the DeviceUpdate API, some operations use the `x-ms-long-running-operation` tag, where others are represented as a resource. This is according to the guidance found in the current API guidelines: >...
**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...