addonscript-spec/docs/schema/api_file.md
Timo Ley c304c62855
All checks were successful
continuous-integration/drone/pr Build is passing
Spec rephrasing to use requirement keywords
2022-09-05 16:54:36 +02:00

34 lines
No EOL
760 B
Markdown

# API File Object
```json
{
"link": ["https://example.com/file.jar"],
"hashes": {
"sha1": "somesha1checksum"
},
"meta": {
"additional": {}
}
}
```
## Required properties
### link
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.
## 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).