- Notifications
You must be signed in to change notification settings - Fork1.6k
Add missing OpenAI APIs to missingapi.yml file#11578
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Merged
Uh oh!
There was an error while loading.Please reload this page.
Conversation
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
Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com>
Copilot finished work on behalf ofgewarrenJuly 16, 2025 16:04
gewarren approved these changesJul 16, 2025
@dotnet/docs this is ready for final review. The build warning is in a file not changed in this PR. |
BillWagner approved these changesJul 17, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
This LGTM. Let's
7836bbd
intomain 6 of 8 checks passed
Uh oh!
There was an error while loading.Please reload this page.
Sign up for freeto 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.
Uh oh!
There was an error while loading.Please reload this page.
This PR resolves cross-reference warnings in the build by adding missing OpenAI API entries to the
_zip/missingapi.yml
file.Issue
The build was generating warnings for missing cross-references to these OpenAI APIs:
OpenAI.Assistants.FunctionToolDefinition
OpenAI.Chat.ChatTool
OpenAI.Realtime.ConversationFunctionTool
OpenAI.Responses.ResponseTool
These warnings appeared in the
xml/Microsoft.Extensions.AI/OpenAIClientExtensions.xml
file build process.Solution
Added the 4 missing API entries to
_zip/missingapi.yml
following the existing pattern used for other OpenAI APIs. Each entry includes:uid
: The fully qualified type namename
: The simple type namefullname
: The fully qualified type name (same as uid)href
: Link to the OpenAI .NET documentationThe entries were added in alphabetical order within their respective namespaces to maintain consistency with the existing file structure.
Changes
OpenAI.Assistants.FunctionToolDefinition
after existingOpenAI.Assistants.AssistantClient
OpenAI.Chat.ChatTool
after existingOpenAI.Chat.ChatClient
OpenAI.Realtime.ConversationFunctionTool
after existingOpenAI.OpenAIClient
OpenAI.Responses.ResponseTool
after existingOpenAI.Responses.OpenAIResponseClient
All entries use the same documentation URL pattern as existing OpenAI entries:
https://github.com/openai/openai-dotnet/blob/main/api/OpenAI.netstandard2.0.cs
Fixes#11577.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn moreCopilot coding agent tips in the docs.