{

"openapi": "3.1.0",

"info": {

"title": "OPTIMADE API - Index meta-database",

"description": "The [Open Databases Integration for Materials Design (OPTIMADE) consortium](https://www.optimade.org/) aims to make materials databases interoperational by developing a common REST API.\nThis is the \"special\" index meta-database.\n\nThis specification is generated using [`optimade-python-tools`](https://github.com/Materials-Consortia/optimade-python-tools/tree/v1.4.1) v1.4.1.",

"version": "1.2.0"

},

"paths": {

"/info": {

"get": {

"tags": [

"Info"

],

"summary": "Get Info",

"operationId": "get_info_info_get",

"responses": {

"200": {

"description": "Successful Response",

"content": {

"application/vnd.api+json": {

"schema": {

"$ref": "#/components/schemas/IndexInfoResponse"

}

}

}

},

"400": {

"description": "Bad Request",

"content": {

"application/vnd.api+json": {

"schema": {

"$ref": "#/components/schemas/ErrorResponse"

}

}

}

},

"403": {

"description": "Forbidden",

"content": {

"application/vnd.api+json": {

"schema": {

"$ref": "#/components/schemas/ErrorResponse"

}

}

}

},

"404": {

"description": "Not Found",

"content": {

"application/vnd.api+json": {

"schema": {

"$ref": "#/components/schemas/ErrorResponse"

}

}

}

},

"422": {

"description": "Unprocessable Entity",

"content": {

"application/vnd.api+json": {

"schema": {

"$ref": "#/components/schemas/ErrorResponse"

}

}

}

},

"500": {

"description": "Internal Server Error",

"content": {

"application/vnd.api+json": {

"schema": {

"$ref": "#/components/schemas/ErrorResponse"

}

}

}

},

"501": {

"description": "Not Implemented",

"content": {

"application/vnd.api+json": {

"schema": {

"$ref": "#/components/schemas/ErrorResponse"

}

}

}

},

"553": {

"description": "Version Not Supported",

"content": {

"application/vnd.api+json": {

"schema": {

"$ref": "#/components/schemas/ErrorResponse"

}

}

}

}

}

}

},

"/links": {

"get": {

"tags": [

"Links"

],

"summary": "Get Links",

"operationId": "get_links_links_get",

"parameters": [

{

"name": "filter",

"in": "query",

"required": false,

"schema": {

"type": "string",

"description": "A filter string, in the format described in section API Filtering Format Specification of the specification.",

"default": "",

"title": "Filter"

},

"description": "A filter string, in the format described in section API Filtering Format Specification of the specification."

},

{

"name": "response_format",

"in": "query",

"required": false,

"schema": {

"type": "string",

"description": "The output format requested (see section Response Format).\nDefaults to the format string 'json', which specifies the standard output format described in this specification.\nExample: `http://example.com/v1/structures?response_format=xml`",

"default": "json",

"title": "Response Format"

},

"description": "The output format requested (see section Response Format).\nDefaults to the format string 'json', which specifies the standard output format described in this specification.\nExample: `http://example.com/v1/structures?response_format=xml`"

},

{

"name": "email_address",

"in": "query",

"required": false,

"schema": {

"anyOf": [

{

"type": "string",

"format": "email"

},

{

"type": "null"

}

],

"description": "An email address of the user making the request.\nThe email SHOULD be that of a person and not an automatic system.\nExample: `http://example.com/v1/structures?email_address=user@example.com`",

"title": "Email Address"

},

"description": "An email address of the user making the request.\nThe email SHOULD be that of a person and not an automatic system.\nExample: `http://example.com/v1/structures?email_address=user@example.com`"

},

{

"name": "response_fields",

"in": "query",

"required": false,

"schema": {

"type": "string",

"pattern": "([a-z_][a-z_0-9]*(,[a-z_][a-z_0-9]*)*)?",

"description": "A comma-delimited set of fields to be provided in the output.\nIf provided, these fields MUST be returned along with the REQUIRED fields.\nOther OPTIONAL fields MUST NOT be returned when this parameter is present.\nExample: `http://example.com/v1/structures?response_fields=last_modified,nsites`",

"default": "",

"title": "Response Fields"

},

"description": "A comma-delimited set of fields to be provided in the output.\nIf provided, these fields MUST be returned along with the REQUIRED fields.\nOther OPTIONAL fields MUST NOT be returned when this parameter is present.\nExample: `http://example.com/v1/structures?response_fields=last_modified,nsites`"

},

{

"name": "sort",

"in": "query",

"required": false,

"schema": {

"type": "string",

"pattern": "([a-z_][a-z_0-9]*(,[a-z_][a-z_0-9]*)*)?",

"description": "If supporting sortable queries, an implementation MUST use the `sort` query parameter with format as specified by [JSON API 1.0](https://jsonapi.org/format/1.0/#fetching-sorting).\n\nAn implementation MAY support multiple sort fields for a single query.\nIf it does, it again MUST conform to the JSON API 1.0 specification.\n\nIf an implementation supports sorting for an entry listing endpoint, then the `/info/<entries>` endpoint MUST include, for each field name `<fieldname>` in its `data.properties.<fieldname>` response value that can be used for sorting, the key `sortable` with value `true`.\nIf a field name under an entry listing endpoint supporting sorting cannot be used for sorting, the server MUST either leave out the `sortable` key or set it equal to `false` for the specific field name.\nThe set of field names, with `sortable` equal to `true` are allowed to be used in the \"sort fields\" list according to its definition in the JSON API 1.0 specification.\nThe field `sortable` is in addition to each property description and other OPTIONAL fields.\nAn example is shown in the section Entry Listing Info Endpoints.",

"default": "",

"title": "Sort"

},

"description": "If supporting sortable queries, an implementation MUST use the `sort` query parameter with format as specified by [JSON API 1.0](https://jsonapi.org/format/1.0/#fetching-sorting).\n\nAn implementation MAY support multiple sort fields for a single query.\nIf it does, it again MUST conform to the JSON API 1.0 specification.\n\nIf an implementation supports sorting for an entry listing endpoint, then the `/info/<entries>` endpoint MUST include, for each field name `<fieldname>` in its `data.properties.<fieldname>` response value that can be used for sorting, the key `sortable` with value `true`.\nIf a field name under an entry listing endpoint supporting sorting cannot be used for sorting, the server MUST either leave out the `sortable` key or set it equal to `false` for the specific field name.\nThe set of field names, with `sortable` equal to `true` are allowed to be used in the \"sort fields\" list according to its definition in the JSON API 1.0 specification.\nThe field `sortable` is in addition to each property description and other OPTIONAL fields.\nAn example is shown in the section Entry Listing Info Endpoints."

},

{

"name": "page_limit",

"in": "query",

"required": false,

"schema": {

"type": "integer",

"minimum": 0,

"description": "Sets a numerical limit on the number of entries returned.\nSee [JSON API 1.0](https://jsonapi.org/format/1.0/#fetching-pagination).\nThe API implementation MUST return no more than the number specified.\nIt MAY return fewer.\nThe database MAY have a maximum limit and not accept larger numbers (in which case an error code -- 403 Forbidden -- MUST be returned).\nThe default limit value is up to the API implementation to decide.\nExample: `http://example.com/optimade/v1/structures?page_limit=100`",

"default": 20,

"title": "Page Limit"

},

"description": "Sets a numerical limit on the number of entries returned.\nSee [JSON API 1.0](https://jsonapi.org/format/1.0/#fetching-pagination).\nThe API implementation MUST return no more than the number specified.\nIt MAY return fewer.\nThe database MAY have a maximum limit and not accept larger numbers (in which case an error code -- 403 Forbidden -- MUST be returned).\nThe default limit value is up to the API implementation to decide.\nExample: `http://example.com/optimade/v1/structures?page_limit=100`"

},

{

"name": "page_offset",

"in": "query",

"required": false,

"schema": {

"type": "integer",

"minimum": 0,

"description": "RECOMMENDED for use with _offset-based_ pagination: using `page_offset` and `page_limit` is RECOMMENDED.\nExample: Skip 50 structures and fetch up to 100: `/structures?page_offset=50&page_limit=100`.",

"default": 0,

"title": "Page Offset"

},

"description": "RECOMMENDED for use with _offset-based_ pagination: using `page_offset` and `page_limit` is RECOMMENDED.\nExample: Skip 50 structures and fetch up to 100: `/structures?page_offset=50&page_limit=100`."

},

{

"name": "page_number",

"in": "query",

"required": false,

"schema": {

"type": "integer",

"description": "RECOMMENDED for use with _page-based_ pagination: using `page_number` and `page_limit` is RECOMMENDED.\nIt is RECOMMENDED that the first page has number 1, i.e., that `page_number` is 1-based.\nExample: Fetch page 2 of up to 50 structures per page: `/structures?page_number=2&page_limit=50`.",

"title": "Page Number"

},

"description": "RECOMMENDED for use with _page-based_ pagination: using `page_number` and `page_limit` is RECOMMENDED.\nIt is RECOMMENDED that the first page has number 1, i.e., that `page_number` is 1-based.\nExample: Fetch page 2 of up to 50 structures per page: `/structures?page_number=2&page_limit=50`."

},

{

"name": "page_cursor",

"in": "query",

"required": false,

"schema": {

"type": "integer",

"minimum": 0,

"description": "RECOMMENDED for use with _cursor-based_ pagination: using `page_cursor` and `page_limit` is RECOMMENDED.",

"default": 0,

"title": "Page Cursor"

},

"description": "RECOMMENDED for use with _cursor-based_ pagination: using `page_cursor` and `page_limit` is RECOMMENDED."

},

{

"name": "page_above",

"in": "query",

"required": false,

"schema": {

"type": "string",

"description": "RECOMMENDED for use with _value-based_ pagination: using `page_above`/`page_below` and `page_limit` is RECOMMENDED.\nExample: Fetch up to 100 structures above sort-field value 4000 (in this example, server chooses to fetch results sorted by increasing `id`, so `page_above` value refers to an `id` value): `/structures?page_above=4000&page_limit=100`.",

"title": "Page Above"

},

"description": "RECOMMENDED for use with _value-based_ pagination: using `page_above`/`page_below` and `page_limit` is RECOMMENDED.\nExample: Fetch up to 100 structures above sort-field value 4000 (in this example, server chooses to fetch results sorted by increasing `id`, so `page_above` value refers to an `id` value): `/structures?page_above=4000&page_limit=100`."

},

{

"name": "page_below",

"in": "query",

"required": false,

"schema": {

"type": "string",

"description": "RECOMMENDED for use with _value-based_ pagination: using `page_above`/`page_below` and `page_limit` is RECOMMENDED.",

"title": "Page Below"

},

"description": "RECOMMENDED for use with _value-based_ pagination: using `page_above`/`page_below` and `page_limit` is RECOMMENDED."

},

{

"name": "include",

"in": "query",

"required": false,

"schema": {

"type": "string",

"description": "A server MAY implement the JSON API concept of returning [compound documents](https://jsonapi.org/format/1.0/#document-compound-documents) by utilizing the `include` query parameter as specified by [JSON API 1.0](https://jsonapi.org/format/1.0/#fetching-includes).\n\nAll related resource objects MUST be returned as part of an array value for the top-level `included` field, see the section JSON Response Schema: Common Fields.\n\nThe value of `include` MUST be a comma-separated list of \"relationship paths\", as defined in the [JSON API](https://jsonapi.org/format/1.0/#fetching-includes).\nIf relationship paths are not supported, or a server is unable to identify a relationship path a `400 Bad Request` response MUST be made.\n\nThe **default value** for `include` is `references`.\nThis means `references` entries MUST always be included under the top-level field `included` as default, since a server assumes if `include` is not specified by a client in the request, it is still specified as `include=references`.\nNote, if a client explicitly specifies `include` and leaves out `references`, `references` resource objects MUST NOT be included under the top-level field `included`, as per the definition of `included`, see section JSON Response Schema: Common Fields.\n\n> **Note**: A query with the parameter `include` set to the empty string means no related resource objects are to be returned under the top-level field `included`.",

"default": "references",

"title": "Include"

},

"description": "A server MAY implement the JSON API concept of returning [compound documents](https://jsonapi.org/format/1.0/#document-compound-documents) by utilizing the `include` query parameter as specified by [JSON API 1.0](https://jsonapi.org/format/1.0/#fetching-includes).\n\nAll related resource objects MUST be returned as part of an array value for the top-level `included` field, see the section JSON Response Schema: Common Fields.\n\nThe value of `include` MUST be a comma-separated list of \"relationship paths\", as defined in the [JSON API](https://jsonapi.org/format/1.0/#fetching-includes).\nIf relationship paths are not supported, or a server is unable to identify a relationship path a `400 Bad Request` response MUST be made.\n\nThe **default value** for `include` is `references`.\nThis means `references` entries MUST always be included under the top-level field `included` as default, since a server assumes if `include` is not specified by a client in the request, it is still specified as `include=references`.\nNote, if a client explicitly specifies `include` and leaves out `references`, `references` resource objects MUST NOT be included under the top-level field `included`, as per the definition of `included`, see section JSON Response Schema: Common Fields.\n\n> **Note**: A query with the parameter `include` set to the empty string means no related resource objects are to be returned under the top-level field `included`."

},

{

"name": "api_hint",

"in": "query",

"required": false,

"schema": {

"type": "string",

"pattern": "(v[0-9]+(\\.[0-9]+)?)?",

"description": "If the client provides the parameter, the value SHOULD have the format `vMAJOR` or `vMAJOR.MINOR`, where MAJOR is a major version and MINOR is a minor version of the API. For example, if a client appends `api_hint=v1.0` to the query string, the hint provided is for major version 1 and minor version 0.",

"default": "",

"title": "Api Hint"

},

"description": "If the client provides the parameter, the value SHOULD have the format `vMAJOR` or `vMAJOR.MINOR`, where MAJOR is a major version and MINOR is a minor version of the API. For example, if a client appends `api_hint=v1.0` to the query string, the hint provided is for major version 1 and minor version 0."

}

],

"responses": {

"200": {

"description": "Successful Response",

"content": {

"application/vnd.api+json": {

"schema": {

"$ref": "#/components/schemas/LinksResponse"

}

}

}

},

"400": {

"description": "Bad Request",

"content": {

"application/vnd.api+json": {

"schema": {

"$ref": "#/components/schemas/ErrorResponse"

}

}

}

},

"403": {

"description": "Forbidden",

"content": {

"application/vnd.api+json": {

"schema": {

"$ref": "#/components/schemas/ErrorResponse"

}

}

}

},

"404": {

"description": "Not Found",

"content": {

"application/vnd.api+json": {

"schema": {

"$ref": "#/components/schemas/ErrorResponse"

}

}

}

},

"422": {

"description": "Unprocessable Entity",

"content": {

"application/vnd.api+json": {

"schema": {

"$ref": "#/components/schemas/ErrorResponse"

}

}

}

},

"500": {

"description": "Internal Server Error",

"content": {

"application/vnd.api+json": {

"schema": {

"$ref": "#/components/schemas/ErrorResponse"

}

}

}

},

"501": {

"description": "Not Implemented",

"content": {

"application/vnd.api+json": {

"schema": {

"$ref": "#/components/schemas/ErrorResponse"

}

}

}

},

"553": {

"description": "Version Not Supported",

"content": {

"application/vnd.api+json": {

"schema": {

"$ref": "#/components/schemas/ErrorResponse"

}

}

}

}

}

}

},

"/versions": {

"get": {

"tags": [

"Versions"

],

"summary": "Get Versions",

"description": "Respond with the text/csv representation for the served versions.",

"operationId": "get_versions_versions_get",

"responses": {

"200": {

"description": "Successful Response",

"content": {

"text/csv; header=present": {

"schema": {

"type": "string"

}

}

}

}

}

}

}

},

"components": {

"schemas": {

"Aggregate": {

"type": "string",

"enum": [

"ok",

"test",

"staging",

"no"

],

"title": "Aggregate",

"description": "Enumeration of aggregate values"

},

"Attributes": {

"properties": {},

"additionalProperties": true,

"type": "object",

"title": "Attributes",

"description": "Members of the attributes object (\"attributes\") represent information about the resource object in which it's defined.\nThe keys for Attributes MUST NOT be:\n relationships\n links\n id\n type"

},

"AvailableApiVersion": {

"properties": {

"url": {

"type": "string",

"minLength": 1,

"pattern": "^.+/v[0-1](\\.[0-9]+)*/?$",

"format": "uri",

"title": "Url",

"description": "A string specifying a versioned base URL that MUST adhere to the rules in section Base URL"

},

"version": {

"type": "string",

"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$",

"title": "Version",

"description": "A string containing the full version number of the API served at that versioned base URL.\nThe version number string MUST NOT be prefixed by, e.g., 'v'.\nExamples: `1.0.0`, `1.0.0-rc.2`.",

"examples": [

"0.10.1",

"1.0.0-rc.2",

"1.2.3-rc.5+develop"

]

}

},

"type": "object",

"required": [

"url",

"version"

],

"title": "AvailableApiVersion",

"description": "A JSON object containing information about an available API version"

},

"BaseRelationshipMeta": {

"properties": {

"description": {

"type": "string",

"title": "Description",

"description": "OPTIONAL human-readable description of the relationship."

}

},

"additionalProperties": true,

"type": "object",

"required": [

"description"

],

"title": "BaseRelationshipMeta",

"description": "Specific meta field for base relationship resource"

},

"BaseRelationshipResource": {

"properties": {

"id": {

"type": "string",

"title": "Id",

"description": "Resource ID"

},

"type": {

"type": "string",

"title": "Type",

"description": "Resource type"

},

"meta": {

"anyOf": [

{

"$ref": "#/components/schemas/BaseRelationshipMeta"

},

{

"type": "null"

}

],

"description": "Relationship meta field. MUST contain 'description' if supplied."

}

},

"type": "object",

"required": [

"id",

"type"

],

"title": "BaseRelationshipResource",

"description": "Minimum requirements to represent a relationship resource"

},

"EntryRelationships": {

"properties": {

"references": {

"anyOf": [

{

"$ref": "#/components/schemas/ReferenceRelationship"

},

{

"type": "null"

}

],

"description": "Object containing links to relationships with entries of the `references` type."

},

"structures": {

"anyOf": [

{

"$ref": "#/components/schemas/StructureRelationship"

},

{

"type": "null"

}

],

"description": "Object containing links to relationships with entries of the `structures` type."

}

},

"type": "object",

"title": "EntryRelationships",

"description": "This model wraps the JSON API Relationships to include type-specific top level keys."

},

"EntryResource": {

"properties": {

"id": {

"type": "string",

"title": "Id",

"description": "An entry's ID as defined in section Definition of Terms.\n\n- **Type**: string.\n\n- **Requirements/Conventions**:\n - **Support**: MUST be supported by all implementations, MUST NOT be `null`.\n - **Query**: MUST be a queryable property with support for all mandatory filter features.\n - **Response**: REQUIRED in the response.\n\n- **Examples**:\n - `\"db/1234567\"`\n - `\"cod/2000000\"`\n - `\"cod/2000000@1234567\"`\n - `\"nomad/L1234567890\"`\n - `\"42\"`",

"x-optimade-queryable": "must",

"x-optimade-support": "must"

},

"type": {

"type": "string",

"title": "Type",

"description": "The name of the type of an entry.\n\n- **Type**: string.\n\n- **Requirements/Conventions**:\n - **Support**: MUST be supported by all implementations, MUST NOT be `null`.\n - **Query**: MUST be a queryable property with support for all mandatory filter features.\n - **Response**: REQUIRED in the response.\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 base URL.\n\n- **Example**: `\"structures\"`",

"x-optimade-queryable": "must",

"x-optimade-support": "must"

},

"links": {

"anyOf": [

{

"$ref": "#/components/schemas/ResourceLinks"

},

{

"type": "null"

}

],

"description": "a links object containing links related to the resource."

},

"meta": {

"anyOf": [

{

"$ref": "#/components/schemas/Meta"

},

{

"type": "null"

}

],

"description": "a meta object containing non-standard meta-information about a resource that can not be represented as an attribute or relationship."

},

"attributes": {

"$ref": "#/components/schemas/EntryResourceAttributes",

"description": "A dictionary, containing key-value pairs representing the entry's properties, except for `type` and `id`.\nDatabase-provider-specific properties need to include the database-provider-specific prefix (see section on Database-Provider-Specific Namespace Prefixes)."

},

"relationships": {

"anyOf": [

{

"$ref": "#/components/schemas/EntryRelationships"

},

{

"type": "null"

}

],

"description": "A dictionary containing references to other entries according to the description in section Relationships encoded as [JSON API Relationships](https://jsonapi.org/format/1.0/#document-resource-object-relationships).\nThe OPTIONAL human-readable description of the relationship MAY be provided in the `description` field inside the `meta` dictionary of the JSON API resource identifier object."

}

},

"type": "object",

"required": [

"id",

"type",

"attributes"

],

"title": "EntryResource",

"description": "The base model for an entry resource."

},

"EntryResourceAttributes": {

"properties": {

"immutable_id": {

"anyOf": [

{

"type": "string"

},

{

"type": "null"

}

],

"title": "Immutable Id",

"description": "The entry's immutable ID (e.g., an UUID). This is important for databases having preferred IDs that point to \"the latest version\" of a record, but still offer access to older variants. This ID maps to the version-specific record, in case it changes in the future.\n\n- **Type**: string.\n\n- **Requirements/Conventions**:\n - **Support**: OPTIONAL support in implementations, i.e., MAY be `null`.\n - **Query**: MUST be a queryable property with support for all mandatory filter features.\n\n- **Examples**:\n - `\"8bd3e750-b477-41a0-9b11-3a799f21b44f\"`\n - `\"fjeiwoj,54;@=%<>#32\"` (Strings that are not URL-safe are allowed.)",

"x-optimade-queryable": "must",

"x-optimade-support": "optional"

},

"last_modified": {

"anyOf": [

{

"type": "string",

"format": "date-time"

},

{

"type": "null"

}

],

"title": "Last Modified",

"description": "Date and time representing when the entry was last modified.\n\n- **Type**: timestamp.\n\n- **Requirements/Conventions**:\n - **Support**: SHOULD be supported by all implementations, i.e., SHOULD NOT be `null`.\n - **Query**: MUST be a queryable property with support for all mandatory filter features.\n - **Response**: REQUIRED in the response unless the query parameter `response_fields` is present and does not include this property.\n\n- **Example**:\n - As part of JSON response format: `\"2007-04-05T14:30:20Z\"` (i.e., encoded as an [RFC 3339 Internet Date/Time Format](https://tools.ietf.org/html/rfc3339#section-5.6) string.)",

"x-optimade-queryable": "must",

"x-optimade-support": "should"

}

},

"additionalProperties": true,

"type": "object",

"required": [

"last_modified"

],

"title": "EntryResourceAttributes",

"description": "Contains key-value pairs representing the entry's properties."

},

"Error": {

"properties": {

"id": {

"anyOf": [

{

"type": "string"

},

{

"type": "null"

}

],

"title": "Id",

"description": "A unique identifier for this particular occurrence of the problem."

},

"links": {

"anyOf": [

{

"$ref": "#/components/schemas/ErrorLinks"

},

{

"type": "null"

}

],

"description": "A links object storing about"

},

"status": {

"anyOf": [

{

"type": "string"

},

{

"type": "null"

}

],

"title": "Status",

"description": "the HTTP status code applicable to this problem, expressed as a string value."

},

"code": {

"anyOf": [

{

"type": "string"

},

{

"type": "null"

}

],

"title": "Code",

"description": "an application-specific error code, expressed as a string value."

},

"title": {

"anyOf": [

{

"type": "string"

},

{

"type": "null"

}

],

"title": "Title",

"description": "A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization."

},

"detail": {

"anyOf": [

{

"type": "string"

},

{

"type": "null"

}

],

"title": "Detail",

"description": "A human-readable explanation specific to this occurrence of the problem."

},

"source": {

"anyOf": [

{

"$ref": "#/components/schemas/ErrorSource"

},

{

"type": "null"

}

],

"description": "An object containing references to the source of the error"

},

"meta": {

"anyOf": [

{

"$ref": "#/components/schemas/Meta"

},

{

"type": "null"

}

],

"description": "a meta object containing non-standard meta-information about the error."

}

},

"type": "object",

"title": "Error",

"description": "An error response"

},

"ErrorLinks": {

"properties": {

"about": {

"anyOf": [

{

"type": "string",

"minLength": 1,

"format": "uri"

},

{

"$ref": "#/components/schemas/Link"

},

{

"type": "null"

}

],

"title": "About",

"description": "A link that leads to further details about this particular occurrence of the problem."

}

},

"type": "object",

"title": "ErrorLinks",

"description": "A Links object specific to Error objects"

},

"ErrorResponse": {

"properties": {

"data": {

"anyOf": [

{

"$ref": "#/components/schemas/Resource"

},

{

"items": {

"$ref": "#/components/schemas/Resource"

},

"type": "array"

},

{

"type": "null"

}

],

"uniqueItems": true,

"title": "Data",

"description": "Outputted Data"

},

"meta": {

"$ref": "#/components/schemas/ResponseMeta",

"description": "A meta object containing non-standard information."

},

"errors": {

"items": {

"$ref": "#/components/schemas/OptimadeError"

},

"type": "array",

"uniqueItems": true,

"title": "Errors",

"description": "A list of OPTIMADE-specific JSON API error objects, where the field detail MUST be present."

},

"included": {

"anyOf": [

{

"items": {

"$ref": "#/components/schemas/Resource"

},

"type": "array"

},

{

"type": "null"

}

],

"uniqueItems": true,

"title": "Included",

"description": "A list of unique included resources"

},

"links": {

"anyOf": [

{

"$ref": "#/components/schemas/ToplevelLinks"

},

{

"type": "null"

}

],

"description": "Links associated with the primary data or errors"

},

"jsonapi": {

"anyOf": [

{

"$ref": "#/components/schemas/JsonApi"

},

{

"type": "null"

}

],

"description": "Information about the JSON API used"

}

},

"type": "object",

"required": [

"meta",

"errors"

],

"title": "ErrorResponse",

"description": "errors MUST be present and data MUST be skipped"

},

"ErrorSource": {

"properties": {

"pointer": {

"anyOf": [

{

"type": "string"

},

{

"type": "null"

}

],

"title": "Pointer",

"description": "a JSON Pointer [RFC6901] to the associated entity in the request document [e.g. \"/data\" for a primary data object, or \"/data/attributes/title\" for a specific attribute]."

},

"parameter": {

"anyOf": [

{

"type": "string"

},

{

"type": "null"

}

],

"title": "Parameter",

"description": "a string indicating which URI query parameter caused the error."

}

},

"type": "object",

"title": "ErrorSource",

"description": "an object containing references to the source of the error"

},

"Implementation": {

"properties": {

"name": {

"anyOf": [

{

"type": "string"

},

{

"type": "null"

}

],

"title": "Name",

"description": "name of the implementation"

},

"version": {

"anyOf": [

{

"type": "string"

},

{

"type": "null"

}

],

"title": "Version",

"description": "version string of the current implementation"

},

"homepage": {

"anyOf": [

{

"type": "string",

"minLength": 1,

"format": "uri"

},

{

"$ref": "#/components/schemas/Link"

},

{

"type": "null"

}

],

"title": "Homepage",

"description": "A [JSON API links object](http://jsonapi.org/format/1.0/#document-links) pointing to the homepage of the implementation."

},

"source_url": {

"anyOf": [

{

"type": "string",

"minLength": 1,

"format": "uri"

},

{

"$ref": "#/components/schemas/Link"

},

{

"type": "null"

}

],

"title": "Source Url",

"description": "A [JSON API links object](http://jsonapi.org/format/1.0/#document-links) pointing to the implementation source, either downloadable archive or version control system."

},

"maintainer": {

"anyOf": [

{

"$ref": "#/components/schemas/ImplementationMaintainer"

},

{

"type": "null"

}

],

"description": "A dictionary providing details about the maintainer of the implementation."

},

"issue_tracker": {

"anyOf": [

{

"type": "string",

"minLength": 1,

"format": "uri"

},

{

"$ref": "#/components/schemas/Link"

},

{

"type": "null"

}

],

"title": "Issue Tracker",

"description": "A [JSON API links object](http://jsonapi.org/format/1.0/#document-links) pointing to the implementation's issue tracker."

}

},

"type": "object",

"title": "Implementation",

"description": "Information on the server implementation"

},

"ImplementationMaintainer": {

"properties": {

"email": {

"type": "string",

"format": "email",

"title": "Email",

"description": "the maintainer's email address"

}

},

"type": "object",

"required": [

"email"

],

"title": "ImplementationMaintainer",

"description": "Details about the maintainer of the implementation"

},

"IndexInfoAttributes": {

"properties": {

"api_version": {

"type": "string",

"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$",

"title": "Api Version",

"description": "Presently used full version of the OPTIMADE API.\nThe version number string MUST NOT be prefixed by, e.g., \"v\".\nExamples: `1.0.0`, `1.0.0-rc.2`.",

"examples": [

"0.10.1",

"1.0.0-rc.2",

"1.2.3-rc.5+develop"

]

},

"available_api_versions": {

"items": {

"$ref": "#/components/schemas/AvailableApiVersion"

},

"type": "array",

"title": "Available Api Versions",

"description": "A list of dictionaries of available API versions at other base URLs"

},

"formats": {

"items": {

"type": "string"

},

"type": "array",

"title": "Formats",

"description": "List of available output formats.",

"default": [

"json"

]

},

"available_endpoints": {

"items": {

"type": "string"

},

"type": "array",

"title": "Available Endpoints",

"description": "List of available endpoints (i.e., the string to be appended to the versioned base URL)."

},

"entry_types_by_format": {

"additionalProperties": {

"items": {

"type": "string"