api-guidelines
api-guidelines copied to clipboard
microsoft
Microsoft REST API Guidelines
The following rules need to be captured, either in a section on JSON models OR in a complementary document on OpenAPI. If you also support PUT then, then model depends...
In the LRO meeting, we realized during the `operation-id` discussion on #353 that how GUIDs are handled varies and could present some challenges. This issue isn't isolated to `operation-id` but...
There are some good and not-so-good patterns for implementing bulk operations. We should provide guidance on these.
We should update the Azure REST API guidelines to explicitly state that enum values should be treated as case sensitive.
This PR introduces the Change Status Pattern discussed internally. This is supposed to be proposed in the next API Council when I get enough people to accept the proposal.
As of PR #352 we removed the section on version discovery because this was out of date. However, we do need to provide guidance on how developers can understand when...
This PR adds one small bit of guidance that we commonly give to service teams -- don't include a `count` field in a pageable response since this could be expensive...
In several places, these docs instruct teams to "Engage the Azure REST API Stewardship Board", but it doesn't explain exactly how one does that. Is that on Microsoft Teams?, email?,...
Regarding header parameters, the guidelines say: > DO NOT fail a request that contains an unrecognized header. Headers may be added by API gateways or middleware and this must be...
