Skip to content

Commit 5304609

Browse files
committed
Merge branch 'add_files_endpoint' into v1.2_staging_arena
2 parents 32740b3 + 28d4a8b commit 5304609

File tree

19 files changed

+1633
-247
lines changed

19 files changed

+1633
-247
lines changed

docs/api_reference/models/files.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# files
2+
3+
::: optimade.models.files
4+
options:
5+
show_if_no_docstring: true
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# files
2+
3+
::: optimade.server.mappers.files
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# files
2+
3+
::: optimade.server.routers.files

openapi/index_openapi.json

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -509,15 +509,15 @@
509509
"title": "Id",
510510
"type": "string",
511511
"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\"`",
512-
"x-optimade-queryable": "must",
513-
"x-optimade-support": "must"
512+
"x-optimade-support": "must",
513+
"x-optimade-queryable": "must"
514514
},
515515
"type": {
516516
"title": "Type",
517517
"type": "string",
518518
"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\"`",
519-
"x-optimade-queryable": "must",
520-
"x-optimade-support": "must"
519+
"x-optimade-support": "must",
520+
"x-optimade-queryable": "must"
521521
},
522522
"links": {
523523
"title": "Links",
@@ -569,16 +569,16 @@
569569
"title": "Immutable Id",
570570
"type": "string",
571571
"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.)",
572-
"x-optimade-queryable": "must",
573-
"x-optimade-support": "optional"
572+
"x-optimade-support": "optional",
573+
"x-optimade-queryable": "must"
574574
},
575575
"last_modified": {
576576
"title": "Last Modified",
577577
"type": "string",
578578
"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.)",
579579
"format": "date-time",
580-
"x-optimade-queryable": "must",
581-
"x-optimade-support": "should"
580+
"x-optimade-support": "should",
581+
"x-optimade-queryable": "must"
582582
}
583583
},
584584
"description": "Contains key-value pairs representing the entry's properties."
@@ -1143,8 +1143,8 @@
11431143
"title": "Id",
11441144
"type": "string",
11451145
"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\"`",
1146-
"x-optimade-queryable": "must",
1147-
"x-optimade-support": "must"
1146+
"x-optimade-support": "must",
1147+
"x-optimade-queryable": "must"
11481148
},
11491149
"type": {
11501150
"title": "Type",

0 commit comments

Comments
 (0)