Skip to content

docs: fix dead Learn link in ADR-0002 Agent Tools - #9766

Merged
Vincent Biret (baywet) merged 1 commit into
microsoft:mainfrom
leom1919:docs-adr-0002-dead-learn-link
Oct 27, 2026
Merged

Vincent Biret (baywet) merged 1 commit into
microsoft:mainfrom
leom1919:docs-adr-0002-dead-learn-link

Conversation

@leom1919

Copy link
Copy Markdown
Contributor

Motivation & Context

ADR-0002 (docs/decisions/0002-agent-tools.md), in the "OpenAPI Spec Tool" section, cites the Foundry Agent Service REST reference page for RunStepOpenApiToolCall:

https://learn.microsoft.com/en-us/rest/api/aifoundry/aiagents/run-steps/get-run-step?view=rest-aifoundry-aiagents-v1&tabs=HTTP#runstepopenapitoolcall

This page has been removed from Microsoft Learn and now returns HTTP 404 with no redirect (the whole rest/api/aifoundry/aiagents/run-steps reference path is gone; the neighboring openapi-spec-samples?pivots=rest-api link on the line above is still alive).

Description & Review Guide

  • What are the major changes? The dead REST reference link is replaced with the Python SDK class reference for the same run-step tool-call object: https://learn.microsoft.com/en-us/python/api/azure-ai-agents/azure.ai.agents.models.runstepopenapitoolcall?view=azure-python (documents RunStepOpenAPIToolCall — "A record of a call to an OpenAPI tool, issued by the model in evaluation of a defined tool" — verified HTTP 200).
  • What is the impact of these changes? The ADR's source citation resolves again. 1 line changed, link only.
  • What do you want reviewers to focus on? Whether the Python SDK class reference is the preferred surviving substitute — if the team would rather cite a different artifact (e.g. the .NET/Java/JS class docs, or drop the citation), happy to switch.

Related Issue

N/A - trivial change (docs-only single-link repair; dead link verified via HTTP 404, replacement verified via HTTP 200).

AI Assistance

  • No material AI assistance was used.
  • This is an AI-assisted contribution. I reviewed, understood, and verified all submitted content and accept responsibility for it.

AI assistance details: An automated link-integrity scan of the repository's markdown files flagged the dead Learn URL (curl 404, no redirect); a web search located the surviving SDK class reference documenting the same object. I verified both endpoints' HTTP status before proposing the substitution.

Contribution Checklist

  • The code builds clean without any errors or warnings (docs-only change; no build surface touched)
  • All unit tests pass, and I have added new tests where possible (docs-only change; no test surface touched)
  • The PR follows the Contribution Guidelines
  • This PR links to an agreed issue with no competing open PR, or the Related Issue section documents a trivial-change or repository-automation exception.
  • This is not a breaking change. If it is a breaking change, add the breaking change label (or add "[BREAKING]" to the title prefix, before or after any language prefix) — a workflow keeps the label and title prefix in sync automatically.

The Foundry Agent Service REST reference page
learn.microsoft.com/en-us/rest/api/aifoundry/aiagents/run-steps/get-run-step
(page documenting RunStepOpenApiToolCall) has been removed from Microsoft
Learn and returns HTTP 404 with no redirect. Replace it with the Python SDK
class reference for RunStepOpenAPIToolCall
(azure.ai.agents.models), which documents the same run-step tool-call
object and is the surviving equivalent.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The replacement page resolves and documents the same tool-call object, and the change is limited to one documentation link.

No open issues 🎉

What changed in this PR

Repairs a source citation in the Agent Framework’s Agent Tools ADR without changing runtime behavior.

Changes:

  • Replaces the dead REST reference URL with the Python SDK reference for RunStepOpenAPIToolCall, updating both the link target and displayed URL.
File Description
docs/​decisions/​0002-agent-tools.md Repairs the OpenAPI tool-call reference link.

Review effort: Balanced

This was referenced Nov 2, 2026

This branch was previously deployed

1 inactive deployment
github-app-auth — f2cc461c Deployed Oct 27, 2026 by leom1919 via team_check #7751
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Usage: [Issues, PRs], Target: documentation in the code base and learn docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants