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

http: add POST example to request() function #1096

Merged
merged 4 commits into from
Apr 4, 2025

Conversation

hunterachieng
Copy link
Contributor

@hunterachieng hunterachieng commented Mar 24, 2025

Summary

Add POST example to request() function.

Fixes #1083

Details

Added a POST request example to the http request() function.

AI Usage

Please disclose how you've used AI in this work (it's cool, we just want to
know!):

  • Code generation (copilot but not intellisense)
  • Learning or fact checking
  • Strategy / design
  • Optimisation / refactoring
  • Translation / spellchecking / doc gen
  • Other
  • I have not used AI

You can read more details in our
Responsible AI Policy

Review Checklist

Before merging, the reviewer should check the following items:

  • Does the PR do what it claims to do?
  • If this is a new adaptor, added the adaptor on marketing website ?
  • If this PR includes breaking changes, do we need to update any jobs in
    production? Is it safe to release?
  • Are there any unit tests?
  • Is there a changeset associated with this PR? Should there be? Note that
    dev only changes don't need a changeset.
  • Have you ticked a box under AI Usage?

Signed-off-by: Hunter Achieng <[email protected]>
Signed-off-by: Hunter Achieng <[email protected]>
@github-project-automation github-project-automation bot moved this to New Issues in v2 Mar 24, 2025
@josephjclark
Copy link
Collaborator

@hunterachieng can you please fix the PR description and mark the AI disclaimer? I cannot review PRs (even simple ones) if the admin is not accurate

@hunterachieng
Copy link
Contributor Author

@hunterachieng can you please fix the PR description and mark the AI disclaimer? I cannot review PRs (even simple ones) if the admin is not accurate

Done

@josephjclark
Copy link
Collaborator

Thank you @hunterachieng . By the way you can just delete the sections that aren't relevant. Like you don't need a details section for such a simple API (although you might choose to use that space to talk about why the example looks like it does, what options you considered, what you prioritised, why the example is valuable, etc)

Anyway can you please bump the versions and push?

@josephjclark
Copy link
Collaborator

@hunterachieng reminder to run pnpm changeset version here so that I can merge and release. Thanks!

Signed-off-by: Hunter Achieng <[email protected]>
@hunterachieng
Copy link
Contributor Author

@josephjclark This is done

@josephjclark josephjclark merged commit 3e4182a into main Apr 4, 2025
2 checks passed
@github-project-automation github-project-automation bot moved this from New Issues to Done in v2 Apr 4, 2025
@josephjclark josephjclark deleted the feature/1083-http-docs branch April 4, 2025 06:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

http: Fix Documentation
2 participants