summaryrefslogtreecommitdiff
path: root/doc/classes/HTTPRequest.xml
AgeCommit message (Collapse)Author
2023-01-31Fix C# examples in documentationRaul Santos
- Fix documentation after C# renames. - Add missing `partial` in C# class declarations. - Change `delta` parameter type to `double` in C#. - Ensure parameters match base declaration. - Use `$` string interpolation in C#. - Fix invalid or outdated C# code. - Changed some examples to follow our style guide more closely.
2023-01-28[NET] Refactor TLS configuration.Fabio Alessandrelli
Use a TLSOptions configuration object which is created via static functions. - "TLSOptions.client": uses the standard CA and common name verification. - "TLSOptions.client_unsafe": uses optional CA verification (i.e. if specified) - "TLSOptions.server": is the standard server configuration (chain + key) This will allow us to expand the TLS configuration options to include e.g. mutual authentication without bloating the classes that uses StreamPeerTLS and PacketPeerDTLS as underlying peers.
2023-01-23Update C# signal documentation and remove bind arrayRaul Santos
- Updates C# signal documentation and code examples to the new API in 4.0 - Replace all `nameof` usages with the exposed `StringName`
2022-11-02Style: Misc docs and comment style and language fixesRémi Verschelde
- Removed empty paragraphs in XML. - Consistently use bold style for "Example:", on a new line. - Fix usage of `[code]` when hyperlinks could be used (`[member]`, `[constant]`). - Fix invalid usage of backticks for inline code in BBCode. - Fix some American/British English spelling inconsistencies. - Other minor fixes spotted along the way, including typo fixes with codespell. - Don't specify `@GlobalScope` for `enum` and `constant`.
2022-09-08[Net] Rename "ssl" references to "tls" in methods and members.Fabio Alessandrelli
2022-08-17[doc] Fix grammar in class docs: amount vs. numberAndy Maloney
Number is used for things that can be counted (discrete items - think "integer" in this context). Also fixes a couple of awkward phrases.
2022-08-12[doc] Use "param" instead of "code" to refer to parameters (6)Andy Maloney
2022-08-08Rename the argument tag to param in XML documentationYuri Sizov
2022-07-08Document the `timeout` property in HTTPRequestHugo Locurcio
2022-07-08Add static methods for creating Image and ImageTexturekobewi
2022-06-24Make code example in HTTPRequest classref workingHaoyu Qiu
Co-authored-by: Raul Santos <raulsntos@gmail.com>
2022-03-27[Net] Change HTTPRequest timeout type to double.Fabio Alessandrelli
For consistency with the Timer class and general time representation inside the engine.
2022-02-15Add an XML schema for documentationHugo Locurcio
This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2021-12-09Add proxy support for the editorHaoyu Qiu
* Adds proxy support for `HTTPRequest`. * Adds `network/http_proxy/{host,port}` editor settings. * Labeled as "HTTP Proxy" and it will be used for both HTTP and HTTPS requests. This is the same convention as seen in Android Studio's proxy settings. * Makes Asset Library and Export Template Manager use proxy according to the editor settings.
2021-11-15Replace Godot docs URL with `$DOCS_URL` in XML class referenceRémi Verschelde
2021-09-25Document Android permission requirements for network access where neededHugo Locurcio
2021-09-07security tip when sending sensitive data on HTTP requestsArthur Paulino
2021-09-03improving note on HTTPRequest class under the request method documentationArthur Paulino
2021-08-11Docs: Add warnings about no SSL/(D)TLS revocationMax Hilbrunner
2021-07-30doc: Use self-closing tags for `return` and `argument`Rémi Verschelde
For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-06-18Better format arguments in variant parserMichael Alexsander Silva Dias
2021-03-19class reference proofreadingPaul Joannon
2021-01-28Unify URI encoding/decoding and add to C#Aaron Franke
http_escape and percent_encode have been unified into uri_encode, and http_unescape and percent_decode have been unified into uri_decode.
2020-11-25Docs: Port Code Examples to C# (F, G, H, I, J, K, L)HaSa1002
Includes: * File * Geometry2D * HashingContext * HTTPClient * HTTPRequest * Image * Input * int * ItemList * JSONParseResult * KinematicBody2D * LineEdit Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
2020-11-07Merge pull request #42896 from Calinou/httprequest-increase-chunk-sizeRémi Verschelde
Increase the default HTTPClient download chunk size to 64 KiB
2020-11-07Increase the default HTTPClient download chunk size to 64 KiBHugo Locurcio
This improves download speeds at the cost of increased memory usage. This change also effects HTTPRequest automatically. See #32807 and #33862.
2020-11-06Merge pull request #42870 from Calinou/doc-httprequest-tls-versionRémi Verschelde
Document the supported TLS versions in HTTPRequest
2020-10-31Fix a variable being redeclared in the HTTPRequest code sampleHugo Locurcio
2020-10-17Document the supported TLS versions in HTTPRequestHugo Locurcio
See #42857.
2020-09-18Fix typos with codespellRémi Verschelde
Using codespell 1.17.1. Method: ``` $ cat > ../godot-word-whitelist.txt << EOF ang curvelinear dof doubleclick fave findn leapyear lod merchantibility nd numer ois ony que seeked synching te uint unselect webp EOF $ codespell -w -q 3 -I ../godot-word-whitelist.txt --skip="./thirdparty,*.po" $ git diff // undo unwanted changes ```
2020-09-11doc: Sync classref with current sourceRémi Verschelde
Bind missing enums.
2020-09-02HTTPRequest now accepts gzipAdam Brown
Added request_raw to HttpRequest Added decompress_dynamic to Compression class Added decompress_dynamic to BytePoolArray Merge doc fix revert
2020-08-31Add link titles for all links in the class referenceHugo Locurcio
This makes them display in a nicer way in the editor help. (The title will display instead of the full URL.)
2020-08-03Document HTTPRequest not supporting request data with GET methodHugo Locurcio
This also improves the HTTPClient class documentation to be easier to read and more informative. This closes #40564.
2020-07-20Document HTML5 CORS restrictions in HTTPClient and HTTPRequestHugo Locurcio
See https://github.com/godotengine/godot/issues/40247.
2020-07-10Add a POST request example to the HTTPRequest class documentationHugo Locurcio
2020-02-18doc: Sync classref with current sourceRémi Verschelde
Handle removal of Pool*Array types and other recent changes.
2020-01-31Update docs to version 4.0clayjohn
2020-01-26doc: Drop unused 'category' property from headerRémi Verschelde
We already removed it from the online docs with #35132. Currently it can only be "Built-In Types" (Variant types) or "Core" (everything else), which is of limited use. We might also want to consider dropping it from `ClassDB` altogether in Godot 4.0.
2020-01-23doc: Misc updates for AnimationNode* and othersRémi Verschelde
- Add some missing descriptions. - Add links to tutorials for ARVR and AnimationTree. - Style fixes. - Engine changes: * Make `AnimationNodeTransition.input_<number>` properties internal so that they don't appear in the docs. They still appear in the inspector based on the actual number of inputs requested. * Drop unimplemented `CPUParticles.flatness`. It's only used for 3D particles in `ParticlesMaterial`, and thus only relevant for `CPUParticles3D`.
2019-12-24Add an example of using HTTPRequest to contact a REST APIHugo Locurcio
We already had an example to download and display an image, but having another example dedicated to REST APIs doesn't hurt.
2019-12-06doc: Markup fixes for enums and constantsRémi Verschelde
2019-11-24Add download_chunk_size property to HTTPRequest.Fabio Alessandrelli
This allows setting the `read_chunk_size` of the internal HTTPClient. This is important to reduce the allocation overhead and number of file writes when downloading large files, allowing for better download speed.
2019-11-07Add an HTTPRequest usage example to the class referenceHugo Locurcio
This also adds a link to the "Making HTTP requests" tutorial.
2019-10-22Mention body length getter caveats in HTTPClient and HTTPRequestHugo Locurcio
2019-07-10doc: Sync classref with current sourceRémi Verschelde
2019-06-30doc: Add default values to all propertiesRémi Verschelde
Thanks to @bojidar-bg's impressive work in #29380.
2019-06-27Proofread and improve the whole class referenceHugo Locurcio
- Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-27doc: Don't use `GlobalScope` scope in hyperlinks, it's automatically inferredRémi Verschelde
2019-06-27doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinksRémi Verschelde
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-14 21:38:32 +0000