api-guidelines
api-guidelines copied to clipboard
microsoft
Microsoft REST API Guidelines
ref: https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#1321-put For long running operations that return 202, it is suggested to use `Operation-Location` to refer to a resource that can be monitored to determine when the requested operation...
It would be great if the standards document expressed a clear opinion on how multiple words should be concatenated in URL path segments. For example: https://api.contoso.com/v1.0/pullRequests https://api.contoso.com/v1.0/pull-requests https://api.contoso.com/v1.0/pull_requests https://api.contoso.com/v1.0/pullrequests
# Enable retries for non-idempotent operations using client provided "logical request" tokens. Not all HTTP methods are guaranteed to be idempotent. This presents challenges when requests fail/no response is received...
The default branch on GitHub is currently set to vNext if I'm not mistaken. Is there a difference between master and vNext? Is master obsolete, vNext a work-in-progress and still...
Your example of a well structured URL: > https://api.contoso.com/v1.0/people/[email protected]/inbox in [URL Structure](https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#71-url-structure) includes PII in the URL which is prohibited in [PII parameters](https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#79-pii-parameters)
It feels like to me that a 201 should win as a client can always look at the content-length to know there is no body. However, in the section on...
This commit attempts to include guidance to developers implementing web hook sending behavior. Specifically it provides what I believe to be common-sense retry intervals that should be appropriate for most...
For example, ``` GET https://api.contoso.com/v1.0/people?$filter=name eq 'david'&$orderBy=hireDate ``` In this example, the success of this request is contingent on the HTTP client replacing ` `with`%20`. Are you sure that's what...
Regarding: https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md In section 14.4.4 Example Response "details" object doesn't fit the definition of "details" in section 7.10.2, table Error: Object. Details should be Error[] ``` { "error": { "code":...
