Skip to content

[Python] TypeSpec migration for azure-mgmt-education - #46547

Closed
ChenxiJiang333 wants to merge 5 commits into
Azure:mainfrom
ChenxiJiang333:sdk-azure-mgmt-education
Closed

ChenxiJiang333 wants to merge 5 commits into
Azure:mainfrom
ChenxiJiang333:sdk-azure-mgmt-education

Conversation

@ChenxiJiang333

Copy link
Copy Markdown
Member

[Python] TypeSpec migration for azure-mgmt-education

Spec Source

Spec PR: Azure/azure-rest-api-specs#42509

Pre-migration swagger source: specification/education/resource-manager/Microsoft.Education/Education@147784da

Swagger API version: 2021-12-01-preview (default tag: package-2021-12-01-preview)

Generated with apiVersion: 2021-12-01-preview (matched from swagger default tag)

Breaking Change Analysis

Classification Summary

# Breaking Change Category Action
1 Deleted or renamed client EducationManagementClient Client naming (Cat 4) MITIGATE
2 Model properties moved to .properties (5 models: GrantDetails, JoinRequestDetails, LabDetails, StudentDetails, StudentLabDetails) Multi-level flattening (Cat 11) ACCEPT
3 Deleted model GrantListResponse Pageable model (Cat 8) ACCEPT
4 Deleted model JoinRequestList Pageable model (Cat 8) ACCEPT
5 10 methods changed parameters to keyword-only Keyword-only params (Cat 9) ACCEPT

Mitigation Details

Client Name — Added client.tsp:

@@clientName(Microsoft.Education, "EducationManagementClient", "python");

Spec mitigation PR: mcgallan/azure-rest-api-specs#6

Accepted Breaking Changes (will remain)

  1. Multi-level flattening removal — Properties on GrantDetails, JoinRequestDetails, LabDetails, StudentDetails, StudentLabDetails are now accessed via .properties sub-object. Note: The PR's back-compatible.tsp already includes @@Legacy.flattenProperty decorators which should restore flattened access in the SDK.
  2. Pageable model removal — GrantListResponse, JoinRequestList removed (standard for Python SDK list APIs)
  3. Parameters to keyword-only — Standard TypeSpec migration pattern:
    • GrantsOperations.get/list/list_all: include_allocated_budget
    • JoinRequestsOperations.list: include_denied
    • LabsOperations.generate_invite_code: only_update_student_count_parameter
    • LabsOperations.get/list/list_all: include_budget
    • LabsOperations.list_all: include_deleted
    • StudentsOperations.list: include_deleted

@github-actions

Copy link
Copy Markdown
Contributor

Hi ChenxiJiang333. Thank you for your interest in helping to improve the Azure SDK experience and for your contribution. We've noticed that there hasn't been recent engagement on this pull request. If this is still an active work stream, please let us know by pushing some changes or leaving a comment. Otherwise, we'll close this out in 7 days.

@github-actions github-actions Bot added the no-recent-activity There has been no recent activity on this issue. label Jun 26, 2026
@github-actions

github-actions Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

Hi ChenxiJiang333. Thank you for your contribution. Since there hasn't been recent engagement, we're going to close this out. Feel free to respond with a comment containing /reopen if you'd like to continue working on these changes. Please be sure to use the command to reopen or remove the no-recent-activity label; otherwise, this is likely to be closed again with the next cleanup pass.

@github-actions github-actions Bot closed this Jul 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-recent-activity There has been no recent activity on this issue.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant