[azure-sdk-automation]

Configurations: 'specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml', API Version: 2022-11-01-preview, SDK Release Type: beta, and CommitSHA: 'f241c974b872d010d875cbeb845131b7eb0fccce' in SpecRepo: 'https://github.com/Azure/azure-rest-api-specs' Pipeline run: https://dev.azure.com/azure-sdk/internal/_build/results?buildId=6619567 Refer to https://eng.ms/docs/products/azure-developer-experience/develop/sdk-release/sdk-release-prerequisites to prepare for SDK release. Release plan link: https://azsdk-releaseplan-dashboard-hveph5aqhhcfhtgu.westus-01.azurewebsites.net/?releaseplan=35101 Submitted by: gaoh@microsoft.com

[Copilot]

Copilot can't review bot-authored pull requests automatically. A user with Copilot access can request a review manually.

[Copilot]

Copilot can't review bot-authored pull requests automatically. A user with Copilot access can request a review manually.

[Copilot]

Pull request overview

Copilot reviewed 48 out of 48 changed files in this pull request and generated 3 comments.

Comments suppressed due to low confidence (6)

sdk/contosowidgetmanager/azure-contoso-widgetmanager/tsp-location.yaml:1

• additionalDirectories is not valid YAML as written: the list item is not indented under the key, and the key line has a trailing space. This will likely parse as additionalDirectories: null plus a separate top-level list entry, breaking tooling that reads this file. Indent the list under the key (and remove trailing whitespace) so the YAML structure is correct.
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/generated_tests/test_widget_manager_widgets_operations.py:1
• Importing testpreparer as a top-level module is fragile when running pytest from the repo/package root (it may not be on sys.path). Use a package-relative import (e.g., from .testpreparer import ...) to ensure tests import reliably in CI and local runs.
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/generated_tests/test_widget_manager_widgets_operations_async.py:1
• Same issue as the sync tests: these imports assume the current working directory/layout puts generated_tests on sys.path. Switch to relative imports (e.g., from .testpreparer import ..., from .testpreparer_async import ...) for predictable test execution.
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/generated_tests/conftest.py:1
• These sanitizers pass environment values directly as regex patterns. If any value contains regex metacharacters, sanitization can fail (or over-match unintended content). Escape the values before using them as regex patterns (e.g., via re.escape(...)) so recordings are consistently sanitized.
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/generated_samples/widgets_get_widget_operation_status_sample.py:1
• Correct the typo in the sample value: 'opreation' -> 'operation'. Also consider avoiding spaces in an ID example to reduce the chance of users copying an invalid value.
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/types.py:1
• The TypedDict docstring documents created_at, but the actual key is createdAt. Similar snake_case vs camelCase mismatches appear in WidgetSuite as well. This is misleading for users and type checkers—either update the docstrings to match the actual keys, or add documented aliases if the intent is to support snake_case keys in the TypedDict.

[Copilot]

Pull request overview

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

Comments suppressed due to low confidence (4)

sdk/contosowidgetmanager/azure-contoso-widgetmanager/tsp-location.yaml:1

• additionalDirectories is currently parsed as null, and the following - specification/... becomes a top-level list item (not under additionalDirectories) due to missing indentation. Indent the list under additionalDirectories (and remove the trailing space after the colon) so YAML structure is correct.
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/generated_tests/conftest.py:1
• add_general_regex_sanitizer treats regex= as a regular expression. Passing environment values directly (especially WIDGETMANAGER_CLIENT_SECRET, which may contain regex metacharacters) risks failed sanitization or unintended matching. Escape these values (e.g., with re.escape) before passing them as regex patterns, or switch to a sanitizer that matches exact values safely.
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/generated_samples/widgets_get_widget_operation_status_sample.py:1
• Correct spelling of 'opreation' to 'operation' in the sample input string to avoid confusing users.
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/types.py:1
• The TypedDict docstrings reference snake_case field names (e.g., created_at, manufacturer_id, shared_model), but the actual TypedDict keys are camelCase (createdAt, manufacturerId, sharedModel). Update the docstrings to match the real keys (or define snake_case aliases if that’s the intended public typing surface) to avoid misleading type/help output.

[Copilot]

Pull request overview

Copilot reviewed 48 out of 48 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (5)

sdk/contosowidgetmanager/azure-contoso-widgetmanager/tsp-location.yaml:1

• This YAML is malformed: the sequence item is not indented under additionalDirectories, so it becomes a top-level sequence entry and will break parsing. Indent the list items under the key (and drop the trailing space after the colon) so additionalDirectories is a proper list value.
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/generated_tests/conftest.py:1
• Environment variable values are being used directly as regex patterns. If any value contains regex metacharacters (or is an invalid regex), sanitization can over-match or raise at runtime, and secrets may not be sanitized correctly. Escape these values before passing them as regex= (e.g., via re.escape), or use a non-regex/string sanitizer API if available.
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/generated_samples/widgets_get_widget_operation_status_sample.py:1
• Typo in sample input string: 'opreation' should be 'operation' (samples are copy-pasted frequently and this can propagate confusion).
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/generated_tests/test_widget_manager_widgets_operations.py:1
• All generated operation tests are currently hard-skipped, which means they will never run in CI and provide no coverage for the newly introduced client/operations. Consider converting these to runnable recorded tests by adding minimal assertions and removing the skip, or (if they must remain non-runnable) moving them out of the test path so they don’t create the impression of coverage.
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/types.py:1
• The docstring describes created_at, but the TypedDict key is createdAt. This mismatch will confuse users reading docs/type hints. Update the docstring to match the actual TypedDict keys (or rename the key if snake_case is intended for the public typing surface).

[Copilot]

Pull request overview

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

Comments suppressed due to low confidence (5)

sdk/contosowidgetmanager/azure-contoso-widgetmanager/tsp-location.yaml:1

• This YAML is likely invalid/unintended: additionalDirectories has a trailing space and the list item is not indented under the key. Update it to standard YAML list indentation (e.g., additionalDirectories: followed by an indented - ...) so tooling can reliably parse this file.
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/generated_tests/conftest.py:1
• add_general_regex_sanitizer treats the input as a regex. Passing raw secret values can fail to sanitize (or over-match) if the secret contains regex metacharacters. Escape the environment value first (e.g., via re.escape(...)) before passing it as the regex argument.
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/generated_samples/widgets_get_widget_operation_status_sample.py:1
• Correct spelling of 'opreation' to 'operation' in the sample value so it reads as intended.
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/types.py:1
• The TypedDict docs describe created_at, but the actual key is createdAt. This mismatch will confuse users (and the generated api.md appears to reflect both forms). Update the docstring field names (and any related docs) to match the actual TypedDict keys (createdAt, manufacturerId, sharedModel, etc.).
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/types.py:1
• The TypedDict docs describe created_at, but the actual key is createdAt. This mismatch will confuse users (and the generated api.md appears to reflect both forms). Update the docstring field names (and any related docs) to match the actual TypedDict keys (createdAt, manufacturerId, sharedModel, etc.).

[Copilot]

Pull request overview

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

Comments suppressed due to low confidence (5)

sdk/contosowidgetmanager/azure-contoso-widgetmanager/tsp-location.yaml:1

• additionalDirectories is not valid YAML as written: the list item at line 5 is not indented under the key, so it becomes a separate top-level list entry. Indent the list (or use an inline list) so it's actually associated with additionalDirectories.
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/types.py:1
• The TypedDict docstring describes created_at, but the actual key is createdAt (and there is no created_at entry). This is misleading for users constructing request dictionaries. Update the docstring (and any other affected doc references) to consistently describe the actual keys accepted by this TypedDict, or add the intended snake_case keys if the SDK supports them.
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/generated_tests/conftest.py:1
• These sanitizers treat environment variable values as regular expressions. Values like client secrets may contain regex metacharacters, leading to overbroad matching or invalid regex patterns. Escape the values (e.g., via re.escape(...)) before passing them as regex=.
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/generated_tests/test_widget_manager_widgets_operations.py:1
• All generated tests in this class are unconditionally skipped, which effectively removes test coverage for the newly added client/operations. If these tests are expected to run in CI, replace the unconditional skip with real assertions and recordings setup (or use a more targeted skip/xfail only for tests that truly can't run yet).
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/generated_samples/widgets_get_widget_operation_status_sample.py:1
• Typo in sample string literal: 'opreation' should be 'operation' to avoid confusing users copying the example.

[Copilot]

Pull request overview

Copilot reviewed 48 out of 48 changed files in this pull request and generated 4 comments.

Comments suppressed due to low confidence (4)

sdk/contosowidgetmanager/azure-contoso-widgetmanager/tsp-location.yaml:1

• additionalDirectories is declared as a mapping key but the list item is not indented beneath it, which makes this invalid / unintended YAML structure (the - becomes a top-level sequence entry). Indent the list under additionalDirectories (and remove the trailing space after the colon) so tooling can parse it correctly.
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/generated_tests/conftest.py:1
• add_general_regex_sanitizer treats regex= as a regular expression. Secrets (especially client_secret) may contain regex metacharacters, which can cause sanitizer failures or unintended over-matching. Escape these values (e.g., via re.escape(...)) before passing them as regex patterns.
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/types.py:1
• The WidgetSuite TypedDict marks name as Required[str], but the generated model WidgetSuite treats name as read-only (visibility=[\"read\"]) and the samples omit it in request bodies. This mismatch makes the public typing surface misleading for request payloads. Update the TypedDict to reflect the actual request shape (e.g., make name not-required / omit it if it's response-only) and align docstrings with the wire keys (manufacturerId, sharedModel, createdAt) to avoid confusion.
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/generated_samples/widgets_get_widget_operation_status_sample.py:1
• Typo in the sample parameter value makes the example look incorrect. Consider changing opreation id1 to operation id1.

[Copilot]

Pull request overview

Copilot reviewed 48 out of 48 changed files in this pull request and generated 3 comments.

Comments suppressed due to low confidence (9)

sdk/contosowidgetmanager/azure-contoso-widgetmanager/generated_tests/conftest.py:1

• python-dotenv is imported/used here, but it is not listed in this package’s dev/test requirements in the diff. This will cause test collection to fail in environments that don’t already have it installed. Add python-dotenv to the appropriate requirements file for tests (or remove the dependency and rely on environment variables only).
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/generated_tests/conftest.py:1
• python-dotenv is imported/used here, but it is not listed in this package’s dev/test requirements in the diff. This will cause test collection to fail in environments that don’t already have it installed. Add python-dotenv to the appropriate requirements file for tests (or remove the dependency and rely on environment variables only).
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/generated_tests/conftest.py:1
• These sanitizers pass environment-provided values directly as regex patterns. If a secret contains regex metacharacters (e.g., +, *, ?, [], \\), sanitization can break (invalid regex) or match too broadly. Escape the values (e.g., via re.escape) before passing them as the regex= argument.
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/generated_samples/widgets_get_widget_operation_status_sample.py:1
• Correct typo in sample value: opreation → operation.
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/types.py:1
• The TypedDict key names are camelCase (createdAt, manufacturerId, sharedModel), but the docstrings describe snake_case fields (created_at, manufacturer_id, shared_model). This is user-facing typing/API documentation and is currently inconsistent, which can cause incorrect dict construction by consumers. Align the docstrings with the actual keys, or (if the intent is to accept snake_case) add a conversion layer so snake_case inputs are supported.
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/types.py:1
• The TypedDict key names are camelCase (createdAt, manufacturerId, sharedModel), but the docstrings describe snake_case fields (created_at, manufacturer_id, shared_model). This is user-facing typing/API documentation and is currently inconsistent, which can cause incorrect dict construction by consumers. Align the docstrings with the actual keys, or (if the intent is to accept snake_case) add a conversion layer so snake_case inputs are supported.
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/types.py:1
• The TypedDict key names are camelCase (createdAt, manufacturerId, sharedModel), but the docstrings describe snake_case fields (created_at, manufacturer_id, shared_model). This is user-facing typing/API documentation and is currently inconsistent, which can cause incorrect dict construction by consumers. Align the docstrings with the actual keys, or (if the intent is to accept snake_case) add a conversion layer so snake_case inputs are supported.
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/types.py:1
• The TypedDict key names are camelCase (createdAt, manufacturerId, sharedModel), but the docstrings describe snake_case fields (created_at, manufacturer_id, shared_model). This is user-facing typing/API documentation and is currently inconsistent, which can cause incorrect dict construction by consumers. Align the docstrings with the actual keys, or (if the intent is to accept snake_case) add a conversion layer so snake_case inputs are supported.
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/types.py:1
• The TypedDict key names are camelCase (createdAt, manufacturerId, sharedModel), but the docstrings describe snake_case fields (created_at, manufacturer_id, shared_model). This is user-facing typing/API documentation and is currently inconsistent, which can cause incorrect dict construction by consumers. Align the docstrings with the actual keys, or (if the intent is to accept snake_case) add a conversion layer so snake_case inputs are supported.

[Copilot]

Pull request overview

Copilot reviewed 48 out of 48 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (10)

sdk/contosowidgetmanager/azure-contoso-widgetmanager/tsp-location.yaml:1

• additionalDirectories is not valid YAML as written: the list item at line 5 is not indented under the key, and the trailing space after the colon suggests this key is being set to null. Indent the list under additionalDirectories: (and remove the trailing space) so the file parses correctly.
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/generated_samples/widgets_get_widget_operation_status_sample.py:1
• Fix the typo in the sample parameter value to avoid confusion when users copy/paste.
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/generated_tests/conftest.py:1
• The tests import python-dotenv unconditionally, but the package's dev_requirements.txt doesn't list it. Either add python-dotenv to the appropriate test/dev requirements, or make the import optional (catch ImportError) so running tests in minimal environments doesn't fail at import time.
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/generated_tests/conftest.py:1
• The tests import python-dotenv unconditionally, but the package's dev_requirements.txt doesn't list it. Either add python-dotenv to the appropriate test/dev requirements, or make the import optional (catch ImportError) so running tests in minimal environments doesn't fail at import time.
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/generated_tests/conftest.py:1
• Passing environment values directly as regex patterns can break recordings if the value is empty (an empty regex matches everywhere) or if it contains regex metacharacters. Consider escaping these values (treat as literals) and/or skipping sanitizer registration when the value is empty or already equals the placeholder.
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/types.py:1
• The TypedDict docs use snake_case names (created_at, manufacturer_id) but the actual TypedDict keys are camelCase (createdAt, manufacturerId). Update the docstrings/field docs to reference the actual accepted keys to avoid misleading users and to match the generated samples.
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/types.py:1
• The TypedDict docs use snake_case names (created_at, manufacturer_id) but the actual TypedDict keys are camelCase (createdAt, manufacturerId). Update the docstrings/field docs to reference the actual accepted keys to avoid misleading users and to match the generated samples.
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/types.py:1
• The TypedDict docs use snake_case names (created_at, manufacturer_id) but the actual TypedDict keys are camelCase (createdAt, manufacturerId). Update the docstrings/field docs to reference the actual accepted keys to avoid misleading users and to match the generated samples.
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/types.py:1
• The TypedDict docs use snake_case names (created_at, manufacturer_id) but the actual TypedDict keys are camelCase (createdAt, manufacturerId). Update the docstrings/field docs to reference the actual accepted keys to avoid misleading users and to match the generated samples.
  sdk/contosowidgetmanager/azure-contoso-widgetmanager/generated_tests/test_widget_manager_widgets_operations.py:1
• All generated tests are currently skipped, which means the newly added client/operations won't have any CI coverage from these tests. If these are intended to be part of the test suite, replace the unconditional skip with runnable tests (even minimal assertions) or gate them behind an opt-in marker so they can run in CI when configured.

[github-actions]

[Pilot] PR Pipeline Failure Analysis

A CI pipeline failed on this pull request. Here is an automated analysis of what went wrong and how to get the build green.

What failed

The pipeline (build 6619623) for azure-contoso-widgetmanager failed with 4 validation errors across 3 checks:

Check	Status	Details
Spell check	❌ FAIL	deser flagged as unknown word (5 occurrences in model_base.py); typo opreation in sample file
README verification	❌ FAIL	README.md is missing required sections: Key concepts, Troubleshooting, Next steps
MyPy	❌ FAIL	generated_samples/widgets_create_or_update_widget_sample.py:33 — wrong argument type passed to begin_create_or_update_widget (got dict, expected WidgetSuite or IO[bytes])
Pyright	❌ FAIL	Same sample file/line — reportCallIssue and reportArgumentType errors for begin_create_or_update_widget

All four are validation failures requiring code fixes — no infrastructure issues detected.

Recommended next steps

• Fix the typo in the sample: Rename opreation → operation in generated_samples/widgets_get_widget_operation_status_sample.py:35.
• Fix the spell-check false positive: Add deser to the repository spell-check allowlist (see spellcheck guide) or rename the variable in _utils/model_base.py to a dictionary word.
• Fix the sample argument: In generated_samples/widgets_create_or_update_widget_sample.py:33, pass a proper WidgetSuite model instance (not a raw dict) to begin_create_or_update_widget. Example: WidgetSuite(...) using the correct fields.
• Add missing README sections: Add ## Key concepts, ## Troubleshooting, and ## Next steps sections to sdk/contosowidgetmanager/azure-contoso-widgetmanager/README.md (see aka.ms/azure-sdk-analyze-failed).
• See the CI troubleshooting guide: https://aka.ms/ci-fix
• Push new commits to address the failures; this comment updates automatically on the next failing run.

Raw pipeline analysis (azsdk ci analyze)

Analyzing pipeline https://github.com/Azure/azure-sdk-for-python/pull/47994...
--------------------------------------------------------------------------------
Failed Tasks
--------------------------------------------------------------------------------
### Errors:
[CSpell]
##[error]sdk/.../azure/contoso/widgetmanager/_utils/model_base.py:634:10 - Unknown word (deser)
##[error]sdk/.../azure/contoso/widgetmanager/_utils/model_base.py:640:10 - Unknown word (deser)
##[error]sdk/.../azure/contoso/widgetmanager/_utils/model_base.py:646:10 - Unknown word (deser)
##[error]sdk/.../azure/contoso/widgetmanager/_utils/model_base.py:652:10 - Unknown word (deser)
##[error]sdk/.../azure/contoso/widgetmanager/_utils/model_base.py:665:10 - Unknown word (deser)
##[error]sdk/.../generated_samples/widgets_get_widget_operation_status_sample.py:35:23 - Unknown word (opreation) fix: (operation)
##[error]Spelling errors detected. See: https://aka.ms/azsdk/engsys/spellcheck

[README verification]
1 readme has at least one missing required section.
/sdk/contosowidgetmanager/azure-contoso-widgetmanager/README.md is missing headers with patterns:
 * ^Key concepts$
 * ^Troubleshooting$
 * ^Next steps$
##[error]There were README verification failures

[MyPy]
generated_samples/widgets_create_or_update_widget_sample.py:33: error: No overload variant of
"begin_create_or_update_widget" of "WidgetsOperations" matches argument types "str", "dict[str, Collection[str]]"  [call-overload]
mypy check completed with exit code 1
PACKAGE: azure-contoso-widgetmanager  mypy  FAIL(1)  13.72s

[Pyright]
generated_samples/widgets_create_or_update_widget_sample.py:33:16 - error: No overloads for
"begin_create_or_update_widget" match the provided arguments (reportCallIssue)
generated_samples/widgets_create_or_update_widget_sample.py:35:18 - error: Argument of type
"dict[str, str | dict[str, str]]" cannot be assigned to parameter "resource" of type "IO[bytes]" (reportArgumentType)
2 errors — pyright check completed with exit code 1
PACKAGE: azure-contoso-widgetmanager  pyright  FAIL(1)  8.31s

### Pipeline: https://dev.azure.com/azure-sdk/public/_build/results?buildId=6619623

@copilot Copilot detected the failing pipeline and generated the analysis above. To have it attempt a fix automatically, reply with `@copilot please fix the failing pipeline on this PR`.

Generated by Pipeline Analysis - Next Steps · 36.3 AIC · ⌖ 6.45 AIC · ⊞ 6.6K · ◷

[azure-pipelines]

Azure Pipelines:
Successfully started running 1 pipeline(s).
9 pipeline(s) were filtered out due to trigger conditions.
There may be pipelines that require an authorized user to comment /azp run to run.