actions/http
1
0
Fork 0
mirror of https://github.com/fjogeleit/http-request-action.git synced 2024-11-28 23:00:58 -05:00
Code Issues Projects Releases Packages Wiki Activity

docs: clarification that data can be entered as key value pairs under appropriate conditions

Browse source
This commit is contained in:
Matthew Cloney 2021-10-12 16:57:47 -04:00
parent 8e939c608a
commit 1ea54adf35
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -24,7 +24,7 @@ jobs:
|url | Request URL | _required_ Field | |url | Request URL | _required_ Field |
|method | Request Method| POST | |method | Request Method| POST |
|contentType | Request ContentType| application/json | |contentType | Request ContentType| application/json |
|data | Request Body Content as JSON String, only for POST / PUT / PATCH Requests | '{}' | |data | Request Body Content as JSON String (or key=value pairs separated by '&' for form-urlencoded content), only for POST / PUT / PATCH Requests | '{}' |
|files | Map of key / absolute file paths send as multipart/form-data request to the API, if set the contentType is set to multipart/form-data, values provided by data will be added as additional FormData values, nested objects are not supported. **Example provided in the _test_ Workflow of this Action** | '{}' | |files | Map of key / absolute file paths send as multipart/form-data request to the API, if set the contentType is set to multipart/form-data, values provided by data will be added as additional FormData values, nested objects are not supported. **Example provided in the _test_ Workflow of this Action** | '{}' |
|timeout| Request Timeout in ms | 5000 (5s) | |timeout| Request Timeout in ms | 5000 (5s) |
|username| Username for Basic Auth || |username| Username for Basic Auth ||
@ -60,4 +60,4 @@ Additional information is available if debug logging is enabled:
- Instance Configuration (Url / Timeout / Headers) - Instance Configuration (Url / Timeout / Headers)
- Request Data (Body / Auth / Method) - Request Data (Body / Auth / Method)
To [enable debug logging in GitHub Actions](https://docs.github.com/en/actions/managing-workflow-runs/enabling-debug-logging) create a secret `ACTIONS_RUNNER_DEBUG` with a value of `true` To [enable debug logging in GitHub Actions](https://docs.github.com/en/actions/managing-workflow-runs/enabling-debug-logging) create a secret `ACTIONS_RUNNER_DEBUG` with a value of `true`