Documentation: Add exception handling document #1603
Conversation
j82w
requested review from
ealsur,
FabianMeiswinkel,
kirankumarkolli,
kirillg and
sboshra
as code owners
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Please follow the required format: "[Internal] Category: (Add|Fix|Refactor) Description"
Examples:
Diagnostics: Add GetElapsedClientLatency to CosmosDiagnostics
PartitionKey: Fix null reference when using default(PartitionKey)
[v4] Client Encryption: Refactor code to external project
[Internal] Query: Add code generator for CosmosNumbers for easy additions in the future.
j82w
changed the title
Co-authored-by: Matias Quaranta <ealsur@users.noreply.github.com>
…om/Azure/azure-cosmos-dotnet-v3 into users/jawilley/document/exceptions
| /// </item> | ||
| /// </list> | ||
| /// </exception> | ||
| /// <exception>https://aka.ms/cosmosdb-dot-net-exceptions#typed-api</exception> |
There was a problem hiding this comment.
Simple URI might not get attention.
Existing annotation seems reasonable and we could leverage.
How about merge both of them?
There was a problem hiding this comment.
@FabianMeiswinkel and @ealsur what are your thoughts?
The issue with the old format is it was duplicated in so many places that most of them were missing different scenarios. Trying to explain which exceptions the SDK retries on vs which ones they need to handle along with different exception scenarios seemed like to much to duplicate any every comment.
There was a problem hiding this comment.
I prefer the Uri approach - easier to get it right - and customers who look for this info will follow the link - customers who are neglecting exception info will neglect it whether it is in the comments or not
There was a problem hiding this comment.
I agree, it helps maintaining a unified documentation store
|
Closing due to in-activity, pease feel free to re-open. |
Pull Request Template
Description
Add a new exception document that details what the different exception types are and what the normal status codes are. Updated all comments to reference new document.
Type of change
Please delete options that are not relevant.