-
Notifications
You must be signed in to change notification settings - Fork 92
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.
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
Add a planetary_variable_source subscription helper #976
Conversation
@cpaulik @guyon-planet while I work on #933, would you be willing to see if this is what you're looking for in a PV source helper? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few small suggestions and 1 must-fix typo in the example code. Otherwise, looks good to me!
Co-authored-by: Kevin Lacaille <[email protected]>
@@ -212,6 +219,86 @@ def catalog_source( | |||
return {"type": "catalog", "parameters": parameters} | |||
|
|||
|
|||
def planetary_variable_source( | |||
var_type: Literal["biomass_proxy", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just wanted to point out that internally we are already using more sources for upcoming forest products.
I'm not sure if there is a way to not duplicate these lists.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@cpaulik I'm going off what we have at https://developers.planet.com/docs/subscriptions/pvs-subs/#planetary-variables-types-and-ids. Do you know if we publish a machine-readable version of this table for customers?
I'm using the Literal type hints here so that developers get value hints from their IDEs. The SDK does not at this time validate the values at runtime. Thus you can use any values you want, including unavailable PV types and ids. See for example https://github.com/planetlabs/planet-client-python/pull/982/files#diff-661d60b3722e519e66594c89a655b8aa191b919ac27c98ecffde58f984ab120eR355.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You sparked my curiosity. Since our API docs spell them out I did some digging and found that https://api.planet.com/subscriptions/v1/spec includes the sources types under schemas.PVSourceTypes
Quickly tested it, looks great, thanks! |
Resolves #966. API doc improvements for
catalog_source()
are included in this PR.