Description (property)

This page documents an OPTIMADE Property Definition. See https://schemas.optimade.org/ for more information.

ID: https://schemas.optimade.org/defs/v1.2/properties/optimade/files/description
Definition name: description

Property name: Description
Description: Free-form description of a file.
Type: string

Examples:

Formats: [JSON] [MD]

JSON definition:

{
    "$id": "https://schemas.optimade.org/defs/v1.2/properties/optimade/files/description",
    "$schema": "https://schemas.optimade.org/meta/v1.2/optimade/property_definition.json",
    "title": "Description",
    "x-optimade-type": "string",
    "x-optimade-definition": {
        "label": "description_optimade_files",
        "kind": "property",
        "version": "1.2.0",
        "format": "1.2",
        "name": "description"
    },
    "type": [
        "string",
        "null"
    ],
    "description": "Free-form description of a file.",
    "examples": [
        "POSCAR format file"
    ],
    "x-optimade-unit": "inapplicable"
}