addonscript-spec/docs/schema/api_file.md

34 lines
758 B
Markdown
Raw Normal View History

2022-08-31 14:40:32 +02:00
# API File Object
```json
{
2023-10-11 14:40:50 +02:00
"src": ["https://example.com/file.jar"],
2022-08-31 14:40:32 +02:00
"hashes": {
"sha1": "somesha1checksum"
},
"meta": {
"additional": {}
}
}
```
## Required properties
2023-10-11 14:40:50 +02:00
### src
2022-08-31 14:40:32 +02:00
This is an array of [links](../concepts/links.md), which are pointing to the actual file. These MUST be a http(s) links.
All of these links MUST have the same file type.
2022-08-31 14:40:32 +02:00
## Optional properties
### hashes
This is an object with checksums for this file. The object contains key-value-pairs where the key is the hash algorithm and the
value is the checksum.
Supported hash algorithms:
- `sha1`
### meta
This is a [meta object](meta.md) containing metadata about the file. it SHOULD only contain [additional metadata](meta.md#additional).