Added homepage attribute to LinksResource

openapi/index_openapi.json

@@ -1196,7 +1196,8 @@
         "required": [
           "name",
           "description",
-          "base_url"
+          "base_url",
+          "homepage"
         ],
         "type": "object",
         "properties": {
@@ -1228,6 +1229,25 @@
               }
             ],
             "description": "JSON API links object, pointing to the base URL for this implementation"
+          },
+          "homepage": {
+            "title": "Homepage",
+            "anyOf": [
+              {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 65536,
+                "format": "uri"
+              },
+              {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/Link"
+                  }
+                ]
+              }
+            ],
+            "description": "JSON API links object, pointing to a homepage URL for this implementation"
           }
         },
         "description": "Links endpoint resource object attributes"

openapi/openapi.json

@@ -2924,7 +2924,8 @@
         "required": [
           "name",
           "description",
-          "base_url"
+          "base_url",
+          "homepage"
         ],
         "type": "object",
         "properties": {
@@ -2956,6 +2957,25 @@
               }
             ],
             "description": "JSON API links object, pointing to the base URL for this implementation"
+          },
+          "homepage": {
+            "title": "Homepage",
+            "anyOf": [
+              {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 65536,
+                "format": "uri"
+              },
+              {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/Link"
+                  }
+                ]
+              }
+            ],
+            "description": "JSON API links object, pointing to a homepage URL for this implementation"
           }
         },
         "description": "Links endpoint resource object attributes"

optimade/models/links.py

@@ -32,6 +32,11 @@ class LinksResourceAttributes(Attributes):
         description="JSON API links object, pointing to the base URL for this implementation",
     )
 
+    homepage: Union[AnyUrl, Link, None] = Field(
+        ...,
+        description="JSON API links object, pointing to a homepage URL for this implementation",
+    )
+
 
 class LinksResource(EntryResource):
     """A Links endpoint resource object"""

optimade/server/data/test_links.json

@@ -7,6 +7,7 @@
     "type": "parent",
     "name": "Index meta-database",
     "description": "Index for example's OPTiMaDe databases",
-    "base_url": "http://localhost:5001/index/optimade"
+    "base_url": "http://localhost:5001/index/optimade",
+    "homepage": "https://example.com"
   }
 ]

optimade/server/index_links.json

@@ -7,6 +7,7 @@
     "type": "child",
     "name": "OPTiMaDe API",
     "description": "The [Open Databases Integration for Materials Design (OPTiMaDe) consortium](http://http://www.optimade.org/) aims to make materials databases interoperational by developing a common REST API.",
-    "base_url": "http://localhost:5000/optimade"
+    "base_url": "http://localhost:5000/optimade",
+    "homepage": "https://example.com"
   }
 ]

optimade/server/main.py

@@ -47,9 +47,7 @@ def load_entries(endpoint_name: str, endpoint_collection: MongoCollection):
                 bson.json_util.loads(bson.json_util.dumps(data))
             )
         if endpoint_name == "links":
-            print(
-                "adding providers.json to links from github.com/Materials-Consortia/OPTiMaDe"
-            )
+            print("adding Materials-Consortia providers to links from optimade.org")
             endpoint_collection.collection.insert_many(
                 bson.json_util.loads(bson.json_util.dumps(get_providers()))
             )

optimade/server/routers/utils.py

@@ -243,12 +243,12 @@ def retrieve_queryable_properties(schema: dict, queryable_properties: list) -> d
 
 
 def get_providers():
-    """Retrieve providers.json from /Materials-Consortia/OPTiMaDe"""
+    """Retrieve Materials-Consortia providers (from https://www.optimade.org/providers/links)"""
     import requests
     from bson.objectid import ObjectId
 
     mat_consortia_providers = requests.get(
-        "https://raw.githubusercontent.com/Materials-Consortia/OPTiMaDe/master/providers.json"
+        "https://www.optimade.org/providers/links"
     ).json()
 
     providers_list = []