Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BCDA-7867: Add 429 recommendations #193

Merged
merged 5 commits into from
Apr 9, 2024
Merged

BCDA-7867: Add 429 recommendations #193

merged 5 commits into from
Apr 9, 2024

Conversation

alex-dzeda
Copy link
Contributor

@alex-dzeda alex-dzeda commented Apr 3, 2024

🎫 Ticket

https://jira.cms.gov/browse/BCDA-7867

🛠 Changes

Added best practices section to "Building Your Application" page, with first best practice being handling 429 status codes.

ℹ️ Context for reviewers

BCDA has two 429 mechanisms, neither of which currently shows recommendations on how to avoid / handle them. By clearly outlining how we recommend clients handle them, we can improve the quality of the BCDA experience and decrease the number of posts that require triaging in the google group.

✅ Acceptance Validation

image

🔒 Security Implications

  • This PR adds a new software dependency or dependencies.
  • This PR modifies or invalidates one or more of our security controls.
  • This PR stores or transmits data that was not stored or transmitted before.
  • This PR requires additional review of its security implications for other reasons.

If any security implications apply, add Jason Ashbaugh (GitHub username: StewGoin) as a reviewer and do not merge this PR without his approval.

@greg-pf
Copy link
Contributor

greg-pf commented Apr 3, 2024

Suggest adding something along the lines of See our [best practices](#handling-429-error) for more information on handling 429 errors. to the following section

<p>
If you're already requesting data from one endpoint and try to request data from that endpoint again while the first request is processing, you'll receive a 429 Too Many Requests error.
</p>

Copy link
Contributor

@greg-pf greg-pf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Requesting review from Jennifer via slack

@alex-dzeda
Copy link
Contributor Author

Suggest adding something along the lines of See our [best practices](#handling-429-error) for more information on handling 429 errors. to the following section

<p>
If you're already requesting data from one endpoint and try to request data from that endpoint again while the first request is processing, you'll receive a 429 Too Many Requests error.
</p>

image
Updated!

@laurenkrugen-navapbc
Copy link
Contributor

Thanks for adding this Alex! I will approve; do we also have approval from someone on the content team?

Copy link
Contributor

@greg-pf greg-pf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sharing Jennifer's review and content edits

_includes/build/best_practices.html Outdated Show resolved Hide resolved
_includes/build/best_practices_429.html Outdated Show resolved Hide resolved
build.html Outdated Show resolved Hide resolved
Copy link
Contributor

@greg-pf greg-pf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

@alex-dzeda alex-dzeda merged commit 0e94460 into master Apr 9, 2024
1 check passed
@alex-dzeda alex-dzeda deleted the alex/bcda-7867 branch April 9, 2024 17:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants