BCDA-8390-adjust-file-download-copy

CMSgov · Dec 16, 2024 · 24aa28d · 24aa28d
1 parent 4d21de3
commit 24aa28d
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 5 deletions.
diff --git a/_includes/build/best_practices_download_speed.html b/_includes/build/best_practices_download_speed.html
@@ -4,15 +4,16 @@ <h3>
   </h3>
 
   <p>
-    Requesting compressed data can help increase your download speed. You can request compressed data files by specifying the `Accept-Encoding: gzip` header in your download requests.
+    Requesting compressed data can help increase your download speed. You can request compressed data files by specifying the `Accept-Encoding: gzip` header in your download requests.  Note that the file downloaded will be a gzip file which you will need to extract into its ndjson format.
   </p>
 
   <H4>
     Sample cURL Command to Download the Data
   </H4>
   <pre><code>curl "<span style="color: #046B99;">{output_url}</span>" \
 	-H "Authorization: Bearer <span style="color: #046B99;">{access_token}</span>" \
-	-H "Accept-Encoding: gzip"
+	-H "Accept-Encoding: gzip" \
+	--output "your-file-name"
 </code></pre>
 
   <h3>

diff --git a/_includes/build/requesting_data_all_three.html b/_includes/build/requesting_data_all_three.html
@@ -144,7 +144,8 @@ <h4>Request Headers</h4>
 <h4>cURL Command to download the data</h4>
 	<pre><code>curl -X GET "<span style="color: #046B99;">{output_url}</span>" \
 	-H "Accept-Encoding: gzip" \
-	-H "Authorization: Bearer <span style="color: #046B99;">{access_token}</span>"</code></pre>
+	-H "Authorization: Bearer <span style="color: #046B99;">{access_token}</span>" \
+	--output "your-file-name"</code></pre>
 
 <h4>Response Example</h4>
 	<p>
@@ -173,7 +174,7 @@ <h3 class="ds-c-alert__heading"> Files expire after 24 hours.</h3>
 	</div>
 
 	<p>
-		The "Accept-Encoding: gzip" header is optional, but will return a significantly smaller (about 30X smaller) file with a faster download speed. Follow our recommended best practices for <a href="#speeding-up-downloads" class="in-text__link">speeding up downloads</a>.
+		The "Accept-Encoding: gzip" header is optional, but will return a significantly smaller (about 30X smaller) file with a faster download speed. Follow our recommended best practices for <a href="#speeding-up-downloads" class="in-text__link">speeding up downloads</a>.  Note that the file downloaded will be a gzip file which you will need to extract into its ndjson format.
 	</p>
 	<p>
 		The response will be the requested data as FHIR resources in NDJSON format. Each file related to a different resource type will appear separately and labeled as to which resource type it contains. Examples of data from each Resource Type are available in the guide to working with BCDA data.

diff --git a/_includes/guide/try_the_api.html b/_includes/guide/try_the_api.html
@@ -203,7 +203,8 @@ <H4>
 	</H4>
 <pre><code>curl "<span style="color: #046B99;">{output_url}</span>" \
 	-H "Authorization: Bearer <span style="color: #046B99;">{access_token}</span>" \
-	-H "Accept-Encoding: gzip"
+	-H "Accept-Encoding: gzip" \
+	--output "your-file-name"
 </code></pre>
 <h4>
 Response Example after Downloading the Data