Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .chronus/changes/python-add-ai-link-readme-2026-4-15.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking
changeKind: feature
packages:
- "@autorest/python"
- "@azure-tools/typespec-python"
---

Add "Use with AI tools" section to Azure packages README template
8 changes: 8 additions & 0 deletions .chronus/changes/python-refine-api-version-doc-2026-4-15.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
changeKind: fix
packages:
- "@autorest/python"
- "@azure-tools/typespec-python"
---

Refine `api_version` argument doc to show `None` as default value and include note about operation's default API version being used when not set
2 changes: 1 addition & 1 deletion packages/autorest.python/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
},
"homepage": "https://github.com/Azure/autorest.python/blob/main/README.md",
"dependencies": {
"@typespec/http-client-python": "https://artprodcus3.artifacts.visualstudio.com/A0fb41ef4-5012-48a9-bf39-4ee3de03ee35/29ec6040-b234-4e31-b139-33dc4287b756/_apis/artifact/cGlwZWxpbmVhcnRpZmFjdDovL2F6dXJlLXNkay9wcm9qZWN0SWQvMjllYzYwNDAtYjIzNC00ZTMxLWIxMzktMzNkYzQyODdiNzU2L2J1aWxkSWQvNjE1ODIzMi9hcnRpZmFjdE5hbWUvYnVpbGRfYXJ0aWZhY3RzX3B5dGhvbg2/content?format=file&subPath=%2Fpackages%2Ftypespec-http-client-python-0.28.3.tgz",
"@typespec/http-client-python": "https://artprodcus3.artifacts.visualstudio.com/A0fb41ef4-5012-48a9-bf39-4ee3de03ee35/29ec6040-b234-4e31-b139-33dc4287b756/_apis/artifact/cGlwZWxpbmVhcnRpZmFjdDovL2F6dXJlLXNkay9wcm9qZWN0SWQvMjllYzYwNDAtYjIzNC00ZTMxLWIxMzktMzNkYzQyODdiNzU2L2J1aWxkSWQvNjE2MzI1OS9hcnRpZmFjdE5hbWUvYnVpbGRfYXJ0aWZhY3RzX3B5dGhvbg2/content?format=file&subPath=%2Fpackages%2Ftypespec-http-client-python-0.28.3.tgz",
"@autorest/system-requirements": "~1.0.2",
"fs-extra": "~11.2.0",
"tsx": "^4.21.0"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,9 @@ class AutoRestAzureSpecialParametersTestClient: # pylint: disable=too-many-inst
:keyword cloud_setting: The cloud setting for which to get the ARM endpoint. Default value is
None.
:paramtype cloud_setting: ~azure.core.AzureClouds
:keyword api_version: Api Version. Default value is "2015-07-01-preview". Note that overriding
this default value may result in unsupported behavior.
:keyword api_version: Api Version. Known values are "2015-07-01-preview" and None. Default
value is None. If not set, the operation's default API version will be used. Note that
overriding this default value may result in unsupported behavior.
:paramtype api_version: str
"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,9 @@ class AutoRestAzureSpecialParametersTestClientConfiguration: # pylint: disable=
:param cloud_setting: The cloud setting for which to get the ARM endpoint. Default value is
None.
:type cloud_setting: ~azure.core.AzureClouds
:keyword api_version: Api Version. Default value is "2015-07-01-preview". Note that overriding
this default value may result in unsupported behavior.
:keyword api_version: Api Version. Known values are "2015-07-01-preview" and None. Default
value is None. If not set, the operation's default API version will be used. Note that
overriding this default value may result in unsupported behavior.
:paramtype api_version: str
"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,9 @@ class AutoRestAzureSpecialParametersTestClient: # pylint: disable=too-many-inst
:keyword cloud_setting: The cloud setting for which to get the ARM endpoint. Default value is
None.
:paramtype cloud_setting: ~azure.core.AzureClouds
:keyword api_version: Api Version. Default value is "2015-07-01-preview". Note that overriding
this default value may result in unsupported behavior.
:keyword api_version: Api Version. Known values are "2015-07-01-preview" and None. Default
value is None. If not set, the operation's default API version will be used. Note that
overriding this default value may result in unsupported behavior.
:paramtype api_version: str
"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,9 @@ class AutoRestAzureSpecialParametersTestClientConfiguration: # pylint: disable=
:param cloud_setting: The cloud setting for which to get the ARM endpoint. Default value is
None.
:type cloud_setting: ~azure.core.AzureClouds
:keyword api_version: Api Version. Default value is "2015-07-01-preview". Note that overriding
this default value may result in unsupported behavior.
:keyword api_version: Api Version. Known values are "2015-07-01-preview" and None. Default
value is None. If not set, the operation's default API version will be used. Note that
overriding this default value may result in unsupported behavior.
:paramtype api_version: str
"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ class AutoRestPagingTestService:
:keyword cloud_setting: The cloud setting for which to get the ARM endpoint. Default value is
None.
:paramtype cloud_setting: ~azure.core.AzureClouds
:keyword api_version: Api Version. Default value is "1.0.0". Note that overriding this default
:keyword api_version: Api Version. Known values are "1.0.0" and None. Default value is None. If
not set, the operation's default API version will be used. Note that overriding this default
value may result in unsupported behavior.
:paramtype api_version: str
:keyword int polling_interval: Default waiting time between two polls for LRO operations if no
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ class AutoRestPagingTestServiceConfiguration: # pylint: disable=too-many-instan
:param cloud_setting: The cloud setting for which to get the ARM endpoint. Default value is
None.
:type cloud_setting: ~azure.core.AzureClouds
:keyword api_version: Api Version. Default value is "1.0.0". Note that overriding this default
:keyword api_version: Api Version. Known values are "1.0.0" and None. Default value is None. If
not set, the operation's default API version will be used. Note that overriding this default
value may result in unsupported behavior.
:paramtype api_version: str
"""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ class AutoRestPagingTestService:
:keyword cloud_setting: The cloud setting for which to get the ARM endpoint. Default value is
None.
:paramtype cloud_setting: ~azure.core.AzureClouds
:keyword api_version: Api Version. Default value is "1.0.0". Note that overriding this default
:keyword api_version: Api Version. Known values are "1.0.0" and None. Default value is None. If
not set, the operation's default API version will be used. Note that overriding this default
value may result in unsupported behavior.
:paramtype api_version: str
:keyword int polling_interval: Default waiting time between two polls for LRO operations if no
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ class AutoRestPagingTestServiceConfiguration: # pylint: disable=too-many-instan
:param cloud_setting: The cloud setting for which to get the ARM endpoint. Default value is
None.
:type cloud_setting: ~azure.core.AzureClouds
:keyword api_version: Api Version. Default value is "1.0.0". Note that overriding this default
:keyword api_version: Api Version. Known values are "1.0.0" and None. Default value is None. If
not set, the operation's default API version will be used. Note that overriding this default
value may result in unsupported behavior.
:paramtype api_version: str
"""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ class PagingClientConfiguration: # pylint: disable=too-many-instance-attributes
:param cloud_setting: The cloud setting for which to get the ARM endpoint. Default value is
None.
:type cloud_setting: ~azure.core.AzureClouds
:keyword api_version: Api Version. Default value is "1.0.0". Note that overriding this default
:keyword api_version: Api Version. Known values are "1.0.0" and None. Default value is None. If
not set, the operation's default API version will be used. Note that overriding this default
value may result in unsupported behavior.
:paramtype api_version: str
"""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ class PagingClient:
:keyword cloud_setting: The cloud setting for which to get the ARM endpoint. Default value is
None.
:paramtype cloud_setting: ~azure.core.AzureClouds
:keyword api_version: Api Version. Default value is "1.0.0". Note that overriding this default
:keyword api_version: Api Version. Known values are "1.0.0" and None. Default value is None. If
not set, the operation's default API version will be used. Note that overriding this default
value may result in unsupported behavior.
:paramtype api_version: str
:keyword int polling_interval: Default waiting time between two polls for LRO operations if no
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ class PagingClientConfiguration: # pylint: disable=too-many-instance-attributes
:param cloud_setting: The cloud setting for which to get the ARM endpoint. Default value is
None.
:type cloud_setting: ~azure.core.AzureClouds
:keyword api_version: Api Version. Default value is "1.0.0". Note that overriding this default
:keyword api_version: Api Version. Known values are "1.0.0" and None. Default value is None. If
not set, the operation's default API version will be used. Note that overriding this default
value may result in unsupported behavior.
:paramtype api_version: str
"""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ class PagingClient:
:keyword cloud_setting: The cloud setting for which to get the ARM endpoint. Default value is
None.
:paramtype cloud_setting: ~azure.core.AzureClouds
:keyword api_version: Api Version. Default value is "1.0.0". Note that overriding this default
:keyword api_version: Api Version. Known values are "1.0.0" and None. Default value is None. If
not set, the operation's default API version will be used. Note that overriding this default
value may result in unsupported behavior.
:paramtype api_version: str
:keyword int polling_interval: Default waiting time between two polls for LRO operations if no
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ class AutoRestPagingTestService:
:vartype paging: paging.operations.PagingOperations
:param base_url: Service URL. Default value is "http://localhost:3000".
:type base_url: str
:keyword api_version: Api Version. Default value is "1.0.0". Note that overriding this default
:keyword api_version: Api Version. Known values are "1.0.0" and None. Default value is None. If
not set, the operation's default API version will be used. Note that overriding this default
value may result in unsupported behavior.
:paramtype api_version: str
:keyword int polling_interval: Default waiting time between two polls for LRO operations if no
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ class AutoRestPagingTestServiceConfiguration: # pylint: disable=too-many-instan
Note that all parameters used to create this instance are saved as instance
attributes.

:keyword api_version: Api Version. Default value is "1.0.0". Note that overriding this default
:keyword api_version: Api Version. Known values are "1.0.0" and None. Default value is None. If
not set, the operation's default API version will be used. Note that overriding this default
value may result in unsupported behavior.
:paramtype api_version: str
"""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ class AutoRestPagingTestService:
:vartype paging: paging.aio.operations.PagingOperations
:param base_url: Service URL. Default value is "http://localhost:3000".
:type base_url: str
:keyword api_version: Api Version. Default value is "1.0.0". Note that overriding this default
:keyword api_version: Api Version. Known values are "1.0.0" and None. Default value is None. If
not set, the operation's default API version will be used. Note that overriding this default
value may result in unsupported behavior.
:paramtype api_version: str
:keyword int polling_interval: Default waiting time between two polls for LRO operations if no
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ class AutoRestPagingTestServiceConfiguration: # pylint: disable=too-many-instan
Note that all parameters used to create this instance are saved as instance
attributes.

:keyword api_version: Api Version. Default value is "1.0.0". Note that overriding this default
:keyword api_version: Api Version. Known values are "1.0.0" and None. Default value is None. If
not set, the operation's default API version will be used. Note that overriding this default
value may result in unsupported behavior.
:paramtype api_version: str
"""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,9 @@ class StorageManagementClientConfiguration: # pylint: disable=too-many-instance
:param cloud_setting: The cloud setting for which to get the ARM endpoint. Default value is
None.
:type cloud_setting: ~azure.core.AzureClouds
:keyword api_version: Api Version. Default value is "2015-05-01-preview". Note that overriding
this default value may result in unsupported behavior.
:keyword api_version: Api Version. Known values are "2015-05-01-preview" and None. Default
value is None. If not set, the operation's default API version will be used. Note that
overriding this default value may result in unsupported behavior.
:paramtype api_version: str
"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,9 @@ class StorageManagementClient:
:keyword cloud_setting: The cloud setting for which to get the ARM endpoint. Default value is
None.
:paramtype cloud_setting: ~azure.core.AzureClouds
:keyword api_version: Api Version. Default value is "2015-05-01-preview". Note that overriding
this default value may result in unsupported behavior.
:keyword api_version: Api Version. Known values are "2015-05-01-preview" and None. Default
value is None. If not set, the operation's default API version will be used. Note that
overriding this default value may result in unsupported behavior.
:paramtype api_version: str
:keyword int polling_interval: Default waiting time between two polls for LRO operations if no
Retry-After header is present.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,9 @@ class StorageManagementClientConfiguration: # pylint: disable=too-many-instance
:param cloud_setting: The cloud setting for which to get the ARM endpoint. Default value is
None.
:type cloud_setting: ~azure.core.AzureClouds
:keyword api_version: Api Version. Default value is "2015-05-01-preview". Note that overriding
this default value may result in unsupported behavior.
:keyword api_version: Api Version. Known values are "2015-05-01-preview" and None. Default
value is None. If not set, the operation's default API version will be used. Note that
overriding this default value may result in unsupported behavior.
:paramtype api_version: str
"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,9 @@ class StorageManagementClient:
:keyword cloud_setting: The cloud setting for which to get the ARM endpoint. Default value is
None.
:paramtype cloud_setting: ~azure.core.AzureClouds
:keyword api_version: Api Version. Default value is "2015-05-01-preview". Note that overriding
this default value may result in unsupported behavior.
:keyword api_version: Api Version. Known values are "2015-05-01-preview" and None. Default
value is None. If not set, the operation's default API version will be used. Note that
overriding this default value may result in unsupported behavior.
:paramtype api_version: str
:keyword int polling_interval: Default waiting time between two polls for LRO operations if no
Retry-After header is present.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,9 @@ class MicrosoftAzureTestUrlConfiguration: # pylint: disable=too-many-instance-a
:param cloud_setting: The cloud setting for which to get the ARM endpoint. Default value is
None.
:type cloud_setting: ~azure.core.AzureClouds
:keyword api_version: Api Version. Default value is "2014-04-01-preview". Note that overriding
this default value may result in unsupported behavior.
:keyword api_version: Api Version. Known values are "2014-04-01-preview" and None. Default
value is None. If not set, the operation's default API version will be used. Note that
overriding this default value may result in unsupported behavior.
:paramtype api_version: str
"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,9 @@ class MicrosoftAzureTestUrl:
:keyword cloud_setting: The cloud setting for which to get the ARM endpoint. Default value is
None.
:paramtype cloud_setting: ~azure.core.AzureClouds
:keyword api_version: Api Version. Default value is "2014-04-01-preview". Note that overriding
this default value may result in unsupported behavior.
:keyword api_version: Api Version. Known values are "2014-04-01-preview" and None. Default
value is None. If not set, the operation's default API version will be used. Note that
overriding this default value may result in unsupported behavior.
:paramtype api_version: str
"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,9 @@ class MicrosoftAzureTestUrlConfiguration: # pylint: disable=too-many-instance-a
:param cloud_setting: The cloud setting for which to get the ARM endpoint. Default value is
None.
:type cloud_setting: ~azure.core.AzureClouds
:keyword api_version: Api Version. Default value is "2014-04-01-preview". Note that overriding
this default value may result in unsupported behavior.
:keyword api_version: Api Version. Known values are "2014-04-01-preview" and None. Default
value is None. If not set, the operation's default API version will be used. Note that
overriding this default value may result in unsupported behavior.
:paramtype api_version: str
"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,9 @@ class MicrosoftAzureTestUrl:
:keyword cloud_setting: The cloud setting for which to get the ARM endpoint. Default value is
None.
:paramtype cloud_setting: ~azure.core.AzureClouds
:keyword api_version: Api Version. Default value is "2014-04-01-preview". Note that overriding
this default value may result in unsupported behavior.
:keyword api_version: Api Version. Known values are "2014-04-01-preview" and None. Default
value is None. If not set, the operation's default API version will be used. Note that
overriding this default value may result in unsupported behavior.
:paramtype api_version: str
"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,9 @@ class AutoRestAzureSpecialParametersTestClient: # pylint: disable=too-many-inst
:keyword cloud_setting: The cloud setting for which to get the ARM endpoint. Default value is
None.
:paramtype cloud_setting: ~azure.core.AzureClouds
:keyword api_version: Api Version. Default value is "2015-07-01-preview". Note that overriding
this default value may result in unsupported behavior.
:keyword api_version: Api Version. Known values are "2015-07-01-preview" and None. Default
value is None. If not set, the operation's default API version will be used. Note that
overriding this default value may result in unsupported behavior.
:paramtype api_version: str
"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,9 @@ class AutoRestAzureSpecialParametersTestClientConfiguration: # pylint: disable=
:param cloud_setting: The cloud setting for which to get the ARM endpoint. Default value is
None.
:type cloud_setting: ~azure.core.AzureClouds
:keyword api_version: Api Version. Default value is "2015-07-01-preview". Note that overriding
this default value may result in unsupported behavior.
:keyword api_version: Api Version. Known values are "2015-07-01-preview" and None. Default
value is None. If not set, the operation's default API version will be used. Note that
overriding this default value may result in unsupported behavior.
:paramtype api_version: str
"""

Expand Down
Loading
Loading