Trajectory Endpoint

Procfile

@@ -1 +1 @@
-web: uvicorn optimade.server.main:app --host 0.0.0.0 --port $PORT
+web: --host 0.0.0.0 --port $PORT

docs/api_reference/adapters/jsonl.md

@@ -0,0 +1,3 @@
+# jsonl
+
+::: optimade.adapters.jsonl

docs/api_reference/models/partial_data.md

@@ -0,0 +1,5 @@
+# partial_data
+
+::: optimade.models.partial_data
+    options:
+      show_if_no_docstring: true

docs/api_reference/models/trajectories.md

@@ -0,0 +1,5 @@
+# trajectories
+
+::: optimade.models.trajectories
+    options:
+      show_if_no_docstring: true

docs/api_reference/server/mappers/partial_data.md

@@ -0,0 +1,3 @@
+# partial_data
+
+::: optimade.server.mappers.partial_data

docs/api_reference/server/mappers/trajectories.md

@@ -0,0 +1,3 @@
+# trajectories
+
+::: optimade.server.mappers.trajectories

docs/api_reference/server/routers/partial_data.md

@@ -0,0 +1,3 @@
+# partial_data
+
+::: optimade.server.routers.partial_data

docs/api_reference/server/routers/trajectories.md

@@ -0,0 +1,3 @@
+# trajectories
+
+::: optimade.server.routers.trajectories

openapi/index_openapi.json

@@ -467,6 +467,29 @@
         "title": "BaseRelationshipResource",
         "description": "Minimum requirements to represent a relationship resource"
       },
+      "EntryMetadata": {
+        "properties": {
+          "property_metadata": {
+            "type": "object",
+            "title": "Property Metadata",
+            "description": "An object containing per-entry and per-property metadata. The keys are the names of the fields in attributes for which metadata is available. The values belonging to these keys are dictionaries containing the relevant metadata fields. See also [Metadata properties](https://github.com/Materials-Consortia/OPTIMADE/blob/develop/optimade.rst#metadata-properties)"
+          },
+          "partial_data_links": {
+            "additionalProperties": {
+              "items": {
+                "$ref": "#/components/schemas/PartialDataLink"
+              },
+              "type": "array"
+            },
+            "type": "object",
+            "title": "Partial Data Links",
+            "description": "A dictionary, where the keys are the names of the properties in the attributes field for which the value is too large to be shared by default.\n        For each property one or more links are provided from which the value of the attribute can be retrieved."
+          }
+        },
+        "type": "object",
+        "title": "EntryMetadata",
+        "description": "Contains the metadata for the attributes of an entry"
+      },
       "EntryRelationships": {
         "properties": {
           "references": {
@@ -486,6 +509,15 @@
             ],
             "title": "Structures",
             "description": "Object containing links to relationships with entries of the `structures` type."
+          },
+          "trajectories": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/TrajectoryRelationship"
+              }
+            ],
+            "title": "Trajectories",
+            "description": "Object containing links to relationships with entries of the `trajectories` type."
           }
         },
         "type": "object",
@@ -520,11 +552,11 @@
           "meta": {
             "allOf": [
               {
-                "$ref": "#/components/schemas/Meta"
+                "$ref": "#/components/schemas/EntryMetadata"
               }
             ],
             "title": "Meta",
-            "description": "a meta object containing non-standard meta-information about a resource that can not be represented as an attribute or relationship."
+            "description": "A [JSON API meta object](https://jsonapi.org/format/1.1/#document-meta) that is used to communicate metadata."
           },
           "attributes": {
             "allOf": [
@@ -1129,11 +1161,11 @@
           "meta": {
             "allOf": [
               {
-                "$ref": "#/components/schemas/Meta"
+                "$ref": "#/components/schemas/EntryMetadata"
               }
             ],
             "title": "Meta",
-            "description": "a meta object containing non-standard meta-information about a resource that can not be represented as an attribute or relationship."
+            "description": "A [JSON API meta object](https://jsonapi.org/format/1.1/#document-meta) that is used to communicate metadata."
           },
           "attributes": {
             "allOf": [
@@ -1393,6 +1425,29 @@
         "title": "OptimadeError",
         "description": "detail MUST be present"
       },
+      "PartialDataLink": {
+        "properties": {
+          "link": {
+            "type": "string",
+            "maxLength": 65536,
+            "minLength": 1,
+            "format": "uri",
+            "title": "Link",
+            "description": "String. A JSON API link that points to a location from which the omitted data can be fetched. There is no requirement on the syntax or format for the link URL."
+          },
+          "format": {
+            "type": "string",
+            "title": "Format",
+            "description": "String. The name of the format provided via this link. For one of the objects this format field SHOULD have the value \"jsonlines\", which refers to the format in OPTIMADE JSON lines partial data format."
+          }
+        },
+        "type": "object",
+        "required": [
+          "link",
+          "format"
+        ],
+        "title": "PartialDataLink"
+      },
       "Provider": {
         "properties": {
           "name": {
@@ -1880,6 +1935,47 @@
         "title": "ToplevelLinks",
         "description": "A set of Links objects, possibly including pagination"
       },
+      "TrajectoryRelationship": {
+        "properties": {
+          "links": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RelationshipLinks"
+              }
+            ],
+            "title": "Links",
+            "description": "a links object containing at least one of the following: self, related"
+          },
+          "data": {
+            "anyOf": [
+              {
+                "$ref": "#/components/schemas/BaseRelationshipResource"
+              },
+              {
+                "items": {
+                  "$ref": "#/components/schemas/BaseRelationshipResource"
+                },
+                "type": "array"
+              }
+            ],
+            "uniqueItems": true,
+            "title": "Data",
+            "description": "Resource linkage"
+          },
+          "meta": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/Meta"
+              }
+            ],
+            "title": "Meta",
+            "description": "a meta object that contains non-standard meta-information about the relationship."
+          }
+        },
+        "type": "object",
+        "title": "TrajectoryRelationship",
+        "description": "Similar to normal JSON API relationship, but with addition of OPTIONAL meta field for a resource."
+      },
       "Warnings": {
         "properties": {
           "id": {