Skip to content

DOC: add Example sections to snapshot and list_labels methods in Azur…#47963

Open
shoumikchakravarty-dev wants to merge 2 commits into
Azure:mainfrom
shoumikchakravarty-dev:DOC/add-examples-appconfiguration-snapshot-methods
Open

DOC: add Example sections to snapshot and list_labels methods in Azur…#47963
shoumikchakravarty-dev wants to merge 2 commits into
Azure:mainfrom
shoumikchakravarty-dev:DOC/add-examples-appconfiguration-snapshot-methods

Conversation

@shoumikchakravarty-dev

@shoumikchakravarty-dev shoumikchakravarty-dev commented Jul 9, 2026

Copy link
Copy Markdown

Description

Adds Example sections to six public methods in AzureAppConfigurationClient (sync and async) that were missing them. These methods were introduced as part of the configuration snapshot feature but did not receive example code in their docstrings at the time.

Methods updated (both _azure_appconfiguration_client.py and _azure_appconfiguration_client_async.py):

  • list_labels
  • begin_create_snapshot
  • archive_snapshot
  • recover_snapshot
  • get_snapshot
  • list_snapshots

The examples follow the same style and format used by the other methods in the client (e.g. get_configuration_setting, add_configuration_setting) and are consistent with the usage shown in the existing snapshot_sample.py and snapshot_sample_async.py sample files. No logic or behaviour is changed — this is a documentation-only PR.

All SDK Contribution checklist:

  • The pull request does not introduce [breaking changes]
  • CHANGELOG is updated for new features, bug fixes or other significant changes
  • I have read the contribution guidelines

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message.

Testing Guidelines

  • Pull request includes test coverage for the included changes ((Documentation-only change — no new test coverage required)

Copilot AI review requested due to automatic review settings July 9, 2026 03:19
@github-actions github-actions Bot added App Configuration Azure.ApplicationModel.Configuration Community Contribution Community members are working on the issue customer-reported Issues that are reported by GitHub users external to the Azure organization. labels Jul 9, 2026
@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Thank you for your contribution @shoumikchakravarty-dev! We will review the pull request and get back to you soon.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This is a documentation-only PR that adds Example sections to six public methods of AzureAppConfigurationClient (both sync and async) that were introduced with the configuration snapshot feature but lacked example code in their docstrings. The examples follow the existing docstring style and mirror the usage in the repository's snapshot sample files, improving generated reference docs without changing any behavior.

Changes:

  • Added Example docstring blocks for list_labels, begin_create_snapshot, archive_snapshot, recover_snapshot, get_snapshot, and list_snapshots in the sync client.
  • Added the equivalent async examples (using async for and await) in the async client.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
sdk/appconfiguration/azure-appconfiguration/azure/appconfiguration/_azure_appconfiguration_client.py Adds Example docstring blocks to six sync methods, matching existing convention and sample usage.
sdk/appconfiguration/azure-appconfiguration/azure/appconfiguration/aio/_azure_appconfiguration_client_async.py Adds Example docstring blocks to the six corresponding async methods with correct async for/await usage.

@shoumikchakravarty-dev

Copy link
Copy Markdown
Author

@avanigupta @jimmyca15 @mrm9084 -I'm new to the Azure SDK community and keen to contribute. Please review my changes for any feedback.

@shoumikchakravarty-dev

Copy link
Copy Markdown
Author

@microsoft-github-policy-service agree

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

App Configuration Azure.ApplicationModel.Configuration Community Contribution Community members are working on the issue customer-reported Issues that are reported by GitHub users external to the Azure organization.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants