Incorrect links to `typing.Container` rather than `azure.mgmt.containerinstance.models.container`

[eddyashton]

Type of issue

Typo

Description

Looking at the docs for the Azure SDK for Python, describing the fields in a azure.mgmt.containerinstance.models.containergroup.

One of these fields is containers, with type list[Container]. This is rendered with generated links as list[Container], with the Container link pointing to the (generic, deprecated) typing.Container type on docs.python.org (https://docs.python.org/3/library/typing.html#typing.Container). The real type is azure.mgmt.containerinstance.models.container, and the link should point here: https://learn.microsoft.com/en-us/python/api/azure-mgmt-containerinstance/azure.mgmt.containerinstance.models.container?view=azure-python.

I assume this is true of other types which have name collisions with other built-in/std lib types, though I haven't found any specific examples.

Page URL

https://learn.microsoft.com/en-us/python/api/azure-mgmt-containerinstance/azure.mgmt.containerinstance.models.containergroup?view=azure-python

Content source URL

https://github.com/MicrosoftDocs/azure-docs-sdk-python/blob/main/docs-ref-autogen/azure-mgmt-containerinstance/azure.mgmt.containerinstance.models.ContainerGroup.yml

Document Version Independent Id

2c57d585-8b6d-3ed7-13a6-28c89fb7cf2c

Platform Id

ce322cf9-3467-ed57-25e9-586599795d01

Article author

@lmazuel

Metadata

• ID: 97b00525-8267-2738-58f1-2214ea40d11b
• PlatformId: ce322cf9-3467-ed57-25e9-586599795d01
• Service: azure-container-instances

[github-actions]

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @samkreter @xizhamsft.

[github-actions]

Hi @eddyashton, I'm an AI Support assistant here to help with your issue. While the Azure SDK team reviews your request, I wanted to provide some possible tips and documentation that might help you in the meantime.

• The Container type link in the ContainerGroup docs (https://learn.microsoft.com/en-us/python/api/azure-mgmt-containerinstance/azure.mgmt.containerinstance.models.containergroup?view=azure-python) currently points to the generic deprecated typing.Container instead of the intended model at https://learn.microsoft.com/en-us/python/api/azure-mgmt-containerinstance/azure.mgmt.containerinstance.models.container?view=azure-python.
• The documentation generator is treating type names that collide with built-in or std lib types in a generic manner. An update to the link mapping in the doc generator to explicitly reference the model for Container should resolve this.
• Similar issues might exist for other models with conflicting type names; verifying the link generation in these cases should ensure that the correct API documentation is referenced.

The Azure SDK team will respond to your issue shortly. I hope these suggestions are helpful in the meantime. If this comment helped you, please give it a 👍. If the suggestion was not helpful or incorrect, please give it a 👎. Your feedback helps us improve!

[ChenxiJiang333]

Thank you for opening an issue, would make an investigation and return to you as soon as possible.

[msyyc]

The docs in source code is right

azure-sdk-for-python/sdk/containerinstance/azure-mgmt-containerinstance/azure/mgmt/containerinstance/models/_models_py3.py

Lines 864 to 865 in 546c90b

	:ivar containers: The containers within the container group. Required.
	:vartype containers: list[~azure.mgmt.containerinstance.models.Container]

while docs for wesite is not right: https://github.com/MicrosoftDocs/azure-docs-sdk-python/blob/d2141fb93de13e346d623531400ed8f57f65d461/docs-ref-autogen/azure-mgmt-containerinstance/azure.mgmt.containerinstance.models.ContainerGroup.yml#L36.
@danieljurek I understand our manual fix will be overwritten for https://github.com/MicrosoftDocs/azure-docs-sdk-python. Appreciate if you could help guide us how to fix it.

[xiangyan99]

@msyyc Maybe we need to talk to Jun Shi.

[msyyc]

@xiangyan99 Will ping Jun Shi in teams.

[msyyc]

Jun Shi created an issue to track https://dev.azure.com/ceapex/Engineering/_workitems/edit/1060568.