Type (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/core/type
Definition name: type

Property name: Type
Description: The name of the type of an entry.
Type: string

Requirements/Conventions:

Examples:

Formats: [JSON] [MD]

JSON definition:

{
    "$id": "https://schemas.optimade.org/defs/v1.2/properties/core/type",
    "$schema": "https://schemas.optimade.org/meta/v1.2/optimade/property_definition.json",
    "title": "Type",
    "x-optimade-type": "string",
    "x-optimade-definition": {
        "label": "type_core",
        "kind": "property",
        "version": "1.2.0",
        "format": "1.2",
        "name": "type"
    },
    "type": [
        "string"
    ],
    "description": "The name of the type of an entry.\n\n**Requirements/Conventions:**\n\n- MUST be an existing entry type.\n- The entry of type <type> and ID <id> MUST be returned in response to a request for /<type>/<id> under the versioned or unversioned base URL serving the API.",
    "examples": [
        "structures"
    ],
    "x-optimade-unit": "inapplicable"
}