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

Update README examples #64

Merged
merged 1 commit into from
Apr 1, 2025
Merged

Update README examples #64

merged 1 commit into from
Apr 1, 2025

Conversation

PietrH
Copy link
Member

@PietrH PietrH commented Apr 1, 2025

  • I rewrote the R example to use httr2, and switched over to a quicker function call.

  • I removed a cookie line from the curl example

  • The credentials syntax is slightly different, I believe, anyway, this is how it should be.

AI Summary

This pull request includes updates to the README.md and README.Rmd files to reflect changes in the API usage and improve code examples. The most important changes include switching from httr to httr2, updating the endpoint URLs, and modifying the example credentials format.

Updates to API usage:

  • README.Rmd: Changed the library from httr to httr2 and updated the endpoint URL in the R example code.
  • README.md: Changed the library from httr to httr2 and updated the endpoint URL in the R example code.

Improvements to code examples:

  • README.Rmd: Updated the example credentials format and modified the endpoint URL in the bash example code.
  • README.md: Updated the example credentials format and modified the endpoint URL in the bash example code.

@PietrH PietrH added the documentation Improvements or additions to documentation label Apr 1, 2025
@PietrH PietrH requested review from sannegovaert and Copilot April 1, 2025 09:02
@PietrH PietrH self-assigned this Apr 1, 2025
@PietrH PietrH linked an issue Apr 1, 2025 that may be closed by this pull request
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This pull request updates the README examples to reflect changes in API usage using the httr2 library and updated credentials formatting.

  • Switched the R API example from httr to httr2 and updated the endpoint URL.
  • Updated the bash example to use the new endpoint URL and revised credential placeholders.
Files not reviewed (1)
  • README.Rmd: Language not supported

Copy link
Member

@sannegovaert sannegovaert left a comment

Choose a reason for hiding this comment

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

Huray!

@PietrH PietrH merged commit 13f66ba into main Apr 1, 2025
6 checks passed
@PietrH PietrH deleted the 63-update-readme-example branch April 1, 2025 12:52
@PietrH
Copy link
Member Author

PietrH commented Apr 1, 2025

Thanks Sanne!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update readme example
2 participants