Merge pull request #76 from bento-platform/service-info-fixes

Service info fixes
bento-platform · Dec 8, 2022 · be5c420 · be5c420
2 parents fcff816 + 0a3e717
commit be5c420
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 5 deletions.
diff --git a/bento_lib/package.cfg b/bento_lib/package.cfg
@@ -1,5 +1,5 @@
 [package]
 name = bento_lib
-version = 5.0.0
+version = 5.0.1
 authors = David Lougheed, Paul Pillot
 author_emails = [email protected], [email protected]
diff --git a/bento_lib/types.py b/bento_lib/types.py
@@ -2,6 +2,8 @@
 
 __all__ = [
     "GA4GHServiceType",
+    "GA4GHServiceOrganization",
+    "GA4GHServiceInfo",
 ]
 
 
@@ -16,13 +18,20 @@ class GA4GHServiceOrganization(TypedDict):
     url: str
 
 
-class GA4GHServiceInfo(TypedDict):
+# TODO: py3.11: Required[] instead of base class
+
+
+class _GA4GHServiceInfoBase(TypedDict):
     id: str
     name: str
     type: GA4GHServiceType
-    description: str
     organization: GA4GHServiceOrganization
-    contactUrl: str
     version: str
-    url: str
+
+
+class GA4GHServiceInfo(_GA4GHServiceInfoBase, total=False):
+    description: str
+    contactUrl: str
+    documentationUrl: str
+    url: str  # Technically not part of spec; comes from service-registry
     environment: Union[Literal["dev"], Literal["prod"]]