Merge pull request #283 from asfadmin/feature-shortname-search

`shortName` Search Keyword
asfadmin · Mar 22, 2024 · c5a32d5 · c5a32d5
2 parents 00f9246 + 5662fcc
commit c5a32d5
Show file tree

Hide file tree

Showing 7 changed files with 11 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -25,6 +25,11 @@ and uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 -
 
 -->
+------
+## [v7.0.7](https://github.com/asfadmin/Discovery-asf_search/compare/v7.0.6...v7.0.7)
+### Added
+- Adds `shortName` keyword, for use with lists of collection short names
+
 ------
 ## [v7.0.6](https://github.com/asfadmin/Discovery-asf_search/compare/v7.0.5...v7.0.6)
 ### Changed

diff --git a/asf_search/ASFSearchOptions/validator_map.py b/asf_search/ASFSearchOptions/validator_map.py
@@ -56,6 +56,7 @@ def validate(key, value):
     'insarStackId':           parse_string,
     'instrument':             parse_string,
     'collections':            parse_string_list,
+    'shortName':              parse_string_list,
     'temporalBaselineDays':   parse_string_list,
     'operaBurstID':           parse_string_list,
     'absoluteBurstID':        parse_int_list,

diff --git a/asf_search/CMR/field_map.py b/asf_search/CMR/field_map.py
@@ -35,6 +35,7 @@
     'relativeOrbit':        {'key': 'attribute[]',             'fmt': 'int,PATH_NUMBER,{0}'},
     'temporal':             {'key': 'temporal',                'fmt': '{0}'},
     'collections':          {'key': 'echo_collection_id[]',    'fmt': '{0}'},
+    'shortName':            {'key': 'shortName',               'fmt': '{0}'},
     'temporalBaselineDays': {'key': 'attribute[]',             'fmt': 'int,TEMPORAL_BASELINE_DAYS,{0}'},
 
     # SLC BURST fields

diff --git a/asf_search/search/geo_search.py b/asf_search/search/geo_search.py
@@ -43,6 +43,7 @@ def geo_search(
         temporalBaselineDays: Union[str, Sequence[str]] = None,
         operaBurstID: Union[str, Sequence[str]] = None,
         dataset: Union[str, Sequence[str]] = None,
+        shortName: Union[str, Sequence[str]] = None,
         maxResults: int = None,
         opts: ASFSearchOptions = None,
 ) -> ASFSearchResults:

diff --git a/asf_search/search/search.py b/asf_search/search/search.py
@@ -42,6 +42,7 @@ def search(
         temporalBaselineDays: Union[str, Sequence[str]] = None,
         operaBurstID: Union[str, Sequence[str]] = None,
         dataset: Union[str, Sequence[str]] = None,
+        shortName: Union[str, Sequence[str]] = None,
         maxResults: int = None,
         opts: ASFSearchOptions = None,
 ) -> ASFSearchResults:

diff --git a/asf_search/search/search_count.py b/asf_search/search/search_count.py
@@ -44,6 +44,7 @@ def search_count(
         temporalBaselineDays: Union[str, Sequence[str]] = None,
         operaBurstID: Union[str, Sequence[str]] = None,
         dataset: Union[str, Sequence[str]] = None,
+        shortName: Union[str, Sequence[str]] = None,
         maxResults: int = None,
         opts: ASFSearchOptions = None,
 ) -> int:

diff --git a/asf_search/search/search_generator.py b/asf_search/search/search_generator.py
@@ -60,6 +60,7 @@ def search_generator(
         temporalBaselineDays: Union[str, Sequence[str]] = None,
         operaBurstID: Union[str, Sequence[str]] = None,
         dataset: Union[str, Sequence[str]] = None,
+        shortName: Union[str, Sequence[str]] = None,
         maxResults: int = None,
         opts: ASFSearchOptions = None,
         ) -> Generator[ASFSearchResults, None, None]: