Name (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/name
Definition name: name

Property name: Name
Description: Base name of a file.
Type: string
Implementation requirements:
- Support: MUST be supported by all implementations, MUST NOT be null.

Requirements/Conventions:

Examples:

Formats: [JSON] [MD]

JSON definition:

{
    "$id": "https://schemas.optimade.org/defs/v1.2/properties/optimade/files/name",
    "$schema": "https://schemas.optimade.org/meta/v1.2/optimade/property_definition.json",
    "title": "Name",
    "x-optimade-type": "string",
    "x-optimade-definition": {
        "label": "name_optimade_files",
        "kind": "property",
        "version": "1.2.0",
        "format": "1.2",
        "name": "name"
    },
    "type": [
        "string"
    ],
    "description": "Base name of a file.\n\n**Requirements/Conventions:**\n\n- File name extension is an integral part of a file name and, if available, MUST be included.",
    "examples": [
        "1000000.cif"
    ],
    "x-optimade-unit": "inapplicable",
    "x-optimade-requirements": {
        "support": "must",
        "sortable": false,
        "query-support": "none"
    }
}