search

Azure / azure-sdk-for-net

This repository is for active development of the Azure SDK for .NET. For consumers of the SDK we recommend visiting our public developer docs at https://learn.microsoft.com/dotnet/azure/ or our versioned developer docs at https://azure.github.io/azure-sdk-for-net.
MIT License
5.23k stars 4.58k forks source link

Documentation for CreateItemAsync does not contain information about the exceptions this method can raise. #43507

Open bIgBV opened 4 months ago

bIgBV commented 4 months ago

Type of issue

Missing information

Description

Looking at the other sources of documentation on the semantics of this method, I came across (this documentation article)[https://learn.microsoft.com/en-us/azure/cosmos-db/nosql/how-to-dotnet-create-item#create-an-item-asynchronously] which specifies:

The Container.CreateItemAsync<> method will throw an exception if there's a conflict with the unique identifier of an existing item. To learn more about potential exceptions, see CreateItemAsync<> exceptions.

But the page linked to doesn't contain the Exception subheading that is being linked to.

Page URL

https://learn.microsoft.com/en-us/dotnet/api/microsoft.azure.cosmos.container.createitemasync?view=azure-dotnet#exceptions

Content source URL

https://github.com/Azure/azure-docs-sdk-dotnet/blob/master/xml/Microsoft.Azure.Cosmos/Container.xml

Document Version Independent Id

e8b56ad8-9021-3028-bc10-c8a8c7779b0f

Article author

@azure-sdk

Metadata

github-actions[bot] commented 4 months ago

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @anfeldma-ms @kushagraThapar @MehaKaushik @pjohari-ms @shurd @zfoster.

kushagraThapar commented 4 months ago

@bIgBV thanks for letting us know about this gap, we will fix it soon and will let you know once this is released.

philipthomas-MSFT commented 4 months ago

Hello and thanks for contacting the team. For short term, you can view the information that you are looking here. We will investigate into getting the documentation updated properly. @danieljurek , is this something you can help guide us there. Appears the link on the page that the customer is referring to is a dead link.