Add breaking change documentation for AddAzureOpenAI role default changes #4042
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
…to CognitiveServicesOpenAIUser. Fixes dotnet#3936
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for a new behavioral breaking change in .NET Aspire 9.4, detailing the updated default role for AddAzureOpenAI.
- Introduce a TOC entry for the new breaking change
- Update the 9.4 index to list the new documentation
- Add
add-azure-openai-default-changes.mdwith guidance on the role change
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/compatibility/toc.yml | Add new TOC item for the AddAzureOpenAI default role change |
| docs/compatibility/9.4/index.md | Add a table row linking to the new breaking change doc |
| docs/compatibility/9.4/add-azure-openai-default-changes.md | Create doc detailing the role default change and its impact |
Comments suppressed due to low confidence (5)
docs/compatibility/toc.yml:16
- The new TOC entry is only indented by 4 spaces, but it should be indented under the parent
items:block (8 spaces total) to maintain valid YAML nesting.
- name: AddAzureOpenAI defaults to CognitiveServicesOpenAIUser role
docs/compatibility/9.4/index.md:21
- [nitpick] Consider adding the definite article for clarity: change to "defaults to the CognitiveServicesOpenAIUser role".
| [AddAzureOpenAI defaults to CognitiveServicesOpenAIUser role](add-azure-openai-default-changes.md) | Behavioral change | 9.4 |
docs/compatibility/9.4/add-azure-openai-default-changes.md:25
- [nitpick] This section doesn’t use a heading; consider using
## Example(or### Example) above the code block to match the other sections and improve structure.
Example:
docs/compatibility/9.4/add-azure-openai-default-changes.md:28
- Verify that
Azure.Provisioning.CognitiveServicesis the correct namespace forAddAzureOpenAIandCognitiveServicesBuiltInRole; if not, update it to the appropriate namespace (e.g.,Azure.ResourceManager.CognitiveServices).
using Azure.Provisioning.CognitiveServices;
docs/compatibility/9.4/add-azure-openai-default-changes.md:52
- [nitpick] It might be clearer to include the method signature or parentheses (e.g.,
AddAzureOpenAI(...)) so readers know this is an extension method and can distinguish overloads.
- `Aspire.Hosting.AzureOpenAIExtensions.AddAzureOpenAI`
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Add breaking change documentation for AddAzureOpenAI role default changes.
Fixes #3936
Internal previews