App Configuration - Description API#47332
Open
mrm9084 wants to merge 3 commits into
Open
Conversation
github-actions
Bot
added
the
App Configuration
Contributor
There was a problem hiding this comment.
Pull request overview
Adds support for the App Configuration 2026-04-01 API surface that introduces description on key-values and snapshots, and updates tests to validate round-tripping and reduce snapshot-list flakiness.
Changes:
- Introduces
descriptiononConfigurationSetting,SecretReferenceConfigurationSetting, andConfigurationSnapshot, and wiresdescriptioninto snapshot creation. - Regenerates the generated client/models for API version
2026-04-01and updates metadata/assets/apiview properties accordingly. - Updates tests to validate
descriptionbehavior and makes snapshot listing tests less flaky by asserting presence vs absolute counts.
Reviewed changes
Copilot reviewed 22 out of 22 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| sdk/appconfiguration/azure-appconfiguration/tsp-location.yaml | Updates the swagger/spec commit reference used for generation. |
| sdk/appconfiguration/azure-appconfiguration/tests/testcase.py | Extends test assertions to include description for settings and snapshots. |
| sdk/appconfiguration/azure-appconfiguration/tests/test_consistency.py | Adds unit tests covering default/round-trip behavior of description and FF/SR edge behavior. |
| sdk/appconfiguration/azure-appconfiguration/tests/test_azure_appconfiguration_client.py | Reduces flakiness by asserting created snapshots appear in results rather than asserting absolute counts. |
| sdk/appconfiguration/azure-appconfiguration/tests/test_azure_appconfiguration_client_async.py | Async equivalent of snapshot listing flakiness fix. |
| sdk/appconfiguration/azure-appconfiguration/pyproject.toml | Updates package classifiers (currently marking package as Beta). |
| sdk/appconfiguration/azure-appconfiguration/CHANGELOG.md | Documents new description support on settings and snapshots. |
| sdk/appconfiguration/azure-appconfiguration/azure/appconfiguration/aio/_azure_appconfiguration_client_async.py | Adds description argument to async begin_create_snapshot; adds pylint disable header. |
| sdk/appconfiguration/azure-appconfiguration/azure/appconfiguration/_models.py | Adds description to public models and maps to/from generated models. |
| sdk/appconfiguration/azure-appconfiguration/azure/appconfiguration/_generated/models/_patch.py | Updates patched generated model typing/docs to include description on KeyValue. |
| sdk/appconfiguration/azure-appconfiguration/azure/appconfiguration/_generated/models/_models.py | Updates generated models/envelopes to include description on KeyValue and Snapshot. |
| sdk/appconfiguration/azure-appconfiguration/azure/appconfiguration/_generated/models/_enums.py | Adds DESCRIPTION field selectors for settings and snapshots. |
| sdk/appconfiguration/azure-appconfiguration/azure/appconfiguration/_generated/aio/_operations/_operations.py | Extends supported API versions list to include 2026-04-01 for relevant ops. |
| sdk/appconfiguration/azure-appconfiguration/azure/appconfiguration/_generated/aio/_configuration.py | Updates generated async config default API version/documentation to 2026-04-01. |
| sdk/appconfiguration/azure-appconfiguration/azure/appconfiguration/_generated/aio/_client.py | Updates generated async client documentation to reference 2026-04-01. |
| sdk/appconfiguration/azure-appconfiguration/azure/appconfiguration/_generated/_operations/_operations.py | Updates default api-version used by request builders to 2026-04-01 and extends supported versions list. |
| sdk/appconfiguration/azure-appconfiguration/azure/appconfiguration/_generated/_configuration.py | Updates generated config default API version/documentation to 2026-04-01. |
| sdk/appconfiguration/azure-appconfiguration/azure/appconfiguration/_generated/_client.py | Updates generated client documentation to reference 2026-04-01. |
| sdk/appconfiguration/azure-appconfiguration/azure/appconfiguration/_azure_appconfiguration_client.py | Adds description argument to sync begin_create_snapshot; adds pylint disable header. |
| sdk/appconfiguration/azure-appconfiguration/assets.json | Updates the recorded assets tag. |
| sdk/appconfiguration/azure-appconfiguration/apiview-properties.json | Updates CrossLanguageVersion. |
| sdk/appconfiguration/azure-appconfiguration/_metadata.json | Updates tracked API version metadata to 2026-04-01. |
| - Added `check_configuration_settings()` method to efficiently check for configuration changes using HEAD requests, returning only headers (ETags) without response bodies. | ||
| - `list_configuration_settings()` and `check_configuration_settings()` now return `ConfigurationSettingPaged` (sync) / `ConfigurationSettingPagedAsync` (async) to expose the `by_page(match_conditions=...)` API and per-page `etag` attribute for change detection. | ||
| - `ConfigurationSettingPaged` and `ConfigurationSettingPagedAsync` are now publicly exported from `azure.appconfiguration`. | ||
| - Added a `description` property to `ConfigurationSetting` and `SecretReferenceConfigurationSetting` representing the description of the key-value (requires API version `2026-04-01` or later). |
Member
There was a problem hiding this comment.
Does python SDK have default SDK version like .NET?
Member
Author
There was a problem hiding this comment.
All of them do, it's a kwarg that you can pass in and defaults to the latest one if not provided.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
All SDK Contribution checklist:
General Guidelines and Best Practices
Testing Guidelines