api-guidelines
api-guidelines copied to clipboard
microsoft
Microsoft REST API Guidelines
This came up during [the first draft of collections guidance](https://github.com/microsoft/api-guidelines/pull/243#discussion_r654526793). We should think about prescriptive guidance for a default filtering language, how it relates to OData, and whether we want...
We are currently working on updating a set of guidelines specific for Graph APIs. We also observed a need to list the best practices and patterns for evolvable API designs...
Currently, the guidelines mention the URL structure for nested collections within a resource: https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#931-nested-collections-and-properties `GET https://api.contoso.com/v1.0/people/123/addresses` The guidelines also mention that paging semantics should be consistent between the parent and...
For defining API specifications for our customers, there is a lot of ambiguity about which keys you can actually search by given a `$filter` query parameter. When using explicitly named...
.Net Core 3.0+ framework by default returns Problem details and following [RFC7807 specifications](https://tools.ietf.org/html/rfc7807) to return model validation error or internal server error. Net core 3.0+ framework also expects us to...
PR relates to issue [#91](https://github.com/Microsoft/api-guidelines/issues/91).
Related to #10 This change removes the need for the custom header `Operation-Location` and uses the standard `Content-Location` header to enable the hybrid flow. This approach ensures that all long...
The URL Used in the example was not in compliance with the item 7.9, that states "clients SHOULD NOT transmit personally identifiable information (PII) parameters in the URL"
