[DEV-14890] - Code Reviews for Pull Request

Author: DavidMikolaKC

usaspending_api/api_contracts/contracts/v2/download/search.md

@@ -77,17 +77,32 @@ This route sends a request to the backend to begin generating a zipfile of award
                 "file_url": "/csv_downloads/PrimeAwardsTransactionsAndSubawards_2020-01-13_H21M05S48397603.zip",
                 "download_request": {
                     "columns": [
-                      
+                      "assistance_award_unique_key",
+                        "assistance_transaction_unique_key",
+                        "award_id_fain",
+                        "award_id_uri",
+                        "modification_number",
+                        "sai_number",
+                        "total_funding_amount"
                     ],
                     "download_types": [
-                        
+                        "elasticsearch_awards",
+                        "elasticsearch_transactions",
+                        "elasticsearch_sub_awards"
                     ],
                     "file_format": "csv",
                     "filters": {
-
-                    },
-                    "limit": 0,
-                    "request_type": "search"
+                        "agencies": [
+                            {
+                                "type": "awarding",
+                                "tier": "toptier",
+                                "name": "Department of Agriculture"
+                            }
+                        ],
+                        "keywords": ["Defense"]
+                        },
+                        "limit": 0,
+                        "request_type": "search"
                 }
             }
 

usaspending_api/api_docs/markdown/endpoints.md

@@ -111,8 +111,8 @@ The currently available endpoints are listed in the following table.
 |[/api/v2/download/disaster/](/api/v2/download/disaster/)|POST| Returns a zipped file containing Account and Award data for the Disaster Funding |
 |[/api/v2/download/disaster/recipients/](/api/v2/download/disaster/recipients/)|POST| Returns a zipped file containing Disaster Recipient Funding data |
 |[/api/v2/download/idv/](/api/v2/download/idv/)|POST| Returns a zipped file containing IDV data |
-|[/api/v2/download/status/](/api/v2/download/status/)|GET| gets the current status of a download job that that has been requested with the `v2/download/awards/` or `v2/download/transaction/` endpoint that same day |
 |[/api/v2/download/search/](/api/v2/download/search/)|POST|Generates zip file for download of award data in CSV format, both awards and transactions |
+|[/api/v2/download/status/](/api/v2/download/status/)|GET| gets the current status of a download job that that has been requested with the `v2/download/awards/` or `v2/download/transaction/` endpoint that same day |
 |[/api/v2/download/transactions/](/api/v2/download/transactions/)|POST|Generates zip file for download of award data in CSV format |
 |[/api/v2/federal_accounts/<ACCOUNT_CODE\>/](/api/v2/federal_accounts/020-0550/)|GET| Returns a federal account based on its federal account code |
 |[/api/v2/federal_accounts/<ACCOUNT_CODE\>/available_object_classes/](/api/v2/federal_accounts/4324/available_object_classes/)|GET| Returns financial spending data by object class based on account's internal ID |

usaspending_api/download/v2/request_validations.py

@@ -293,12 +293,12 @@ def _handle_custom_award_download(self) -> None:
             ]
 
         if "agency" in custom_award_filters or "agencies" in custom_award_filters:
-            final_award_filters["agencies"] = self._update_custom_award_filters(custom_award_filters,
+            final_award_filters["agencies"] = self._update_custom_award_agencies(custom_award_filters,
                                                                                 filter_all_agencies)
 
         self._json_request["filters"] = final_award_filters
 
-    def _update_custom_award_filters(self, custom_award_filters: dict, filter_all_agencies: bool) -> list:
+    def _update_custom_award_agencies(self, custom_award_filters: dict, filter_all_agencies: bool) -> list:
         agency_output = []
 
         if "agency" in custom_award_filters:

usaspending_api/download/v2/urls.py

@@ -14,6 +14,6 @@
     re_path(r"^disaster", views.DisasterDownloadViewSet.as_view()),
     re_path(r"^idv", views.RowLimitedIDVDownloadViewSet.as_view()),
     re_path(r"^status", DownloadStatusViewSet.as_view()),
-    re_path(r"^transactions", views.RowLimitedTransactionDownloadViewSet.as_view()),
-    re_path(r"^search", views.SearchDownloadViewSet.as_view())
+    re_path(r"^search", views.SearchDownloadViewSet.as_view()),
+    re_path(r"^transactions", views.RowLimitedTransactionDownloadViewSet.as_view())
 ]

usaspending_api/download/v2/views.py

@@ -120,7 +120,8 @@ def post(self, request: dict) -> Response:
 
 class SearchDownloadViewSet(BaseDownloadViewSet):
     """
-    This route sends a request to begin generating a zip file that combines award and transaction data
+    This route sends a request to begin generating a zip file,
+    combining award, transaction, and subaward data
     """
 
     endpoint_doc = "usaspending_api/api_contracts/contracts/v2/download/search.md"