Seperated Links from JSON API into its own file

optimade/server/models/errors.py

@@ -1,7 +1,7 @@
 from typing import Dict, List, Optional, Union
 
 from .jsonapi import Link
-from .links import Links
+from .modified_jsonapi import Links
 from pydantic import BaseModel, UrlStr, Schema
 
 class ErrorSource(BaseModel):

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]]
+class Links(BaseModel):
+    next: 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,26 @@
+from optimade.server.models.jsonapi import Link, Links, Source
+
+from datetime import datetime
+from pydantic import  UrlStr, BaseModel
+from typing import Optional, Union, Any
+
+class Attributes(BaseModel):
+    local_id: UrlStr
+    lad_modified: datetime
+    immutable_id: Optional[UrlStr]
+
+class ErrorLinks(BaseModel):
+    about: Union[Link, UrlStr]
+
+class Error(BaseModel):
+    id: Optional[str]
+    status: Optional[str]
+    code: Optional[str]
+    title: Optional[str]
+    detail: Optional[str]
+    source: Optional[Source]
+    meta: Optional[dict]
+    links: Optional[ErrorLinks]
+
+class Links(Links):
+    base_rul: Optional[Union[Link, UrlStr]]