Skip to content

Commit

Permalink
Add automated-downloads.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hoontee committed Dec 12, 2023
1 parent 4f0d449 commit db2dc35
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/lync/getting-started/convert-place.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@
::: danger UNAVAILABLE
The `LYNC INIT` wizard is not yet available.

Please refer to the **Sample Project** inside the [Lync repo](https://github.com/Iron-Stag-Games/Lync).
Please refer to the [Sample Project](https://github.com/Iron-Stag-Games/Lync/tree/main/Sample%20Project) inside the [Lync repo](https://github.com/Iron-Stag-Games/Lync).
:::
2 changes: 1 addition & 1 deletion docs/lync/getting-started/new-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@
::: danger UNAVAILABLE
The `LYNC INIT` wizard is not yet available.

Please refer to the **Sample Project** inside the [Lync repo](https://github.com/Iron-Stag-Games/Lync).
Please refer to the [Sample Project](https://github.com/Iron-Stag-Games/Lync/tree/main/Sample%20Project) inside the [Lync repo](https://github.com/Iron-Stag-Games/Lync).
:::
28 changes: 23 additions & 5 deletions docs/lync/project-format/project/automated-downloads.md
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"
}
]
```

0 comments on commit db2dc35

Please sign in to comment.