api-guidelines
api-guidelines copied to clipboard
microsoft
Microsoft REST API Guidelines
We decided to update general guidelines with a strong recommendation not to use open type
What is the expected / recommended behavior of a service for a request that contains a query or header parameter that it does not recognize? What about an unexpected body...
Some references: - https://apisyouwonthate.com/blog/caching-is-hard-draw-me-a-picture/ - https://www.rfc-editor.org/rfc/rfc9111#section-3 One of the guidelines we may want to establish: ⛔ DO NOT include a `cache-control: public` header in the response to an authorized request.
Need to add examples and variants for RELO pattern using Actions
Clarify the case of a long running post action with an existing operation id, where the request body is the same (retry scenario) in the guidelines. I read the spec,...
We've had a few teams ask about server sent events and the proper patterns. We need to add guidance for these teams.
**_13.2.1. PUT Services MAY enable PUT requests for entity creation. PUT https://api.contoso.com/v1.0/databases/db1 In this scenario the databases segment is processing the PUT operation. HTTP/1.1 202 Accepted Operation-Location: https://api.contoso.com/v1.0/operations/123 For services...
How can this be implemented in C# since this causes error CS0542 "member names cannot be the same as their enclosing type"? Shouldn't the type of InnerError just be Error?
