feat: add metadata-fields endpoint (#50)

chanzuckerberg · Dec 19, 2023 · 3c16bfc · 3c16bfc
1 parent 5022c50
commit 3c16bfc
Show file tree

Hide file tree

Showing 7 changed files with 3,094 additions and 7 deletions.
diff --git a/.meshrc.yaml b/.meshrc.yaml
@@ -45,6 +45,21 @@ sources:
             method: GET
             responseSchema: ./json-schemas/consensusGenomeWorkflowResults.json
             responseTypeName: ConsensusGenomeWorkflowResults
+          - type: Query
+            field: CoverageVizSummary
+            path: /pub/{args.snapshotLinkId}/samples/{args.sampleId}/coverage_viz_summary
+            method: GET
+            responseSchema: ./json-schemas/coverageVizSummary.json
+            responseTypeName: CoverageVizSummary
+          - type: Query
+            field: MetadataFields
+            path: /pub/{args.snapshotLinkId}/samples/metadata_fields
+            method: POST
+            requestSchema: ./json-schemas/sampleArray.json
+            responseSchema: ./json-schemas/metadataFields.json
+            responseTypeName: MetadataFields
+            headers:
+              Cookie: "{context.headers['cookie']}"
           - type: Query
             field: MngsWorkflowResults
             path: /pub/{args.snapshotLinkId}/samples/{args.sampleId}.json
@@ -57,12 +72,6 @@ sources:
             method: GET
             responseSchema: ./json-schemas/mngsWorkflowResults.json
             responseTypeName: MngsWorkflowResults
-          - type: Query
-            field: CoverageVizSummary
-            path: /pub/{args.snapshotLinkId}/samples/{args.sampleId}/coverage_viz_summary
-            method: GET
-            responseSchema: ./json-schemas/coverageVizSummary.json
-            responseTypeName: CoverageVizSummary
           - type: Query
             field: Pathogens
             path: /pub/{args.snapshotLinkId}/samples/{args.sampleId}/report_v2?&id={args.sampleId}&pipeline_version={args.workflowVersionId}&merge_nt_nr=false

diff --git a/json-schemas/metadataFields.json b/json-schemas/metadataFields.json
@@ -0,0 +1,52 @@
+{
+    "type": "array",
+    "items": {
+        "type": "object",
+        "properties": {
+            "key": {
+                "type": "string"
+            },
+            "dataType": {
+                "type": "string"
+            },
+            "name": {
+                "type": "string"
+            },
+            "options": {
+                "type": "NoneType"
+            },
+            "group": {
+                "type": "string"
+            },
+            "host_genome_ids": {
+                "type": "array",
+                "items": {
+                    "type": "integer"
+                }
+            },
+            "description": {
+                "type": "string"
+            },
+            "is_required": {
+                "type": "integer"
+            },
+            "examples": {
+                "type": "object",
+                "properties": {
+                    "all": {
+                        "type": "array",
+                        "items": {
+                            "type": "string"
+                        }
+                    }
+                }
+            },
+            "default_for_new_host_genome": {
+                "type": "integer"
+            },
+            "isBoolean": {
+                "type": "boolean"
+            }
+        }
+    }
+}
diff --git a/json-schemas/sampleArray.json b/json-schemas/sampleArray.json
@@ -0,0 +1,15 @@
+{
+    "type": "object",
+    "properties": {
+        "sampleIds": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            }
+        },
+        "authenticityToken": {
+            "type": "string"
+        }
+    },
+    "required": ["sampleIds", "authenticityToken"]
+}
diff --git a/resolvers.ts b/resolvers.ts
@@ -62,6 +62,18 @@ export const resolvers: Resolvers = {
         },
       };
     },
+    MetadataFields: async (root, args, context, info) => {
+      const body = {
+        sampleIds: args?.input?.sampleIds
+      };
+      const res = await postWithCSRF(
+        `/samples/metadata_fields`,
+        body,
+        args,
+        context
+      );
+      return res;
+    },
     MngsWorkflowResults: async (root, args, context, info) => {
       const data = await get(`/samples/${args.sampleId}.json`, args, context);
       const pipelineRun = data?.pipeline_runs?.[0] || {};

diff --git a/sample-requests/sampleArray.json b/sample-requests/sampleArray.json
@@ -0,0 +1,3 @@
+{
+  "sampleIds": [ "1234", "12345" ]
+}