vinvImage Schema
https://schema.vinv.io/image/0.0.1.json
A universal resource identifier (URI), according to RFC3986.
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | dereferenced.doc.json |
Image Type
object (Image)
Image Properties
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| uri | string | Required | cannot be null | Image |
| encoder | string | Optional | can be null | Image |
| compression | number | Optional | can be null | Image |
| width | integer | Optional | can be null | Image |
| height | integer | Optional | can be null | Image |
uri
A universal resource identifier (URI), according to RFC3986.
uri
uri Type
string (Image)
uri Constraints
URI: the string must be a URI, according to RFC 3986
uri Examples
"https://schema.vinv.io/asset/img/logo.png"
encoder
The encoder used to encode the image.
encoder
encoder Type
string (Encoder)
encoder Constraints
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"image/jpeg" | |
"image/webp" |
encoder Default Value
The default value is:
"image/webp"
encoder Examples
"image/webp"
"image/jpeg"
compression
The compression used to encode the image.
compression
is optional
Type:
number(Compression)can be null
defined in: Image
compression Type
number (Compression)
compression Constraints
maximum: the value of this number must smaller than or equal to: 1
minimum: the value of this number must greater than or equal to: 0
compression Default Value
The default value is:
1
compression Examples
0.8
width
Width of the image.
width
width Type
integer (Width)
width Constraints
maximum: the value of this number must smaller than or equal to: 10000
minimum: the value of this number must greater than or equal to: 25
width Examples
500
height
Height of the image
height
height Type
integer (Height)
height Constraints
maximum: the value of this number must smaller than or equal to: 10000
minimum: the value of this number must greater than or equal to: 25
height Examples
500