Skip to content

Add 'Additional Breaking Changes' section to v3.0 migration guide #1173

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 28, 2025
Merged

Add 'Additional Breaking Changes' section to v3.0 migration guide #1173

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a1a178b
add additional breaking changes section to v3 migration guide
asonnenschein Jul 24, 2025
d6096d9
add breaking change note for request_source() and subscription_source…
asonnenschein Jul 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/get-started/upgrading-v3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,4 +92,9 @@ Users developing new applications should consult the [Client Authentication Guid
for a complete discussion of all OAuth2 based mechanisms. OAuth2 mechanisms
should be preferred to the use of Planet API keys.

## Additional Breaking Changes

* Deprecated `planet.subscription_request.clip_tool()` method for defining custom clip AOIs with requests to create subscriptions. Subscriptions API no longer supports custom clip AOIs; instead users can opt-in to clip to their subscription source geometry by including kwarg `clip_to_source=True` when constructing requests via `planet.subscription_request.build_request()`. See [PR #1169](https://github.com/planetlabs/planet-client-python/pull/1169) for implementation details.
* Renamed `planet.cli.subscriptions.request_pv()` to `planet.cli.subscriptions.request_source()`, and removed `var_type` positional argument from the signature. This change, in effect renames the CLI argument `planet subscriptions request-pv` to `planet subscriptions request-source`. Also renamed `planet.subscription_request.planetary_variable_source()` to `planet.subscription_request.subscription_source()`. Source type positional arguments are removed from these methods in favor of `source_id`. See [PR #1170](https://github.com/planetlabs/planet-client-python/pull/1170) for implementation details.

----