Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The docs for the Azure.Core.Foundations.InnerError type has an outdated link to the Azure API Guidelines #5692

Open
ahsonkhan opened this issue Jan 22, 2025 · 0 comments
Labels
bug Something isn't working docs Improvements or additions to documentation triaged:core

Comments

@ahsonkhan
Copy link

For example, the following links to a doc that has been since moved/deprecated:
https://azure.github.io/typespec-azure/docs/libraries/azure-core/reference/data-types/#Azure.Core.Foundations.InnerError

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Image

I believe the link should be something like this:
https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors

Where is the best place to update this, so that existing typespec specs that utilize such common foundational types also benefit from the update?

Otherwise, the same outdated doc location gets propagated by language emitters into the SDK docs, which is visible to end-customers:
https://github.com/Azure/autorest.cpp/blob/1dd5126503496e495be81b8180aa68b6cd05cb29/packages/typespec-cpp/samples/appconfig/generated/inc/azure/data/appconfiguration/appconfiguration_models.hpp#L323-L329

P.S. If the docs live in a separate repo, please let me know or feel free to transfer the issue to the appropriate repo.

cc @lmazuel, @allenjzhang, @antkmsft

@markcowl markcowl added docs Improvements or additions to documentation bug Something isn't working labels Jan 22, 2025
@markcowl markcowl added this to the [2025] February milestone Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working docs Improvements or additions to documentation triaged:core
Projects
None yet
Development

No branches or pull requests

2 participants