Deploy ga4gh/data-repository-service-schemas to github.com/ga4gh/data…

…-repository-service-schemas.git:gh-pages
ga4gh · Sep 11, 2024 · 5eb40fa · 5eb40fa
1 parent a5f57a3
commit 5eb40fa
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 19 deletions.
diff --git a/openapi/components/schemas/AccessMethod.yaml b/openapi/components/schemas/AccessMethod.yaml
@@ -24,23 +24,11 @@ properties:
       An arbitrary string to be passed to the `/access` method to get an `AccessURL`.
       This string must be unique within the scope of a single object.
       Note that at least one of `access_url` and `access_id` must be provided.
-  cloud:
-    type: string
-    description: >-
-      Name of the cloud service provider that the object belongs to.
-      If the cloud service is Amazon Web Services, Google Cloud Platform or Azure the values should be `aws`, `gcp`, or `azure` respectively.
-    example: aws, gcp, or azure
   region:
     type: string
     description: >-
       Name of the region in the cloud service provider that the object belongs to.
     example: us-east-1
-  available:
-    type: boolean
-    description: >-
-      Availablity of file in the cloud.
-      This label defines if this file is immediately accessible via DRS. Any delay or requirement of thawing mechanism if the file is in offline/archival storage is classified as 0 or unavailable.
-    example: true
   authorizations:
     allOf:
       - $ref: './Authorizations.yaml'

diff --git a/openapi/components/schemas/DrsService.yaml b/openapi/components/schemas/DrsService.yaml
@@ -6,6 +6,12 @@ properties:
   maxBulkRequestLength:
     type: integer
     description: The max length the bullk request endpoints can handle (>= 1) before generating a 413 error e.g. how long can the arrays bulk_object_ids and bulk_object_access_ids be for this server.  
+  objectCount:
+    type: integer
+    description: The total number of objects in this DRS service.
+  totalObjectSize:
+    type: integer
+    description: The total size of all objects in this DRS service in bytes.  As a general best practice, file bytes are counted for each unique file and not cloud mirrors or other redundant copies.
   type:
     type: object
     required:

diff --git a/openapi/paths/service-info.yaml b/openapi/paths/service-info.yaml
@@ -1,7 +1,7 @@
 get:
   summary: Retrieve information about this service
   description: |-
-    Returns information about the DRS service
+    Returns information about the DRS service along with stats pertaning to total object count and cumulative size in bytes.
 
     Extends the
     [v1.0.0 GA4GH Service Info specification](https://github.com/ga4gh-discovery/ga4gh-service-info)
@@ -22,9 +22,14 @@ get:
         ...
         "type": {
             "group": "org.ga4gh",
-            "artifact": "drs"
+            "artifact": "drs",
+            "version": "1.5"
         }
         ...
+        "stats": {
+          "objectCount": 774560,
+          "totalObjectSize": 4018437188907752
+        }
     }
     ```
 

diff --git a/preview/feature/issue-396-stats-endpoint/openapi.json b/preview/feature/issue-396-stats-endpoint/openapi.json
@@ -153,7 +153,7 @@
     "/service-info": {
       "get": {
         "summary": "Retrieve information about this service",
-        "description": "Returns information about the DRS service along with stats pertaning to object file statistics\n\nExtends the\n[v1.0.0 GA4GH Service Info specification](https://github.com/ga4gh-discovery/ga4gh-service-info)\nas the standardized format for GA4GH web services to self-describe.\n\nAccording to the \n[service-info type registry](https://github.com/ga4gh/TASC/blob/master/service-info/ga4gh-service-info.json)\nmaintained by the [Technical Alignment Sub Committee (TASC)](https://github.com/ga4gh/TASC),\na DRS service MUST have:\n  * a `type.group` value of `org.ga4gh`\n  * a `type.artifact` value of `drs`\n\ne.g.\n```\n{\n    \"id\": \"com.example.drs\",\n    \"description\": \"Serves data according to DRS specification\",\n    ...\n    \"type\": {\n        \"group\": \"org.ga4gh\",\n        \"artifact\": \"drs\"\n    }\n    ...\n    \"stats\": {\n      \"fileCount\": 774560,\n      \"totalFileSize\": 4018437188907752\n    }\n}\n```\n\nSee the [Service Registry Appendix](#tag/GA4GH-Service-Registry) for more information on how to register a DRS service with a service registry.",
+        "description": "Returns information about the DRS service along with stats pertaning to total object count and cumulative size in bytes.\n\nExtends the\n[v1.0.0 GA4GH Service Info specification](https://github.com/ga4gh-discovery/ga4gh-service-info)\nas the standardized format for GA4GH web services to self-describe.\n\nAccording to the \n[service-info type registry](https://github.com/ga4gh/TASC/blob/master/service-info/ga4gh-service-info.json)\nmaintained by the [Technical Alignment Sub Committee (TASC)](https://github.com/ga4gh/TASC),\na DRS service MUST have:\n  * a `type.group` value of `org.ga4gh`\n  * a `type.artifact` value of `drs`\n\ne.g.\n```\n{\n    \"id\": \"com.example.drs\",\n    \"description\": \"Serves data according to DRS specification\",\n    ...\n    \"type\": {\n        \"group\": \"org.ga4gh\",\n        \"artifact\": \"drs\",\n        \"version\": \"1.5\"\n    }\n    ...\n    \"stats\": {\n      \"objectCount\": 774560,\n      \"totalObjectSize\": 4018437188907752\n    }\n}\n```\n\nSee the [Service Registry Appendix](#tag/GA4GH-Service-Registry) for more information on how to register a DRS service with a service registry.",
         "operationId": "GetServiceInfo",
         "responses": {
           "200": {
@@ -681,6 +681,14 @@
             "type": "integer",
             "description": "The max length the bullk request endpoints can handle (>= 1) before generating a 413 error e.g. how long can the arrays bulk_object_ids and bulk_object_access_ids be for this server."
           },
+          "objectCount": {
+            "type": "integer",
+            "description": "The total number of objects in this DRS service."
+          },
+          "totalObjectSize": {
+            "type": "integer",
+            "description": "The total size of all objects in this DRS service in bytes.  As a general best practice, file bytes are counted for each unique file and not cloud mirrors or other redundant copies."
+          },
           "type": {
             "type": "object",
             "required": [

diff --git a/preview/feature/issue-396-stats-endpoint/openapi.yaml b/preview/feature/issue-396-stats-endpoint/openapi.yaml
@@ -958,7 +958,7 @@ paths:
       summary: Retrieve information about this service
       description: >-
         Returns information about the DRS service along with stats pertaning to
-        object file statistics
+        total object count and cumulative size in bytes.
 
 
         Extends the
@@ -991,12 +991,13 @@ paths:
             ...
             "type": {
                 "group": "org.ga4gh",
-                "artifact": "drs"
+                "artifact": "drs",
+                "version": "1.5"
             }
             ...
             "stats": {
-              "fileCount": 774560,
-              "totalFileSize": 4018437188907752
+              "objectCount": 774560,
+              "totalObjectSize": 4018437188907752
             }
         }
 
@@ -1444,6 +1445,15 @@ components:
             The max length the bullk request endpoints can handle (>= 1) before
             generating a 413 error e.g. how long can the arrays bulk_object_ids
             and bulk_object_access_ids be for this server.
+        objectCount:
+          type: integer
+          description: The total number of objects in this DRS service.
+        totalObjectSize:
+          type: integer
+          description: >-
+            The total size of all objects in this DRS service in bytes.  As a
+            general best practice, file bytes are counted for each unique file
+            and not cloud mirrors or other redundant copies.
         type:
           type: object
           required: