Skip to content

Commit

Permalink
Simplifying requirements for the filter operators for a couple of pro…
Browse files Browse the repository at this point in the history
…perties.
  • Loading branch information
merkys committed Dec 4, 2019
1 parent 892f60a commit 8a6a4b2
Showing 1 changed file with 1 addition and 17 deletions.
18 changes: 1 addition & 17 deletions optimade.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1411,8 +1411,6 @@ type
- **Requirements/Conventions**:

- **Response**: REQUIRED in the response.
- **Query**: Support for queries on this property is OPTIONAL.
If supported, only a subset of string comparison operators MAY be supported.

- **Requirements/Conventions**: MUST be an existing entry type.
- **Example**: :val:`"structures"`
Expand All @@ -1424,7 +1422,7 @@ immutable\_id
- **Type**: string.
- **Requirements/Conventions**:

- **Query**: If present, MUST be a queryable property with support for all mandatory filter operators.
- **Query**: MUST be a queryable property with support for all mandatory filter operators.

- **Examples**:

Expand Down Expand Up @@ -1786,8 +1784,6 @@ assemblies

- **Requirements/Conventions**:

- **Query**: Support for queries on this property is OPTIONAL.
If supported, filters MAY support only a subset of comparison operators.
- If present, the correct flag MUST be set in the list :property:`structure_features` (see property `structure_features`_).
- Client implementations MUST check its presence (as its presence changes the interpretation of the structure).
- If present, it MUST be a list of dictionaries, each of which represents an assembly and MUST have the following two keys:
Expand Down Expand Up @@ -1931,8 +1927,6 @@ The following properties are used to provide the bibliographic details:
- **Requirements/Conventions**:

- **Response**: Every references entry MUST contain at least one of the properties.
- **Query**: Support for queries on any of these properties is OPTIONAL.
If supported, filters MAY support only a subset of comparison operators.

Example:

Expand Down Expand Up @@ -1964,11 +1958,6 @@ Database-Provider-Specific Entry Types
Names of database-provider-specific entry types MUST start with database-provider-specific namespace prefix as given in appendix `Database-Provider-Specific Namespace Prefixes`_.
Database-provider-specific entry types MUST have all properties described above in section `Properties Used by Multiple Entry Types`_.

- **Requirements/Conventions for properties in database-provider-specific entry types**:

- **Query**: Support for queries on these properties are OPTIONAL.
If supported, only a subset of filter operators MAY be supported.

Relationships Used by Multiple Entry Types
------------------------------------------

Expand Down Expand Up @@ -2048,11 +2037,6 @@ Relationships with calculations MAY be used to indicate provenance where a struc

At the moment the database providers are suggested to extend their API the way they choose, always using their database-provider-specific prefix in non-standardized fields.

- **Requirements/Conventions for database-provider-specific properties of calculations entries**:

- **Query**: Support for queries on these properties are OPTIONAL.
If supported, only a subset of filter operators MAY be supported.

Appendices
==========

Expand Down

0 comments on commit 8a6a4b2

Please sign in to comment.