api-guidelines
api-guidelines copied to clipboard
microsoft
Microsoft REST API Guidelines
What does this sentence mean (in the section about `orderBy`)? > The value of the orderby parameter is a comma-separated list of expressions used to sort the items. A special...
It seems logical/implied, by the ideas that PATCH will have create semantics when it allows upsert semantics (same as PUT), and a similar clause that exists for POST - that...
Some services allow a standard "bearer" authorization with user token but also API Key authorization. We should provide guidance on how this is done so we can get some consistency...
Determine if top level error codes should map to HTTP status codes or be more granular. Provide a consistent set of guidance for our service team partners.
We should provide guidance to Azure service teams on how to design and implement RBAC for their resources. Some possible sources of material: - the Azure ARM wiki - the...
We should make sure the Azure guidelines are consistent with the RP guidelines — meaning that these guidelines should not contradict anything in the RP guidelines, but the RP guidelines...
Determine the proper guidance relative to OASIS or HTTP working group (Stripe). See the [comment](https://github.com/microsoft/api-guidelines/pull/264/files#r679441640) in the initial PR.
I'll take this as an action item for an update after we merge this one. _Originally posted by @markweitzel in https://github.com/microsoft/api-guidelines/pull/264#r673455443_
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 projections (in List and maybe Get operations). Current Azure examples include: - `$select`...
