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

Added a guide on making raw JSON REST requests. #542

Merged

Conversation

dblock
Copy link
Member

@dblock dblock commented Oct 16, 2023

Description

Document making raw JSON REST requests.

Issues Resolved

Related to #498. Not closing this issue because we want a better DSL.

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.

Copy link
Collaborator

@saimedhi saimedhi left a comment

Choose a reason for hiding this comment

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

Code tested and working :)

@saimedhi saimedhi self-requested a review October 16, 2023 18:52
guides/json.md Outdated Show resolved Hide resolved
Signed-off-by: dblock <dblock@amazon.com>
@dblock dblock force-pushed the doc-making-raw-json-requests branch from 3b1db8a to 7e8d773 Compare October 16, 2023 19:21
@codecov
Copy link

codecov bot commented Oct 16, 2023

Codecov Report

Merging #542 (7e8d773) into main (af263a0) will not change coverage.
Report is 1 commits behind head on main.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #542   +/-   ##
=======================================
  Coverage   70.70%   70.70%           
=======================================
  Files          83       83           
  Lines        7857     7857           
=======================================
  Hits         5555     5555           
  Misses       2302     2302           

@saimedhi saimedhi merged commit fa8f3a7 into opensearch-project:main Oct 16, 2023
52 of 53 checks passed
@dblock dblock deleted the doc-making-raw-json-requests branch October 16, 2023 19:57
Djcarrillo6 added a commit to Djcarrillo6/opensearch-py that referenced this pull request Oct 25, 2023
Signed-off-by: Djcarrillo6 <djcarrillo6@yahoo.com>

Added a guide on making raw JSON REST requests. (opensearch-project#542)

Signed-off-by: dblock <dblock@amazon.com>

Added document lifecycle guide & sample code.

Signed-off-by: Djcarrillo6 <djcarrillo6@yahoo.com>

Updated CHANGELOG

Signed-off-by: Djcarrillo6 <djcarrillo6@yahoo.com>

Added support for AWS Sigv4 for UrlLib3. (opensearch-project#547)

* WIP: Added support for AWS Sigv4 for UrlLib3.

Signed-off-by: dblock <dblock@amazon.com>

* Refactored common implementation.

Signed-off-by: dblock <dblock@amazon.com>

* Added sigv4 samples.

Signed-off-by: dblock <dblock@amazon.com>

* Updated CHANGELOG.

Signed-off-by: dblock <dblock@amazon.com>

* Add documentation.

Signed-off-by: dblock <dblock@amazon.com>

* Use the correct class in tests.

Signed-off-by: dblock <dblock@amazon.com>

* Renamed samples.

Signed-off-by: dblock <dblock@amazon.com>

* Split up requests and urllib3 unit tests.

Signed-off-by: dblock <dblock@amazon.com>

* Rename AWSV4Signer.

Signed-off-by: dblock <dblock@amazon.com>

* Clarified documentation of when to use Urllib3AWSV4SignerAuth vs. RequestHttpConnection.

Signed-off-by: dblock <dblock@amazon.com>

* Move fetch_url inside the signer class.

Signed-off-by: dblock <dblock@amazon.com>

* Added unit test for Urllib3AWSV4SignerAuth adding headers.

Signed-off-by: dblock <dblock@amazon.com>

* Added unit test for signing to include query string.

Signed-off-by: dblock <dblock@amazon.com>

---------

Signed-off-by: dblock <dblock@amazon.com>

Remove support for Python 2.x. (opensearch-project#548)

Signed-off-by: dblock <dblock@amazon.com>

Fixed guide & added link in USER_GUIDE.md

Signed-off-by: Djcarrillo6 <djcarrillo6@yahoo.com>

Added support for AWS Sigv4 for UrlLib3. (opensearch-project#547)

* WIP: Added support for AWS Sigv4 for UrlLib3.

Signed-off-by: dblock <dblock@amazon.com>

* Refactored common implementation.

Signed-off-by: dblock <dblock@amazon.com>

* Added sigv4 samples.

Signed-off-by: dblock <dblock@amazon.com>

* Updated CHANGELOG.

Signed-off-by: dblock <dblock@amazon.com>

* Add documentation.

Signed-off-by: dblock <dblock@amazon.com>

* Use the correct class in tests.

Signed-off-by: dblock <dblock@amazon.com>

* Renamed samples.

Signed-off-by: dblock <dblock@amazon.com>

* Split up requests and urllib3 unit tests.

Signed-off-by: dblock <dblock@amazon.com>

* Rename AWSV4Signer.

Signed-off-by: dblock <dblock@amazon.com>

* Clarified documentation of when to use Urllib3AWSV4SignerAuth vs. RequestHttpConnection.

Signed-off-by: dblock <dblock@amazon.com>

* Move fetch_url inside the signer class.

Signed-off-by: dblock <dblock@amazon.com>

* Added unit test for Urllib3AWSV4SignerAuth adding headers.

Signed-off-by: dblock <dblock@amazon.com>

* Added unit test for signing to include query string.

Signed-off-by: dblock <dblock@amazon.com>

---------

Signed-off-by: dblock <dblock@amazon.com>

Remove support for Python 2.x. (opensearch-project#548)

Signed-off-by: dblock <dblock@amazon.com>

Fixed guide & added link in USER_GUIDE.md opensearch-project#3

Signed-off-by: Djcarrillo6 <djcarrillo6@yahoo.com>
roma2023 pushed a commit to roma2023/opensearch-py that referenced this pull request Dec 28, 2023
Signed-off-by: dblock <dblock@amazon.com>
Signed-off-by: roma2023 <romasaparhan19@gmail.com>
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