NetworkSecurityGrouop - flowLogs is type list[str] not type list[FlowLog]

Azure / azure-sdk-for-python

This repository is for active development of the Azure SDK for Python. For consumers of the SDK we recommend visiting our public developer docs at https://docs.microsoft.com/python/azure/ or our versioned developer docs at https://azure.github.io/azure-sdk-for-python.

MIT License

4.36k stars 2.71k forks source link

NetworkSecurityGrouop - flowLogs is type list[str] not type list[FlowLog] #28740

Closed dslagle closed 1 year ago

dslagle commented 1 year ago

The description for the attribute states the property is a list of references, however the type points to a complete FlowLog object.

Document Details

⚠ Do not edit this section. It is required for learn.microsoft.com ➟ GitHub issue linking.

ID: 2a3a7a10-0407-010e-b5f6-743b53efcd14
Version Independent ID: 5d129597-7f6c-ee27-34bb-73783c68523a
Content: azure.mgmt.network.v2020_08_01.models.NetworkSecurityGroup class
Content Source: docs-ref-autogen/azure-mgmt-network/azure.mgmt.network.v2020_08_01.models.NetworkSecurityGroup.yml
Service: network-watcher
GitHub Login: @lmazuel
Microsoft Alias: lmazuel

ghost commented 1 year ago

Thank you for your feedback. This has been routed to the support team for assistance.

msyyc commented 1 year ago

Hi @dslagle Do you mean the description is not accurate?

ghost commented 1 year ago

Hi, we're sending this friendly reminder because we haven't heard back from you in a while. We need more information about this issue to help address it. Please be sure to give us your input within the next 7 days. If we don't hear back from you within 14 days of this comment the issue will be automatically closed. Thank you!

dslagle commented 1 year ago

Apologies, I missed the notification for this. The description is correct to me. The type, however, indicates that full FlowLog information is returned when really the API only returns a reference to each flow log. Hence I think the type should be changed from list[FlowLog] to list[str]. Unless I'm misunderstanding what the types represent. Please let know, thanks!

Wzb123456789 commented 1 year ago

The FlowLog in list[FlowLog] represents a model type of data, not str type.

msyyc commented 1 year ago

Hi @dslagle, azure-mgmt-network is generated with swagger automatically which shows type of flow_logs is array of FlowLog

ghost commented 1 year ago

Hi @dslagle. Thank you for opening this issue and giving us the opportunity to assist. We believe that this has been addressed. If you feel that further discussion is needed, please add a comment with the text “/unresolve” to remove the “issue-addressed” label and continue the conversation.

ghost commented 1 year ago

Hi @dslagle, since you haven’t asked that we “/unresolve” the issue, we’ll close this out. If you believe further discussion is needed, please add a comment “/unresolve” to reopen the issue.