Skip to content

Commit 4fa0002

Browse files
Add 'Additional Breaking Changes' section to v3.0 migration guide (#1173)
* add additional breaking changes section to v3 migration guide * add breaking change note for request_source() and subscription_source() methods
1 parent 1adae09 commit 4fa0002

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/get-started/upgrading-v3.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,4 +92,9 @@ Users developing new applications should consult the [Client Authentication Guid
9292
for a complete discussion of all OAuth2 based mechanisms. OAuth2 mechanisms
9393
should be preferred to the use of Planet API keys.
9494

95+
## Additional Breaking Changes
96+
97+
* 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.
98+
* 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.
99+
95100
----

0 commit comments

Comments
 (0)