From 327e6829500e58d782adb733e38e53a525365fac Mon Sep 17 00:00:00 2001
From: jmaeng72 <44305062+jmaeng72@users.noreply.github.com>
Date: Wed, 20 Nov 2024 13:59:05 -0500
Subject: [PATCH] update search api
---
search-app/docs/api.md | 14 ++++++++++----
1 file changed, 10 insertions(+), 4 deletions(-)
diff --git a/search-app/docs/api.md b/search-app/docs/api.md
index a8b067b706..57f094a29d 100644
--- a/search-app/docs/api.md
+++ b/search-app/docs/api.md
@@ -5122,12 +5122,18 @@ On occasions when tool dissociation cannot be processed at all due to invalid in
### Subscription
-Subscription allows a user to register some query conditions in the CMR and be notified when collections/granules matching the conditions are created, updated, or deleted in the CMR. By the end of 2024 there are two kinds of subscriptions. Those that are run by search queries and those that are processed on ingest. The ingest subscriptions are only for granules and notifications are sent out to a provided AWS SQS endpoint. The search subscriptions are run periodically using CMR search and notifiy users by email using the email address that is registered in Earthdata Login. For the search subscriptions, there are two types of subscriptions (identified by the `Type` field of the subscription):
+A subscription allows a user to be notified when specific collections/granules are created, updated, or deleted. The collections/granules specified can be filtered by query conditions.
-- collection subscription for users to be notified when collections are created/updated.
-- granule subscription for users to be notified when granules are created/updated.
+There are two kinds of subscriptions: Search and Ingest
-Subscription metadata is in JSON format and conforms to [UMM-Sub Schema](https://git.earthdata.nasa.gov/projects/EMFD/repos/unified-metadata-model/browse/subscription). Subscriptions of type `granule` must supply a requisite CollectionConceptId, and subscriptions of type `collection` cannot have a CollectionConceptId field. There is a background job that processes the search subscriptions periodically (configurable), to see if there are any collections/granules that are created/updated since the last time the subscription has been processed and notify the subscription user with any matches.
+- Ingest subscriptions are processed on ingest and are only for granules. When a user subscribes, notifications are sent out to a provided AWS SQS endpoint.
+
+- Search subscriptions run periodically via CMR search queries and notify users by the email address that is registered in Earthdata Login. There are two types of subscriptions (identified by the `Type` field of the subscription):
+
+ - collection subscription for users to be notified when collections are created/updated.
+ - granule subscription for users to be notified when granules are created/updated.
+
+There is a configurable background job that processes the search subscriptions periodically, to see if there are any collections/granules that are created/updated since the last time the subscription has been processed and notify the subscription user with any matches.
#### Searching for Subscriptions