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

Improvements to asynchronous HTTP function pages #154

Closed
YYBartT opened this issue Aug 7, 2024 · 1 comment
Closed

Improvements to asynchronous HTTP function pages #154

YYBartT opened this issue Aug 7, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@YYBartT
Copy link
Collaborator

YYBartT commented Aug 7, 2024

The manual's Asynchronous HTTP Functions page currently lists all functions without providing a basic explanation of HTTP requests. It also lacks an overview on which function to use when. http_request() is the most "generic" function that can be used and http_get(), http_get_file() and http_post_string() can be used in more specific cases.

To be changed:

  • Add a short introduction to the asynchronous HTTP functions page and point out which function to use where/when. Link this introduction to a basic explanation of HTTP GET and POST requests (i.e. HTTP requests have a header and a body, body is optional, etc.).
  • Add a complete code example on how to handle an HTTP request (or, alternatively, only a basic GET), complete with code in the async HTTP event that handles the entire request from start to end (i.e. from async_load[? "status"] equal to 1 up to the last event where it equals 0). Also add some code to the example that shows the progress bar.
  • Make a clear distinction between URL parameters and request body.
  • Possibly a few other things.

Brought up while doing changes for: YoYoGames/GameMaker-Bugs#5744

@jackerley jackerley moved this from Triage to Backlog in Team Workload Aug 8, 2024
@YYBartT YYBartT added the documentation Improvements or additions to documentation label Sep 23, 2024
@YYBartT YYBartT moved this from Backlog to In Progress in Team Workload Sep 23, 2024
YYBartT added a commit that referenced this issue Oct 3, 2024
#154

* HTTP Functions page:
  * Added a short introduction about HTTP, including basic terminology
  * Added request functions and notes on URL format
  * Added basic request example
* http_request:
  * Clarified parameter descriptions
  * Removed real data type of body parameter
* Async callback:
  * Moved to RH "note" snippet and inserted on function pages
  * Clarified variables
* Code examples: changed most ds_map_* function calls to DS map accessors
@YYBartT YYBartT moved this from In Progress to Ready for QA in Team Workload Oct 4, 2024
@YYBartT YYBartT closed this as completed Oct 4, 2024
@github-project-automation github-project-automation bot moved this from Ready for QA to Done in Team Workload Oct 4, 2024
@YYBartT YYBartT added this to the 2024.11 milestone Dec 16, 2024
@YYBartT YYBartT moved this from Done to Ready for QA in Team Workload Dec 16, 2024
@Emc1923 Emc1923 self-assigned this Dec 16, 2024
@Emc1923
Copy link

Emc1923 commented Dec 16, 2024

Verified changes in the monthly manual, closing.

@Emc1923 Emc1923 removed the status in Team Workload Dec 16, 2024
@Emc1923 Emc1923 moved this to Verified in Team Workload Dec 16, 2024
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
Status: Verified
Development

No branches or pull requests

2 participants