mirror of
https://github.com/directus/directus.git
synced 2026-02-14 12:34:56 -05:00
147 lines
4.5 KiB
YAML
147 lines
4.5 KiB
YAML
type: object
|
|
properties:
|
|
charset:
|
|
description: Character set of the file.
|
|
example: binary
|
|
type: string
|
|
nullable: true # Should not be null?
|
|
checksum:
|
|
description: Represents the sum of the correct digits of the file, can be used
|
|
to detect errors in and duplicates of the file later.
|
|
example: d41d8cd98f00b204e9800998ecf8427e
|
|
type: string
|
|
data:
|
|
example:
|
|
embed: null
|
|
full_url: 'https://demo.directus.io/uploads/thumper/originals/a88c3b72-ac58-5436-a4ec-b2858531333a.jpg'
|
|
thumbnails:
|
|
dimension: 64x64
|
|
height: 64
|
|
relative_url: '/thumper/assets/pnw7s9lqy68048g0?key=directus-small-crop'
|
|
url: 'https://demo.directus.io/thumper/assets/pnw7s9lqy68048g0?key=directus-small-crop'
|
|
width: 64
|
|
url: '/uploads/thumper/originals/a88c3b72-ac58-5436-a4ec-b2858531333a.jpg'
|
|
properties:
|
|
full_url:
|
|
description: Full URL to the original file.
|
|
type: string
|
|
thumbnails:
|
|
description: List of all available asset sizes with links.
|
|
type: array
|
|
nullable: true
|
|
items:
|
|
type: object
|
|
properties:
|
|
dimension:
|
|
description: Width x height of the thumbnail.
|
|
type: string
|
|
height:
|
|
description: Height of the thumbnail in pixels.
|
|
type: integer
|
|
relative_url:
|
|
description: Relative URL to the thumbnail.
|
|
type: string
|
|
url:
|
|
description: Full URL to the thumbnail.
|
|
type: string
|
|
width:
|
|
description: Width of the thumbnail in pixels.
|
|
type: integer
|
|
url:
|
|
description: Relative URL to the original file.
|
|
type: string
|
|
type: object
|
|
description:
|
|
description: Description for the file.
|
|
example: ''
|
|
type: string
|
|
nullable: true
|
|
duration:
|
|
description: Duration of the file in seconds. Only applies to audio and video.
|
|
example: 0
|
|
type: integer
|
|
nullable: true
|
|
embed:
|
|
description: Where the file was embedded from.
|
|
example: null
|
|
type: string
|
|
nullable: true
|
|
filename_disk:
|
|
description: Name of the file on disk. By default, Directus uses a random hash
|
|
for the filename.
|
|
example: a88c3b72-ac58-5436-a4ec-b2858531333a.jpg
|
|
type: string
|
|
filename_download:
|
|
description: How you want to the file to be named when it's being downloaded.
|
|
example: avatar.jpg
|
|
type: string
|
|
filesize:
|
|
description: Size of the file in bytes.
|
|
example: 137862
|
|
type: integer
|
|
folder:
|
|
description: Virtual folder where this file resides in.
|
|
example: null
|
|
$ref: '../openapi.yaml#/components/schemas/Folder'
|
|
nullable: true
|
|
height:
|
|
description: Height of the file in pixels. Only applies to images.
|
|
example: 838
|
|
type: integer
|
|
nullable: true
|
|
id:
|
|
description: Unique identifier for the file.
|
|
example: 8cbb43fe-4cdf-4991-8352-c461779cec02
|
|
type: string
|
|
location:
|
|
description: Where the file was created. Is automatically populated based on EXIF
|
|
data for images.
|
|
type: string
|
|
nullable: true
|
|
metadata:
|
|
description: User provided miscellaneous key value pairs that serve as additional
|
|
metadata for the file.
|
|
example: null
|
|
type: object
|
|
nullable: true
|
|
private_hash:
|
|
description: Random hash used to access the file privately. This can be rotated
|
|
to prevent unauthorized access to the file.
|
|
example: pnw7s9lqy68048g0
|
|
type: string
|
|
storage:
|
|
description: Where the file is stored. Either `local` for the local filesystem
|
|
or the name of the storage adapter (for example `s3`).
|
|
example: local
|
|
type: string
|
|
tags:
|
|
description: Tags for the file. Is automatically populated based on EXIF data
|
|
for images.
|
|
type: array
|
|
nullable: true
|
|
items:
|
|
type: string
|
|
title:
|
|
description: Title for the file. Is extracted from the filename on upload, but
|
|
can be edited by the user.
|
|
example: User Avatar
|
|
type: string
|
|
type:
|
|
description: MIME type of the file.
|
|
example: image/jpeg
|
|
type: string
|
|
uploaded_by:
|
|
description: Who uploaded the file.
|
|
example: 63716273-0f29-4648-8a2a-2af2948f6f78
|
|
type: string
|
|
# $ref: '../openapi.yaml#/components/schemas/User'
|
|
uploaded_on:
|
|
description: When the file was uploaded.
|
|
example: '2019-12-03T00:10:15+00:00'
|
|
type: string
|
|
format: date-time
|
|
width:
|
|
description: Width of the file in pixels. Only applies to images.
|
|
example: 800
|
|
type: integer
|
|
nullable: true |