Skip to content

Commit

Permalink
Update OpenAPI JSON after merge
Browse files Browse the repository at this point in the history
  • Loading branch information
@ml-evs
ml-evs committed Dec 23, 2023
1 parent 1b27478 commit 82d49e4
Show file tree
Hide file tree
Showing 3 changed files with 337 additions and 291 deletions.
51 changes: 38 additions & 13 deletions openapi/index_openapi.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -498,15 +498,15 @@
"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"
"x-optimade-support": "must",
"x-optimade-queryable": "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"
"x-optimade-support": "must",
"x-optimade-queryable": "must"
},
"links": {
"allOf": [
Expand Down Expand Up @@ -560,16 +560,16 @@
"type": "string",
"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"
"x-optimade-support": "optional",
"x-optimade-queryable": "must"
},
"last_modified": {
"type": "string",
"format": "date-time",
"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"
"x-optimade-support": "should",
"x-optimade-queryable": "must"
}
},
"type": "object",
Expand Down Expand Up @@ -887,6 +887,29 @@
"title": "Entry Types By Format",
"description": "Available entry endpoints as a function of output formats."
},
"license": {
"anyOf": [
{
"$ref": "#/components/schemas/Link"
},
{
"type": "string",
"maxLength": 65536,
"minLength": 1,
"format": "uri"
}
],
"title": "License",
"description": "A [JSON API links object](http://jsonapi.org/format/1.0/#document-links) giving a URL to a web page containing a human-readable text describing the license (or licensing options if there are multiple) covering all the data and metadata provided by this database.\nClients are advised not to try automated parsing of this link or its content, but rather rely on the field `available_licenses` instead."
},
"available_licenses": {
"items": {
"type": "string"
},
"type": "array",
"title": "Available Licenses",
"description": "List of [SPDX license identifiers](https://spdx.org/licenses/) specifying a set of alternative licenses under which the client is granted access to all the data and metadata in this database.\n\nIf the data and metadata is available under multiple alternative licenses, identifiers of these multiple licenses SHOULD be provided to let clients know under which conditions the data and metadata can be used.\nInclusion of a license identifier in the list is a commitment of the database that the rights are in place to grant clients access to all the data and metadata according to the terms of either of these licenses (at the choice of the client).\nIf the licensing information provided via the field `license` omits licensing options specified in `available_licenses`, or if it otherwise contradicts them, a client MUST still be allowed to interpret the inclusion of a license in `available_licenses` as a full commitment from the database that the data and metadata is available, without exceptions, under the respective licenses.\nIf the database cannot make that commitment, e.g., if only part of the data is available under a license, the corresponding license identifier MUST NOT appear in `available_licenses` (but, rather, the field `license` is to be used to clarify the licensing situation.)\nAn empty list indicates that none of the SPDX licenses apply for the entirety of the database and that the licensing situation is clarified in human readable form in the field `license`."
},
"is_index": {
"type": "boolean",
"title": "Is Index",
Expand All @@ -899,7 +922,9 @@
"api_version",
"available_api_versions",
"available_endpoints",
"entry_types_by_format"
"entry_types_by_format",
"license",
"available_licenses"
],
"title": "IndexInfoAttributes",
"description": "Attributes for Base URL Info endpoint for an Index Meta-Database"
Expand Down Expand Up @@ -1107,8 +1132,8 @@
"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"
"x-optimade-support": "must",
"x-optimade-queryable": "must"
},
"type": {
"type": "string",
Expand Down Expand Up @@ -1700,9 +1725,9 @@
"description": "response string from the server"
},
"request_delay": {
"title": "Request Delay",
"minimum": 0.0,
"type": "number",
"minimum": 0.0,
"title": "Request Delay",
"description": "A non-negative float giving time in seconds that the client is suggested to wait before issuing a subsequent request."
},
"implementation": {
Expand Down
Loading

0 comments on commit 82d49e4

Please sign in to comment.