Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

New REQUIRED level properties #153

Merged
merged 8 commits into from
Feb 6, 2020
Merged

New REQUIRED level properties #153

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
5e89e3e
Use .get to retrieve field values in validators
CasperWA Feb 3, 2020
e1c2e2e
Introduce get_required_fields for mappers
CasperWA Feb 3, 2020
60d4483
Update field descriptions
CasperWA Feb 4, 2020
032b7ae
Add tests for required fields with response_fields
CasperWA Feb 4, 2020
9af8eb8
Merge branch 'master' into fix_114_new_required_level_properties
CasperWA Feb 6, 2020
03e9864
Add validator for BaseInfo.available(...).url
CasperWA Feb 6, 2020
c26c893
Crossvalidate url and version, with tests
ml-evs Feb 6, 2020
a862084
Blacken and make expection msg an f-string
CasperWA Feb 6, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions openapi/index_openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,12 @@
"operationId": "get_links_index_optimade_v0_links_get",
"parameters": [
{
"description": "See [the full and latest OPTiMaDe spec](https://github.com/Materials-Consortia/OPTiMaDe/blob/develop/optimade.rst) for filter query syntax.\n\nExample: `chemical_formula = \"Al\" OR (prototype_formula = \"AB\" AND elements HAS Si, Al, O)`.\n",
"description": "See [the full and latest OPTiMaDe spec](https://github.com/Materials-Consortia/OPTiMaDe/blob/develop/optimade.rst) for filter query syntax.",
"required": false,
"schema": {
"title": "Filter",
"type": "string",
"description": "See [the full and latest OPTiMaDe spec](https://github.com/Materials-Consortia/OPTiMaDe/blob/develop/optimade.rst) for filter query syntax.\n\nExample: `chemical_formula = \"Al\" OR (prototype_formula = \"AB\" AND elements HAS Si, Al, O)`.\n",
"description": "See [the full and latest OPTiMaDe spec](https://github.com/Materials-Consortia/OPTiMaDe/blob/develop/optimade.rst) for filter query syntax.",
"default": ""
},
"name": "filter",
Expand Down Expand Up @@ -217,13 +217,13 @@
"maxLength": 65536,
"minLength": 1,
"type": "string",
"description": "a string specifying a base URL that MUST adhere to the rules in section Base URL",
"description": "a string specifying a versioned base URL that MUST adhere to the rules in section Base URL",
"format": "uri"
},
"version": {
"title": "Version",
"type": "string",
"description": "a string containing the full version number of the API served at that base URL. The version number string MUST NOT be prefixed by, e.g., 'v'."
"description": "a string containing the full version number of the API served at that versioned base URL. The version number string MUST NOT be prefixed by, e.g., 'v'."
}
},
"description": "A JSON object containing information about an available API version"
Expand Down Expand Up @@ -310,12 +310,12 @@
"id": {
"title": "Id",
"type": "string",
"description": "An entry's ID as defined in section `Definition of Terms`_.\n- **Type**: string.\n- **Requirements/Conventions**:\n\n - **Response**: REQUIRED in the response unless explicitly excluded.\n - **Query**: MUST be a queryable property with support for all mandatory filter operators.\n - See section `Definition of Terms`_.\n\n- **Examples**:\n\n - :val:`\"db/1234567\"`\n - :val:`\"cod/2000000\"`\n - :val:`\"cod/2000000@1234567\"`\n - :val:`\"nomad/L1234567890\"`\n - :val:`\"42\"`"
"description": "An entry's ID as defined in section `Definition of Terms`_.\n- **Type**: string.\n- **Requirements/Conventions**:\n\n - **Support**: REQUIRED, MUST NOT be :val:`null`.\n - **Query**: MUST be a queryable property with support for all mandatory filter features.\n - **Response**: REQUIRED in the response.\n - See section `Definition of Terms`_.\n\n- **Examples**:\n\n - :val:`\"db/1234567\"`\n - :val:`\"cod/2000000\"`\n - :val:`\"cod/2000000@1234567\"`\n - :val:`\"nomad/L1234567890\"`\n - :val:`\"42\"`"
},
"type": {
"title": "Type",
"type": "string",
"description": "The name of the type of an entry.\nAny entry MUST be able to be fetched using the `base URL <Base URL_>`_ type and ID at the url :endpoint:`<base URL>/<type>/<id>`.\n- **Type**: string.\n- **Requirements/Conventions**:\n\n - **Response**: REQUIRED in the response unless explicitly excluded.\n - **Query**: Support for queries on this property is OPTIONAL.\n If supported, only a subset of string comparison operators MAY be supported.\n\n- **Requirements/Conventions**: MUST be an existing entry type.\n- **Example**: :val:`\"structures\"`"
"description": "The name of the type of an entry.\n- **Type**: string.\n- **Requirements/Conventions**:\n\n - **Support**: REQUIRED, MUST NOT be :val:`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 :endpoint:`/<type>/<id>` under the versioned base URL.\n\n- **Example**: :val:`\"structures\"`"
},
"links": {
"title": "Links",
Expand Down Expand Up @@ -366,12 +366,12 @@
"immutable_id": {
"title": "Immutable Id",
"type": "string",
"description": "The entry's immutable ID (e.g., an UUID).\nThis is important for databases having preferred IDs that point to \"the latest version\" of a record, but still offer access to older variants.\nThis ID maps to the version-specific record, in case it changes in the future.\n- **Type**: string.\n- **Requirements/Conventions**:\n\n - **Response**: OPTIONAL in the response.\n - **Query**: If present, MUST be a queryable property with support for all mandatory filter operators.\n\n- **Examples**:\n\n - :val:`\"8bd3e750-b477-41a0-9b11-3a799f21b44f\"`\n - :val:`\"fjeiwoj,54;@=%<>#32\"` (Strings that are not URL-safe are allowed.)"
"description": "The entry's immutable ID (e.g., an UUID).\nThis is important for databases having preferred IDs that point to \"the latest version\" of a record, but still offer access to older variants.\nThis ID maps to the version-specific record, in case it changes in the future.\n- **Type**: string.\n- **Requirements/Conventions**:\n\n - **Support**: OPTIONAL, i.e., MAY be :val:`null`.\n - **Query**: MUST be a queryable property with support for all mandatory filter features.\n\n- **Examples**:\n\n - :val:`\"8bd3e750-b477-41a0-9b11-3a799f21b44f\"`\n - :val:`\"fjeiwoj,54;@=%<>#32\"` (Strings that are not URL-safe are allowed.)"
},
"last_modified": {
"title": "Last Modified",
"type": "string",
"description": "Date and time representing when the entry was last modified.\n- **Type**: timestamp.\n- **Requirements/Conventions**:\n\n - **Response**: REQUIRED in the response unless explicitly excluded.\n - **Query**: MUST be a queryable property with support for all mandatory filter operators.\n\n- **Example**:\n\n - As part of JSON response format: :VAL:`\"2007-04-05T14:30Z\"`\n (i.e., encoded as an `RFC 3339 Internet Date/Time Format <https://tools.ietf.org/html/rfc3339#section-5.6>`__ string.)",
"description": "Date and time representing when the entry was last modified.\n- **Type**: timestamp.\n- **Requirements/Conventions**:\n\n - **Support**: SHOULD be supported, i.e., SHOULD NOT be :val:`null`. Is REQUIRED in this implementation, i.e., MUST NOT be :val:`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 :query-param:`response_fields` is present and does not include this property.\n\n- **Example**:\n\n - As part of JSON response format: :VAL:`\"2007-04-05T14:30Z\"` (i.e., encoded as an `RFC 3339 Internet Date/Time Format <https://tools.ietf.org/html/rfc3339#section-5.6>`__ string.)",
"format": "date-time"
}
},
Expand Down Expand Up @@ -590,7 +590,7 @@
"items": {
"type": "string"
},
"description": "List of available endpoints (i.e., the string to be appended to the base URL)."
"description": "List of available endpoints (i.e., the string to be appended to the versioned base URL)."
},
"entry_types_by_format": {
"title": "Entry Types By Format",
Expand Down Expand Up @@ -791,7 +791,7 @@
"id": {
"title": "Id",
"type": "string",
"description": "An entry's ID as defined in section `Definition of Terms`_.\n- **Type**: string.\n- **Requirements/Conventions**:\n\n - **Response**: REQUIRED in the response unless explicitly excluded.\n - **Query**: MUST be a queryable property with support for all mandatory filter operators.\n - See section `Definition of Terms`_.\n\n- **Examples**:\n\n - :val:`\"db/1234567\"`\n - :val:`\"cod/2000000\"`\n - :val:`\"cod/2000000@1234567\"`\n - :val:`\"nomad/L1234567890\"`\n - :val:`\"42\"`"
"description": "An entry's ID as defined in section `Definition of Terms`_.\n- **Type**: string.\n- **Requirements/Conventions**:\n\n - **Support**: REQUIRED, MUST NOT be :val:`null`.\n - **Query**: MUST be a queryable property with support for all mandatory filter features.\n - **Response**: REQUIRED in the response.\n - See section `Definition of Terms`_.\n\n- **Examples**:\n\n - :val:`\"db/1234567\"`\n - :val:`\"cod/2000000\"`\n - :val:`\"cod/2000000@1234567\"`\n - :val:`\"nomad/L1234567890\"`\n - :val:`\"42\"`"
},
"type": {
"title": "Type",
Expand Down
Loading