Seperated Links from JSON API into its own file

optimade/server/main.py

@@ -11,7 +11,8 @@
 
 from .deps import EntryListingQueryParams
 from .collections import MongoCollection
-from .models.jsonapi import Link, Links
+from .models.jsonapi import Link
+from .models.modified_jsonapi import Links
 from .models.structures import StructureResource
 from .models.baseinfo import BaseInfoResource, BaseInfoAttributes
 from .models.toplevel import OptimadeResponseMeta, OptimadeResponseMetaQuery, OptimadeStructureResponseMany, OptimadeInfoResponse, OptimadeProvider, OptimadeErrorResponse

optimade/server/models/jsonapi.py

@@ -1,17 +1,20 @@
 """
 This module should reproduce https://jsonapi.org/schema
 """
-
 from typing import Optional, Set, Union, Dict, Any
 from pydantic import BaseModel, UrlStr, constr
 
+class Meta(Dict[str, Any]):
+    """Non-standard meta-information that can not be represented as an attribute or relationship."""
+
 class Link(BaseModel):
     href: UrlStr
     meta: Optional[dict]
 
 class Links(BaseModel):
     next: Optional[Union[UrlStr,Link]]
-    base_url: Optional[Union[UrlStr,Link]]
+    self: Optional[Union[UrlStr,Link]]
+    about: Optional[Union[UrlStr, Link]]
 
 class JsonAPI(BaseModel):
     version: str
@@ -35,6 +38,7 @@ class Error(BaseModel):
     detail: Optional[str]
     source: Optional[Source]
     meta: Optional[dict]
+    links: Optional[Links]
 
 class Failure(BaseModel):
     errors: Set[Error]
@@ -65,6 +69,15 @@ class Relationship(BaseModel):
     data: Optional[Union[Linkage, Set[Linkage]]]
     meta: Optional[dict]
 
+# class Empty(None):
+#     """Describes an empty to-one relationship."""
+
+class RelationshipToOne(Linkage):
+    """References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object."""
+
+class RelationshipToMany(Set[Linkage]):
+    """An array of objects each containing \"type\" and \"id\" members for to-many relationships."""
+
 rel_pat_prop = constr(regex=r"^(?!id$|type$)\\w[-\\w_]*$")
 class Relationships(BaseModel):
     items : Optional[Dict[rel_pat_prop, Relationship]]

optimade/server/models/modified_jsonapi.py

@@ -0,0 +1,21 @@
+"""
+Modified jsonapi for OptimadeAPI
+"""
+from optimade.server.models import jsonapi
+from datetime import datetime
+from pydantic import  UrlStr, BaseModel
+from typing import Optional, Union, Any
+
+class Attributes(jsonapi.Attributes):
+    local_id: UrlStr
+    lad_modified: datetime
+    immutable_id: Optional[UrlStr]
+
+class ErrorLinks(BaseModel):
+    about: Union[jsonapi.Link, UrlStr]
+
+class Error(jsonapi.Error):
+    links: Optional[ErrorLinks]
+
+class Links(jsonapi.Links):
+    base_rul: Optional[Union[jsonapi.Link, UrlStr]]

optimade/server/models/toplevel.py

@@ -3,11 +3,12 @@
 
 from pydantic import BaseModel, validator, UrlStr, Schema
 
-from optimade.server.models.jsonapi import Link, Links, Resource
+from optimade.server.models.jsonapi import Link, Resource, RelationshipToMany
+from optimade.server.models.modified_jsonapi import Links, Attributes
 from optimade.server.models.structures import StructureResource
 from .baseinfo import BaseInfoResource
 from optimade.server.models.util import NonnegativeInt
-from .errors import ErrorMsg
+from .modified_jsonapi import Error
 from .jsonapi import Success, Failure
 
 
@@ -142,7 +143,7 @@ class OptimadeStructureResponseMany(Success):
 
 class OptimadeErrorResponse(Failure):
     meta: Optional[OptimadeResponseMeta]
-    errors: List[ErrorMsg]
+    errors: List[Error]
 
 
 class OptimadeInfoResponse(Success):