Skip to content

Commit 464ddd4

Browse files
committed
changes as per review comments
1 parent 269f01b commit 464ddd4

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

source/includes/_aviate-catalog.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -300,10 +300,12 @@ If successful, returns a status code of 200 and a `PlanData` list.
300300

301301
### Delete Product
302302

303-
Deletes the specified product. If `deleteAllPlans` is specified, deletes all the plans corresponding to the product.
303+
Deletes the specified product. If `deleteAllPlans` is specified, hard deletes all the plans corresponding to the product.
304304

305305
**Note:** Since this is an irreversible operation, the query parameter `force=true` must be specified to proceed with the deletion.
306306

307+
**Note:** Deleting a plan hard deletes it from the database and hence should be done with caution.
308+
307309
**HTTP Request**
308310

309311
`DELETE /plugins/aviate-plugin/v1/catalog/product/{productName}/deleteProduct`
@@ -1068,6 +1070,8 @@ Deletes the latest version of the plan. If `allVersions=true` is specified, dele
10681070

10691071
**Note:** Since this is an irreversible operation, the query parameter `force=true` must be specified to proceed with the deletion.
10701072

1073+
**Note:** Retiring a plan simply marks it as "retired" in the database and prevents creating new subscriptions corresponding to the plan. On the other hand, deleting a plan hard deletes it from the database and hence should be done with caution.
1074+
10711075
**HTTP Request**
10721076

10731077
`DELETE /plugins/aviate-plugin/v1/catalog/{planName}/deletePlan`

0 commit comments

Comments
 (0)