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 HttpService.yaml with HTTP methods, explanations, and resources. #978

Open
wants to merge 17 commits into
base: main
Choose a base branch
from

Conversation

sammygrey
Copy link
Contributor

Changes

Updated HttpService.yaml to provide a short description of each of the HTTP methods, if they are permitted via Roblox scripts, and Mozilla resources for each. This is a duplicate of pull request #966 as the checks did not seem to recognize the changes made to tools/checks/utils/allowedHttpLinks.txt to allow the links to Mozilla resources on each of the HTTP methods.

The only method not currently permitted by Roblox is the CONNECT method which creates a secure information tunnel between the requested and originating server. Makes sense why this isn't allowed, but its useful information to include nonetheless.

Added information for HTTP methods, what they are, and if they are currently supported by Roblox's HTTPService
Added https://developer.mozilla.org/ to the list of allowed HTTP links
guessing the check system doesn't whitelist all child urls under a parent url
@sammygrey sammygrey requested review from a team as code owners January 10, 2025 23:18
@sammygrey sammygrey requested a review from zovits January 10, 2025 23:18
@github-actions github-actions bot added engine reference Changes the Engine API Reference documentation tools Makes non-content changes labels Jan 10, 2025
@github-actions github-actions bot added the changes requested This pull request has changes requested prior to merging label Jan 10, 2025
@sammygrey
Copy link
Contributor Author

sammygrey commented Jan 10, 2025

I literally already did this, I guess ill have to open a pull request with the only change being to tools/checks/utils/allowedHttpLinks.txt

@github-actions github-actions bot removed the tools Makes non-content changes label Jan 16, 2025
@IgnisRBX
Copy link
Contributor

I took this PR as an opportunity to clean up the overall page, so you'll see a bunch of formatting and minor tweaks in my commit.

In regards to your addition, though, you had both a "Supported" and "Safe" column in the table, but I think you meant to only have "Safe", so I deleted the entire "Supported" column (which was empty and had nothing in any row cell). However, this might not have been your intent, since now some request methods like POST are marked as "safe" but the Mozilla reference marks them as unsafe. Can you please confirm all of the entries are marked correctly as "safe" or "not safe"? If you need to add back the "Supported" column, go ahead, just make sure everything lines up correctly. Thanks!

@IgnisRBX
Copy link
Contributor

IgnisRBX commented Jan 16, 2025

Following up, I see your comment that only CONNECT is not supported. So, I prefer that is omitted from the added table, since it cannot be used in Roblox context. And I changed the header of that new section to "Supported HTTP headers" to clarify that the table includes only supported methods (vs. having a column for "Supported" in the table with only CONNECT marked as unsupported).

Corrected incorrect values for the "Safe" collumn for HTTP methods
@sammygrey
Copy link
Contributor Author

I took this PR as an opportunity to clean up the overall page, so you'll see a bunch of formatting and minor tweaks in my commit.

In regards to your addition, though, you had both a "Supported" and "Safe" column in the table, but I think you meant to only have "Safe", so I deleted the entire "Supported" column (which was empty and had nothing in any row cell). However, this might not have been your intent, since now some request methods like POST are marked as "safe" but the Mozilla reference marks them as unsafe. Can you please confirm all of the entries are marked correctly as "safe" or "not safe"? If you need to add back the "Supported" column, go ahead, just make sure everything lines up correctly. Thanks!

Thats my bad, looks like I copied the sections of that collumn as a template for the markdown, but never actually changed the values to their correct counterparts. Should be fixed now.

@sammygrey
Copy link
Contributor Author

sammygrey commented Jan 16, 2025

I took this PR as an opportunity to clean up the overall page, so you'll see a bunch of formatting and minor tweaks in my commit.

In regards to your addition, though, you had both a "Supported" and "Safe" column in the table, but I think you meant to only have "Safe", so I deleted the entire "Supported" column (which was empty and had nothing in any row cell). However, this might not have been your intent, since now some request methods like POST are marked as "safe" but the Mozilla reference marks them as unsafe. Can you please confirm all of the entries are marked correctly as "safe" or "not safe"? If you need to add back the "Supported" column, go ahead, just make sure everything lines up correctly. Thanks!

Replying to this again because I had to remove some of the changes you made as I'm lacking the permissions to edit code_sample sections. You should have this permission however, so I made a gist that's just the file before the code_sample removals. You should be able to easily merge this if you so choose.

@sammygrey sammygrey requested a review from IgnisRBX January 18, 2025 21:06
@IgnisRBX
Copy link
Contributor

Are there further edits needed for the code samples? If so, can you indicate which samples (by name) need edits, and what those edits are? Thanks!

@sammygrey
Copy link
Contributor Author

sammygrey commented Jan 22, 2025

Are there further edits needed for the code samples? If so, can you indicate which samples (by name) need edits, and what those edits are? Thanks!

I believe the change you made that couldn't be implemented was just removing the "International-Space-Station" code sample from the areas that included it. It threw an error with checks because I don't have adequate permissions to change code samples. I don't believe anything else needs editing, that was the only part that failed checks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changes requested This pull request has changes requested prior to merging engine reference Changes the Engine API Reference documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants