Skip to content

Commit e3c0404

Browse files
PODAAC-7294: Add progress reporting and timeout options to API documentation
1 parent b06ad1d commit e3c0404

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

mcc/web/templates/about_api.html

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,9 +191,31 @@ <h3>POST Examples</h3>
191191
<p>
192192
<em>Note that you need to append an '@' to the beginning of the filename in the CURL request when using the file-upload option.</em>
193193
</p>
194+
<h4>Basic Examples</h4>
194195
<pre>curl -L -F ACDD=on -F ACDD-version=1.3 -F file-upload=@/home/user/granule.nc -F response=json {{ homepage_url }}/check
195196
curl -L -F CF=on -F CF-version=1.7 -F file-upload=@/home/user/granule.nc -F response=html {{ homepage_url }}/check
196197
curl -L -F GDS2=on -F GDS2-parameter=L4 -F file-upload=@/home/user/granule.nc -F response=pdf {{ homepage_url }}/check</pre>
198+
199+
<h4>With Progress Reporting and Extended Timeouts</h4>
200+
<p>
201+
<em>For large files, you may want to show progress and set longer timeouts:</em>
202+
</p>
203+
<pre>curl -L --progress-bar --connect-timeout 300 --max-time 3600 --keepalive-time 3600 \
204+
-F ACDD=on -F ACDD-version=1.3 -F file-upload=@/home/user/granule.nc -F response=json {{ homepage_url }}/check</pre>
205+
206+
<h4>With Detailed Progress</h4>
207+
<pre>curl -L -v --progress-meter --connect-timeout 300 --max-time 3600 --keepalive-time 3600 \
208+
-F CF=on -F CF-version=1.7 -F file-upload=@/home/user/granule.nc -F response=html {{ homepage_url }}/check</pre>
209+
210+
<h4>Options Explained</h4>
211+
<ul>
212+
<li><code>--progress-bar</code>: Display a simple progress bar</li>
213+
<li><code>--progress-meter</code>: Display detailed progress information</li>
214+
<li><code>-v</code>: Verbose output showing request and response headers</li>
215+
<li><code>--connect-timeout 300</code>: Wait up to 300 seconds when connecting</li>
216+
<li><code>--max-time 3600</code>: Allow the whole operation to take up to 3600 seconds (1 hour)</li>
217+
<li><code>--keepalive-time 3600</code>: Keep the connection alive for 3600 seconds</li>
218+
</ul>
197219
</div>
198220
</div>
199221
</div>

0 commit comments

Comments
 (0)