api-guidelines
api-guidelines copied to clipboard
microsoft
Microsoft REST API Guidelines
It's be great for Microsoft API REST API guidelines to be explicit about using Accept-Language header and localized detailed error message like above.
Expand may be an expensive option in this case therefore a requirement doe expand should state if there is a vialble use case.
The [guidance](https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#93-collection-url-patterns) for point queries: > Whenever possible, services MUST support the "/" pattern. For example: is vague. It is unclear "whenever" a service "must" support point queries. We should...
I'm adding guidance to suggest that collections should be entity types instead of complex types because they can be modified piecewise, while collections of complex types must always be replaced,...
This pattern is really an anti-pattern which describes having a "draft" entity which has relaxed validation so that properties required to create the "real" entity can be added piecewise. In...
See the table https://github.com/microsoft/api-guidelines/blob/0611d2f7236b7670f887e83ac7da4c918d9cb74f/azure/Guidelines.md?plain=1#L142-L154 It lists all HTTP verbs but `HEAD`. And overall, this verb isn't mentioned in the guidelines. Why?
