diff --git a/_includes/build/best_practices.html b/_includes/build/best_practices.html index 2611682..094418b 100644 --- a/_includes/build/best_practices.html +++ b/_includes/build/best_practices.html @@ -1,7 +1,2 @@
-

- There are many ways to accomplish the same objective within BCDA, and following our list of best practices can ensure optimal performance for all consumers of BCDA. -

- -
- \ No newline at end of file + \ No newline at end of file diff --git a/_includes/build/best_practices_429.html b/_includes/build/best_practices_429.html index 25e7887..33a8833 100644 --- a/_includes/build/best_practices_429.html +++ b/_includes/build/best_practices_429.html @@ -1,15 +1,8 @@ -
-

Occasionally, when interacting with BCDA, you might encounter responses with a status code of 429 Too Many Requests.

- -

BCDA assigns 429 response codes based on two independent criteria:

- +

A status code of 429 indicates “Too Many Requests.” This can occur due to two reasons:

    -
  1. Making too many HTTP requests in a period of time.
  2. -
  3. Attempting to create duplicate jobs.
  4. +
  5. Making too many HTTP requests within a period of time
  6. +
  7. Trying to recreate jobs already marked as "In-Progress.” For reference, you can view both existing and past jobs using the /jobs endpoint. See Request Jobs History for more details.
- -

Regardless of the reason, BCDA will include a Retry-After header in its response. It's considered best practice to wait until the period specified in this header has elapsed before making further requests. This ensures your client can adapt without manual intervention, even if the rate-limiting parameters change.

- -

Concerning duplicate jobs, BCDA defines them as attempts to recreate a job already marked as "In-Progress". For reference, you can view both existing and past jobs by accessing the job history endpoint at /jobs.

+

Regardless of the reason, you will see a Retry-After response in the header. Wait until the period of time specified in the header has passed before making any more requests. This makes sure your client can adapt without manual intervention, even if the rate-limiting parameters change.

\ No newline at end of file diff --git a/build.html b/build.html index 0cd2962..a536ce2 100644 --- a/build.html +++ b/build.html @@ -283,7 +283,7 @@

- Best Practices for Utilizing BCDA + Best Practices

{% include build/best_practices.html %}