Skip to content

Conversation

@snehaa-ni
Copy link
Contributor

What does this Pull Request accomplish?

Deprecates the TestPlanClient because the underlying Test Plans APIs are deprecated, guiding users to migrate to WorkItemClient before the APIs are removed in the future.

Why should this Pull Request be merged?

  • Warns users at runtime with a DeprecationWarning when TestPlanClient is instantiated.
  • Adds a Sphinx deprecation notice in the documentation for visibility in generated docs.

What testing has been done?

  • Verified DeprecationWarning is raised when TestPlanClient is instantiated in integration tests.
  • Confirmed Sphinx documentation shows deprecation notice as below.
image

@snehaa-ni snehaa-ni changed the title feat: Deprecate Test Plans Client feat: Deprecate Test Plans Client as Test Plans APIs are deprecated Jan 19, 2026
@snehaa-ni snehaa-ni changed the title feat: Deprecate Test Plans Client as Test Plans APIs are deprecated feat: Deprecate TestPlanClient as Test Plans APIs are deprecated Jan 19, 2026
@snehaa-ni snehaa-ni marked this pull request as ready for review January 20, 2026 06:26
@snehaa-ni snehaa-ni changed the title feat: Deprecate TestPlanClient as Test Plans APIs are deprecated fix: Deprecate TestPlanClient as Test Plans APIs are deprecated Jan 20, 2026
@snehaa-ni snehaa-ni merged commit c3092a6 into master Jan 21, 2026
53 of 68 checks passed
@snehaa-ni snehaa-ni deleted the users/snehaa/deprecate-test-plans-client branch January 21, 2026 04:25
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.

4 participants