Skip to content

Commit 5cf7442

Browse files
committed
update design doc
1 parent f32e2a7 commit 5cf7442

File tree

1 file changed

+11
-23
lines changed

1 file changed

+11
-23
lines changed

design-docs/CLI-Subscriptions.md

Lines changed: 11 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ planet subscriptions request [OPTIONS]
184184
185185
Generate a subscriptions request.
186186
187-
This command provides support for building the subscription request JSON used to create or
187+
This command provides support for building the subscription request JSON used to create or
188188
update a subscription. It outputs the subscription request.
189189
190190
Options:
@@ -222,13 +222,13 @@ Generate a subscriptions request source JSON for a catalog.
222222
Options:
223223
--asset-types TEXT One or more comma-separated asset types. Required.
224224
--item-types TEXT One or more comma-separated item-types. Required.
225-
--geom JSON geometry of the area of interest of the subscription that will be used to determine matches.
225+
--geometry JSON geometry of the area of interest of the subscription that will be used to determine matches.
226226
Can be a json string, filename, or '-' for stdin.
227227
--start-time DATETIME Start date and time to begin subscription.
228228
--end-time DATETIME Date and time to end the subscription.
229-
--rrule TEXT iCalendar recurrance rule to specify recurrances.
230-
--filter JSON A search filter can be specified a json string,
231-
filename, or '-' for stdin.
229+
--rrule TEXT iCalendar recurrance rule to specify recurrances.
230+
--filter JSON A search filter can be specified a json string,
231+
filename, or '-' for stdin.
232232
--pretty Format JSON output.
233233
--help Show this message and exit.
234234
```
@@ -237,11 +237,11 @@ Options:
237237

238238
```
239239
planet subscriptions request \
240-
--source $(planet subscriptions request-catalog
241-
--item-type PSScene
242-
--asset-types ortho_analytic_8b_sr,ortho_udm2
243-
--geom aoi.json
244-
--start-time 05/01/2022)
240+
--source $(planet subscriptions request-catalog \
241+
--item-types PSScene \
242+
--asset-types ortho_analytic_8b_sr,ortho_udm2 \
243+
--geometry aoi.geojson \
244+
--start-time 2022-01-01) \
245245
--delivery delivery.json | planet subscriptions create -
246246
```
247247

@@ -257,7 +257,7 @@ Generate a subscriptions request source JSON for another product.
257257
Options:
258258
--type Type.
259259
--id Id.
260-
--geom JSON geometry of the area of interest of the subscription that will be used to determine matches.
260+
--geom JSON geometry of the area of interest of the subscription that will be used to determine matches.
261261
Can be a json string, filename, or '-' for stdin.
262262
--start-time DATETIME Start date and time to begin subscription.
263263
--end-time DATETIME Date and time to end the subscription.
@@ -266,18 +266,6 @@ Options:
266266
--help Show this message and exit.
267267
```
268268

269-
### Usage Examples
270-
271-
```
272-
planet subscriptions request \
273-
--source $(planet subscriptions request-other
274-
--type othertype
275-
--id otherid
276-
--geom aoi.json
277-
--start-time 05/01/2022)
278-
--delivery delivery.json | planet subscriptions create -
279-
```
280-
281269

282270
## Update
283271

0 commit comments

Comments
 (0)