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

Add Documentation for proxy failure modes #595

Merged
merged 2 commits into from
Apr 23, 2024

Conversation

AndreKurait
Copy link
Member

Description

Add Documentation for proxy failure modes

  • Category: Documentation
  • Why these changes are required? Give a starting point for specifying failure cases in the proxy to educate users around behaviors and configuration
  • What is the old behavior before changes and new behavior after changes? No functional change

Issues Resolved

MIGRATIONS-1487

Is this a backport? If so, please add backport PR # and/or commits #

Testing

Viewed README in markdown viewer

Check List

  • [ x] New functionality includes testing
    • [ x] All tests pass, including unit test, integration test and doctest
  • [x ] New functionality has been documented
  • [x ] Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@AndreKurait AndreKurait marked this pull request as ready for review April 18, 2024 04:40
Copy link
Collaborator

@gregschohn gregschohn left a comment

Choose a reason for hiding this comment

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

I think that this is a good start. I'd love to add a column to this table to reference a line of code for the test that shows that these behaviors are being tested.

Copy link

codecov bot commented Apr 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.02%. Comparing base (384401e) to head (987125c).
Report is 9 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff              @@
##               main     #595      +/-   ##
============================================
+ Coverage     75.91%   76.02%   +0.11%     
- Complexity     1491     1494       +3     
============================================
  Files           162      162              
  Lines          6348     6348              
  Branches        572      572              
============================================
+ Hits           4819     4826       +7     
+ Misses         1152     1145       -7     
  Partials        377      377              
Flag Coverage Δ
unittests 76.02% <ø> (+0.11%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@AndreKurait AndreKurait merged commit ccb316d into opensearch-project:main Apr 23, 2024
7 checks passed
@AndreKurait AndreKurait deleted the AddProxyFailureModes branch April 23, 2024 21:03
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.

2 participants