[AppConfig] Address apiview feedback (Azure#31999)

Author: Yalin Li

sdk/appconfiguration/azure-appconfiguration/CHANGELOG.md

@@ -5,6 +5,10 @@
 ### Features Added
 
 ### Breaking Changes
+- Rename parameter `name` in `list_snapshot_configuration_settings()` to `snapshot_name`.
+- Remove keyword argument `accept_datetime` in `list_snapshot_configuration_settings()`.
+- Rename `Snapshot` property `items_count` to `item_count`.
+- Publish enum `SnapshotStatus`, and accept the type for `status` parameter in `list_snapshots()` and `status` property in `Snapshot` model.
 
 ### Bugs Fixed
 

sdk/appconfiguration/azure-appconfiguration/README.md

@@ -311,7 +311,7 @@ for snapshot in client.list_snapshots():
 <!-- SNIPPET:snapshot_samples.list_snapshot_configuration_settings -->
 
 ```python
-for config_setting in client.list_snapshot_configuration_settings(name=snapshot_name):
+for config_setting in client.list_snapshot_configuration_settings(snapshot_name=snapshot_name):
     print_configuration_setting(config_setting)
 ```
 
@@ -410,7 +410,7 @@ async for snapshot in client.list_snapshots():
 <!-- SNIPPET:snapshot_samples_async.list_snapshot_configuration_settings -->
 
 ```python
-async for config_setting in client.list_snapshot_configuration_settings(name=snapshot_name):
+async for config_setting in client.list_snapshot_configuration_settings(snapshot_name=snapshot_name):
     print_configuration_setting(config_setting)
 ```
 

sdk/appconfiguration/azure-appconfiguration/azure/appconfiguration/__init__.py

@@ -18,6 +18,7 @@
     Snapshot,
     ConfigurationSettingFilter,
 )
+from ._generated.models import SnapshotStatus
 from ._version import VERSION
 from ._azure_appconfiguration_error import ResourceReadOnlyError
 
@@ -29,6 +30,7 @@
     "FeatureFlagConfigurationSetting",
     "SecretReferenceConfigurationSetting",
     "Snapshot",
+    "SnapshotStatus",
     "ConfigurationSettingFilter",
     "FILTER_PERCENTAGE",
     "FILTER_TARGETING",

sdk/appconfiguration/azure-appconfiguration/azure/appconfiguration/_azure_appconfiguration_client.py

@@ -35,7 +35,7 @@
 from ._azure_appconfiguration_credential import AppConfigConnectionStringCredential
 from ._generated import AzureAppConfiguration
 from ._generated._configuration import AzureAppConfigurationConfiguration
-from ._generated.models import SnapshotStatus, SnapshotUpdateParameters
+from ._generated.models import SnapshotUpdateParameters, SnapshotStatus
 from ._models import ConfigurationSetting, ConfigurationSettingFilter, Snapshot
 from ._utils import (
     get_endpoint_from_connection_string,
@@ -562,15 +562,18 @@ def begin_create_snapshot(
         :param filters: A list of filters used to filter the configuration settings by key field and label field
             included in the snapshot.
         :type filters: list[~azure.appconfiguration.ConfigurationSettingFilter]
-        :keyword str composition_type: The composition type describes how the key-values
+        :keyword composition_type: The composition type describes how the key-values
             within the snapshot are composed. Known values are: "key" and "key_label". The "key" composition type
             ensures there are no two key-values containing the same key. The 'key_label' composition type ensures
             there are no two key-values containing the same key and label.
-        :keyword int retention_period: The amount of time, in seconds, that a snapshot will remain in the
+        :type composition_type: str or None
+        :keyword retention_period: The amount of time, in seconds, that a snapshot will remain in the
             archived state before expiring. This property is only writable during the creation of a
             snapshot. If not specified, will set to 2592000(30 days). If specified, should be
             in range 3600(1 hour) to 7776000(90 days).
-        :keyword dict[str, str] tags: The tags of the snapshot.
+        :type retention_period: int or None
+        :keyword tags: The tags of the snapshot.
+        :type tags: dict[str, str] or None
         :return: A poller for create snapshot operation. Call `result()` on this object to wait for the
             operation to complete and get the created snapshot.
         :rtype: ~azure.core.polling.LROPoller[~azure.appconfiguration.Snapshot]
@@ -605,7 +608,8 @@ def archive_snapshot(
         :type name: str
         :keyword match_condition: The match condition to use upon the etag.
         :type match_condition: ~azure.core.MatchConditions
-        :keyword str etag: Check if the Snapshot is changed. Set None to skip checking etag.
+        :keyword etag: Check if the Snapshot is changed. Set None to skip checking etag.
+        :type etag: str or None
         :return: The Snapshot returned from the service.
         :rtype: ~azure.appconfiguration.Snapshot
         :raises: :class:`~azure.core.exceptions.HttpResponseError`
@@ -647,7 +651,8 @@ def recover_snapshot(
         :type name: str
         :keyword match_condition: The match condition to use upon the etag.
         :type match_condition: ~azure.core.MatchConditions
-        :keyword str etag: Check if the Snapshot is changed. Set None to skip checking etag.
+        :keyword etag: Check if the Snapshot is changed. Set None to skip checking etag.
+        :type etag: str or None
         :return: The Snapshot returned from the service.
         :rtype: ~azure.appconfiguration.Snapshot
         :raises: :class:`~azure.core.exceptions.HttpResponseError`
@@ -680,7 +685,8 @@ def get_snapshot(self, name: str, *, fields: Optional[List[str]] = None, **kwarg
 
         :param name: The name of the configuration setting snapshot to retrieve.
         :type name: str
-        :keyword list[str] fields: Specify which fields to include in the results. Leave None to include all fields.
+        :keyword fields: Specify which fields to include in the results. Leave None to include all fields.
+        :type fields: list[str] or None
         :return: The Snapshot returned from the service.
         :rtype: ~azure.appconfiguration.Snapshot
         :raises: :class:`~azure.core.exceptions.HttpResponseError`
@@ -699,15 +705,18 @@ def list_snapshots(
         *,
         name: Optional[str] = None,
         fields: Optional[List[str]] = None,
-        status: Optional[List[str]] = None,
+        status: Optional[List[Union[str, SnapshotStatus]]] = None,
         **kwargs
     ) -> ItemPaged[Snapshot]:
         """List the configuration setting snapshots stored in the configuration service, optionally filtered by
         snapshot name, snapshot status and fields to present in return.
 
-        :keyword str name: Filter results based on snapshot name.
-        :keyword list[str] fields: Specify which fields to include in the results. Leave None to include all fields.
-        :keyword list[str] status: Filter results based on snapshot keys.
+        :keyword name: Filter results based on snapshot name.
+        :type name: str or None
+        :keyword fields: Specify which fields to include in the results. Leave None to include all fields.
+        :type fields: list[str] or None
+        :keyword status: Filter results based on snapshot keys.
+        :type status: list[str] or list[~azure.appconfiguration.SnapshotStatus] or None
         :return: An iterator of :class:`~azure.appconfiguration.Snapshot`
         :rtype: ~azure.core.paging.ItemPaged[~azure.appconfiguration.Snapshot]
         :raises: :class:`~azure.core.exceptions.HttpResponseError`
@@ -725,14 +734,14 @@ def list_snapshots(
 
     @distributed_trace
     def list_snapshot_configuration_settings(
-        self, name: str, *, accept_datetime: Optional[str] = None, fields: Optional[List[str]] = None, **kwargs
+        self, snapshot_name: str, *, fields: Optional[List[str]] = None, **kwargs
     ) -> ItemPaged[ConfigurationSetting]:
         """List the configuration settings stored under a snapshot in the configuration service, optionally filtered by
         accept_datetime and fields to present in return.
 
-        :param str name: The snapshot name.
-        :keyword str accept_datetime: Filter out ConfigurationSetting created after this datetime
-        :keyword list[str] fields: Specify which fields to include in the results. Leave None to include all fields
+        :param str snapshot_name: The snapshot name.
+        :keyword fields: Specify which fields to include in the results. Leave None to include all fields.
+        :type fields: list[str] or None
         :return: An iterator of :class:`~azure.appconfiguration.ConfigurationSetting`
         :rtype: ~azure.core.paging.ItemPaged[~azure.appconfiguration.ConfigurationSetting]
         :raises: :class:`~azure.core.exceptions.HttpResponseError`
@@ -743,8 +752,7 @@ def list_snapshot_configuration_settings(
         try:
             return self._impl.get_key_values(  # type: ignore
                 select=fields,
-                snapshot=name,
-                accept_datetime=accept_datetime,
+                snapshot=snapshot_name,
                 cls=lambda objs: [ConfigurationSetting._from_generated(x) for x in objs],
                 **kwargs
             )

sdk/appconfiguration/azure-appconfiguration/azure/appconfiguration/_models.py

@@ -11,8 +11,9 @@
 from ._generated._serialization import Model
 from ._generated.models import (
     KeyValue,
-    Snapshot as GeneratedSnapshot,
     KeyValueFilter,
+    Snapshot as GeneratedSnapshot,
+    SnapshotStatus,
 )
 
 if sys.version_info >= (3, 8):
@@ -409,7 +410,7 @@ class Snapshot:  # pylint: disable=too-many-instance-attributes
 
     name: Optional[str]
     """The name of the snapshot."""
-    status: Optional[str]
+    status: Optional[Union[str, SnapshotStatus]]
     """The current status of the snapshot. Known values are: "provisioning", "ready",
         "archived", and "failed"."""
     filters: List[ConfigurationSettingFilter]
@@ -429,7 +430,7 @@ class Snapshot:  # pylint: disable=too-many-instance-attributes
         snapshot. If not specified, the default lifetime of key-value revisions will be used."""
     size: Optional[int]
     """The size in bytes of the snapshot."""
-    items_count: Optional[int]
+    item_count: Optional[int]
     """The amount of key-values in the snapshot."""
     tags: Optional[Dict[str, str]]
     """The tags of the snapshot."""
@@ -468,7 +469,7 @@ def __init__(
         self.expires = None
         self.retention_period = retention_period
         self.size = None
-        self.items_count = None
+        self.item_count = None
         self.tags = tags
         self.etag = None
 
@@ -494,7 +495,7 @@ def _from_generated(cls, generated: GeneratedSnapshot) -> "Snapshot":
         snapshot.created = generated.created
         snapshot.expires = generated.expires
         snapshot.size = generated.size
-        snapshot.items_count = generated.items_count
+        snapshot.item_count = generated.items_count
         snapshot.etag = generated.etag
 
         return snapshot
@@ -525,7 +526,7 @@ def _from_deserialized(  # pylint:disable=unused-argument
         snapshot.created = deserialized.created
         snapshot.expires = deserialized.expires
         snapshot.size = deserialized.size
-        snapshot.items_count = deserialized.items_count
+        snapshot.item_count = deserialized.items_count
         snapshot.etag = deserialized.etag
 
         return snapshot

sdk/appconfiguration/azure-appconfiguration/azure/appconfiguration/aio/_azure_appconfiguration_client_async.py

@@ -28,7 +28,7 @@
 from .._azure_appconfiguration_requests import AppConfigRequestsCredentialsPolicy
 from .._azure_appconfiguration_credential import AppConfigConnectionStringCredential
 from .._generated.aio import AzureAppConfiguration
-from .._generated.models import SnapshotStatus, SnapshotUpdateParameters
+from .._generated.models import SnapshotUpdateParameters, SnapshotStatus
 from .._models import ConfigurationSetting, ConfigurationSettingFilter, Snapshot
 from .._user_agent import USER_AGENT
 from .._utils import (
@@ -551,15 +551,18 @@ async def begin_create_snapshot(
         :param filters: A list of filters used to filter the configuration settings by key field and label field
             included in the snapshot.
         :type filters: list[~azure.appconfiguration.ConfigurationSettingFilter]
-        :keyword str composition_type: The composition type describes how the key-values
+        :keyword composition_type: The composition type describes how the key-values
             within the snapshot are composed. Known values are: "key" and "key_label". The "key" composition type
             ensures there are no two key-values containing the same key. The 'key_label' composition type ensures
             there are no two key-values containing the same key and label.
-        :keyword int retention_period: The amount of time, in seconds, that a snapshot will remain in the
+        :type composition_type: str or None
+        :keyword retention_period: The amount of time, in seconds, that a snapshot will remain in the
             archived state before expiring. This property is only writable during the creation of a
             snapshot. If not specified, will set to 2592000(30 days). If specified, should be
             in range 3600(1 hour) to 7776000(90 days).
-        :keyword dict[str, str] tags: The tags of the snapshot.
+        :type retention_period: int or None
+        :keyword tags: The tags of the snapshot.
+        :type tags: dict[str, str] or None
         :return: An async poller for create snapshot operation. Call `result()` on this object to wait for the
             operation to complete and get the created snapshot.
         :rtype: ~azure.core.polling.AsyncLROPoller[~azure.appconfiguration.Snapshot]
@@ -594,7 +597,8 @@ async def archive_snapshot(
         :type name: str
         :keyword match_condition: The match condition to use upon the etag.
         :type match_condition: ~azure.core.MatchConditions
-        :keyword str etag: Check if the Snapshot is changed. Set None to skip checking etag.
+        :keyword etag: Check if the Snapshot is changed. Set None to skip checking etag.
+        :type etag: str or None
         :return: The Snapshot returned from the service.
         :rtype: ~azure.appconfiguration.Snapshot
         :raises: :class:`~azure.core.exceptions.HttpResponseError`
@@ -636,7 +640,8 @@ async def recover_snapshot(
         :type name: str
         :keyword match_condition: The match condition to use upon the etag.
         :type match_condition: ~azure.core.MatchConditions
-        :keyword str etag: Check if the Snapshot is changed. Set None to skip checking etag.
+        :keyword etag: Check if the Snapshot is changed. Set None to skip checking etag.
+        :type etag: str or None
         :return: The Snapshot returned from the service.
         :rtype: ~azure.appconfiguration.Snapshot
         :raises: :class:`~azure.core.exceptions.HttpResponseError`
@@ -669,7 +674,8 @@ async def get_snapshot(self, name: str, *, fields: Optional[List[str]] = None, *
 
         :param name: The name of the configuration setting snapshot to retrieve.
         :type name: str
-        :keyword list[str] fields: Specify which fields to include in the results. Leave None to include all fields.
+        :keyword fields: Specify which fields to include in the results. Leave None to include all fields.
+        :type fields: list[str] or None
         :return: The Snapshot returned from the service.
         :rtype: ~azure.appconfiguration.Snapshot
         :raises: :class:`~azure.core.exceptions.HttpResponseError`
@@ -688,15 +694,18 @@ def list_snapshots(
         *,
         name: Optional[str] = None,
         fields: Optional[List[str]] = None,
-        status: Optional[List[str]] = None,
+        status: Optional[List[Union[str, SnapshotStatus]]] = None,
         **kwargs
     ) -> AsyncItemPaged[Snapshot]:
         """List the configuration setting snapshots stored in the configuration service, optionally filtered by
         snapshot name, snapshot status and fields to present in return.
 
-        :keyword str name: Filter results based on snapshot name.
-        :keyword list[str] fields: Specify which fields to include in the results. Leave None to include all fields.
-        :keyword list[str] status: Filter results based on snapshot keys.
+        :keyword name: Filter results based on snapshot name.
+        :type name: str or None
+        :keyword fields: Specify which fields to include in the results. Leave None to include all fields.
+        :type fields: list[str] or None
+        :keyword status: Filter results based on snapshot keys.
+        :type status: list[str] or list[~azure.appconfiguration.SnapshotStatus] or None
         :return: An async iterator of :class:`~azure.appconfiguration.Snapshot`
         :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.appconfiguration.Snapshot]
         :raises: :class:`~azure.core.exceptions.HttpResponseError`
@@ -714,14 +723,14 @@ def list_snapshots(
 
     @distributed_trace
     def list_snapshot_configuration_settings(
-        self, name: str, *, accept_datetime: Optional[str] = None, fields: Optional[List[str]] = None, **kwargs
+        self, snapshot_name: str, *, fields: Optional[List[str]] = None, **kwargs
     ) -> AsyncItemPaged[ConfigurationSetting]:
         """List the configuration settings stored under a snapshot in the configuration service, optionally filtered by
         accept_datetime and fields to present in return.
 
-        :param str name: The snapshot name.
-        :keyword str accept_datetime: Filter out ConfigurationSetting created after this datetime.
-        :keyword list[str] fields: Specify which fields to include in the results. Leave None to include all fields.
+        :param str snapshot_name: The snapshot name.
+        :keyword fields: Specify which fields to include in the results. Leave None to include all fields.
+        :type fields: list[str] or None
         :return: An async iterator of :class:`~azure.appconfiguration.ConfigurationSetting`
         :rtype: ~azure.core.paging.AsyncItemPaged[~azure.appconfiguration.ConfigurationSetting]
         :raises: :class:`~azure.core.exceptions.HttpResponseError`
@@ -732,8 +741,7 @@ def list_snapshot_configuration_settings(
         try:
             return self._impl.get_key_values(  # type: ignore
                 select=fields,
-                snapshot=name,
-                accept_datetime=accept_datetime,
+                snapshot=snapshot_name,
                 cls=lambda objs: [ConfigurationSetting._from_generated(x) for x in objs],
                 **kwargs
             )

sdk/appconfiguration/azure-appconfiguration/samples/snapshot_samples.py

@@ -65,7 +65,7 @@ def main():
         print("")
 
         # [START list_snapshot_configuration_settings]
-        for config_setting in client.list_snapshot_configuration_settings(name=snapshot_name):
+        for config_setting in client.list_snapshot_configuration_settings(snapshot_name=snapshot_name):
             print_configuration_setting(config_setting)
         # [END list_snapshot_configuration_settings]
 

sdk/appconfiguration/azure-appconfiguration/samples/snapshot_samples_async.py

@@ -68,7 +68,7 @@ async def main():
         print("")
 
         # [START list_snapshot_configuration_settings]
-        async for config_setting in client.list_snapshot_configuration_settings(name=snapshot_name):
+        async for config_setting in client.list_snapshot_configuration_settings(snapshot_name=snapshot_name):
             print_configuration_setting(config_setting)
         # [END list_snapshot_configuration_settings]
 

sdk/appconfiguration/azure-appconfiguration/samples/util.py

@@ -30,6 +30,6 @@ def print_snapshot(snapshot):
     print(f"expires: {snapshot.expires}")
     print(f"retention_period: {snapshot.retention_period}")
     print(f"size: {snapshot.size}")
-    print(f"items_count: {snapshot.items_count}")
+    print(f"item_count: {snapshot.item_count}")
     print(f"tags: {snapshot.tags}")
     print(f"etag: {snapshot.etag}")

sdk/appconfiguration/azure-appconfiguration/tests/testcase.py

@@ -100,7 +100,7 @@ def _assert_snapshots(self, snapshot: Snapshot, expected_snapshot: Snapshot):
         for index, filter in enumerate(snapshot.filters):
             assert filter.key == expected_snapshot.filters[index].key
             assert filter.label == expected_snapshot.filters[index].label
-        assert snapshot.items_count == expected_snapshot.items_count
+        assert snapshot.item_count == expected_snapshot.item_count
         assert snapshot.name == expected_snapshot.name
         assert snapshot.retention_period == expected_snapshot.retention_period
         assert snapshot.size == expected_snapshot.size