-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
25 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,36 @@ | ||
::: danger UNFINISHED | ||
This documentation is unfinished. | ||
::: | ||
|
||
# Automated Downloads | ||
|
||
Automated Downloads. | ||
Automated Downloads send HTTP requests and download the hosts' responses to file. | ||
|
||
All sources are downloaded in sequence by using the `FETCH` mode. | ||
|
||
## Syntax | ||
|
||
::: info Keys | ||
- `name`: string | ||
- The name of the source for informational purposes. | ||
- `url`: string | ||
- The URL for the request. | ||
- `type`: string | ||
- Must be `GET` or `POST`. | ||
- `headers`: {\[string]: string} | ||
- The headers for the request. | ||
- `postData`: (string | Object) | ||
- The data to submit in `POST` requests. | ||
- `path`: string | ||
- The path to save the downloaded file. | ||
::: | ||
|
||
## Example | ||
|
||
```json | ||
"sources": [ | ||
{ | ||
"name": "Economy", | ||
"url": "https://docs.google.com/spreadsheets/d/(redacted)/export?format=xlsx", | ||
"type": "GET", | ||
"headers": {}, | ||
"path": "Economy.xlsx" | ||
} | ||
] | ||
``` |