Fix broken REST API doc link in ai-projects README#38234
Open
nicholasdbrady wants to merge 2 commits intoAzure:mainfrom
Open
Fix broken REST API doc link in ai-projects README#38234nicholasdbrady wants to merge 2 commits intoAzure:mainfrom
nicholasdbrady wants to merge 2 commits intoAzure:mainfrom
Conversation
The reference link for ai_foundry_data_plane_rest_apis pointed to /aiprojects/ (plural), which 404s. The correct path is /aiproject/ (singular). Caught via OCV customer feedback (ADO #5203449). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
nicholasdbrady
requested review from
bobogogo1990,
dargilco,
ganeshyb and
glharper
as code owners
github-actions
Bot
added
Community Contribution
Contributor
|
Thank you for your contribution @nicholasdbrady! We will review the pull request and get back to you soon. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes a broken Learn.microsoft.com reference link in the @azure/ai-projects README by correcting the REST API documentation path from aiprojects (plural) to aiproject (singular), addressing a 404.
Changes:
- Update the
[ai_foundry_data_plane_rest_apis]reference URL to the correct Learn REST API path.
The /operation-groups?view=rest-aifoundry-aiprojects-v1 path returns 404 regardless of singular/plural. The working URL is the base REST API reference page at /rest/api/aifoundry/aiproject. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Author
|
Updated the URL — the initial fix changed |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The
[ai_foundry_data_plane_rest_apis]reference link at the bottom of the ai-projects README points to/rest/api/aifoundry/aiprojects/operation-groups(plural). That URL 404s on Learn.The correct path is
/rest/api/aifoundry/aiproject/operation-groups(singular).What changed: One character in the reference link on line 1358.
How I found it: A customer reported broken doc links via OCV after migrating to the new Foundry portal. The NPS auto-analysis confirmed the issue came from REST API doc links. I audited all azure-sdk-for-* repos and this was the only one affected. A matching fix for microsoft-foundry/foundry-samples is at microsoft-foundry/foundry-samples#662.