Skip to content

[Python] TypeSpec migration for azure-mgmt-policyinsights#45935

Draft
ChenxiJiang333 wants to merge 3 commits intoAzure:mainfrom
ChenxiJiang333:sdk-azure-mgmt-policyinsights
Draft

[Python] TypeSpec migration for azure-mgmt-policyinsights#45935
ChenxiJiang333 wants to merge 3 commits intoAzure:mainfrom
ChenxiJiang333:sdk-azure-mgmt-policyinsights

Conversation

@ChenxiJiang333
Copy link
Member

[Python] TypeSpec migration for azure-mgmt-policyinsights

SDK output comparison for the TypeSpec migration of azure-mgmt-policyinsights (PR Azure/azure-rest-api-specs#41735).

Pre-migration Swagger Source

specification/policyinsights/resource-manager @ a41799da

Breaking Change Analysis

Classification Count Description
MITIGATE 3 Client rename, property renames
ACCEPT ~100 Parameter kind changes, model removals, subscription_id promotion, QueryOptions inlining

Mitigated Breaking Changes (spec PR)

Spec mitigation PR: cxznmhdcxz/azure-rest-api-specs#4

Breaking Change Mitigation
Client PolicyInsightsClientPolicyInsightsManagementClient @@clientName decorator
FieldRestriction.values renamed to values_property @@clientName decorator
PendingField.values renamed to values_property @@clientName decorator

Accepted Breaking Changes (will remain)

Per the SDK Breaking Changes Guide:

  • Deleted auto-generated error models: ErrorDefinitionAutoGenerated, ErrorDefinitionAutoGenerated2, ErrorResponseAutoGenerated, ErrorResponseAutoGenerated2
  • Deleted pageable wrapper models: PolicyEventsQueryResults, PolicyStatesQueryResults, PolicyTrackedResourcesQueryResults, PolicyMetadataCollection
  • Deleted wrapper model: QueryOptions (parameters inlined into methods)
  • Parameter removals: query_options removed from ~30 methods (replaced by inline top, filter, order_by, etc.)
  • Parameter removals: subscription_id removed from ~20 methods (promoted to client-level)
  • Parameter kind changes: ~25 parameters changed from positional_or_keyword to keyword_only
  • Parameter re-orderings: ~5 methods due to QueryOptions removal

Commits

  1. generated from swagger:a41799da — SDK from pre-migration swagger spec
  2. generated from typespec:2591fd84 — SDK from PR TypeSpec spec
  3. changelog from report comparison — Breaking change changelog

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant