| 1 |
$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" |
| 2 |
$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/files/size" |
| 3 |
title: "size" |
| 4 |
x-optimade-type: "integer" |
| 5 |
x-optimade-definition: |
| 6 |
label: "size_optimade_files" |
| 7 |
kind: "property" |
| 8 |
version: "1.2.0" |
| 9 |
format: "1.2" |
| 10 |
name: "size" |
| 11 |
x-optimade-unit-definitions: |
| 12 |
- $$inherit: "/v1.2/units/iso-iec-80000/2008/information_science_and_technology/byte" |
| 13 |
type: |
| 14 |
- "integer" |
| 15 |
- "null" |
| 16 |
description: |- |
| 17 |
Size of a file in bytes. |
| 18 |
|
| 19 |
**Requirements/Conventions:** |
| 20 |
|
| 21 |
- If provided, it MUST be guaranteed that either exact size of a file is given or its upper bound. |
| 22 |
This way if a client reserves a static buffer or truncates the download stream after this many bytes the whole file would be received. |
| 23 |
Such provision is included to allow the providers to serve on-the-fly compressed files. |
| 24 |
examples: |
| 25 |
- 4711 |
| 26 |
x-optimade-unit: "byte" |