|
2 | 2 | "openapi": "3.0.2",
|
3 | 3 | "info": {
|
4 | 4 | "title": "OPTIMADE API - Index meta-database",
|
5 |
| - "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/v0.23.1) v0.23.1.", |
| 5 | + "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/v0.24.0) v0.24.0.", |
6 | 6 | "version": "1.1.0"
|
7 | 7 | },
|
8 | 8 | "paths": {
|
|
505 | 505 | "title": "Id",
|
506 | 506 | "type": "string",
|
507 | 507 | "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\"`",
|
508 |
| - "x-optimade-support": "must", |
509 |
| - "x-optimade-queryable": "must" |
| 508 | + "x-optimade-queryable": "must", |
| 509 | + "x-optimade-support": "must" |
510 | 510 | },
|
511 | 511 | "type": {
|
512 | 512 | "title": "Type",
|
513 | 513 | "type": "string",
|
514 | 514 | "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\"`",
|
515 |
| - "x-optimade-support": "must", |
516 |
| - "x-optimade-queryable": "must" |
| 515 | + "x-optimade-queryable": "must", |
| 516 | + "x-optimade-support": "must" |
517 | 517 | },
|
518 | 518 | "links": {
|
519 | 519 | "title": "Links",
|
|
565 | 565 | "title": "Immutable Id",
|
566 | 566 | "type": "string",
|
567 | 567 | "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.)",
|
568 |
| - "x-optimade-support": "optional", |
569 |
| - "x-optimade-queryable": "must" |
| 568 | + "x-optimade-queryable": "must", |
| 569 | + "x-optimade-support": "optional" |
570 | 570 | },
|
571 | 571 | "last_modified": {
|
572 | 572 | "title": "Last Modified",
|
573 | 573 | "type": "string",
|
574 | 574 | "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.)",
|
575 | 575 | "format": "date-time",
|
576 |
| - "x-optimade-support": "should", |
577 |
| - "x-optimade-queryable": "must" |
| 576 | + "x-optimade-queryable": "must", |
| 577 | + "x-optimade-support": "should" |
578 | 578 | }
|
579 | 579 | },
|
580 | 580 | "description": "Contains key-value pairs representing the entry's properties."
|
|
1114 | 1114 | "title": "Id",
|
1115 | 1115 | "type": "string",
|
1116 | 1116 | "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\"`",
|
1117 |
| - "x-optimade-support": "must", |
1118 |
| - "x-optimade-queryable": "must" |
| 1117 | + "x-optimade-queryable": "must", |
| 1118 | + "x-optimade-support": "must" |
1119 | 1119 | },
|
1120 | 1120 | "type": {
|
1121 | 1121 | "title": "Type",
|
|
0 commit comments