Merge pull request #243 from pbashyal-nmdp/validate_GET

Add `/valid` endpoint

Author: mmaiers-nmdp

api-spec.yaml

@@ -292,6 +292,63 @@ paths:
                     description: Describes what went wrong
                     type: string
                     example: "Invalid HLA locus"
+  /valid:
+    get:
+      tags:
+        - Validation
+      operationId: api.validate_controller_get
+      summary: Validate GL String
+      description: |
+        Given a GL String report whether it is valid or not
+      parameters:
+        - name: gl_string
+          in: query
+          description: GL String
+          schema:
+            type: string
+            example: "B*08:ASXJP+B*07:02"
+      responses:
+        200:
+          description: Validation Result
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  valid:
+                    description: Is GL String valid
+                    type: boolean
+                    example: true
+        404:
+          description: GL String didn't validate
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  valid:
+                    description: Is GL String valid
+                    type: boolean
+                    example: false
+                  message:
+                    description: Describes what went wrong
+                    type: string
+                    example: "Provided GL String is invalid: HLA-A*01:BLAH"
+                  cause:
+                    description: Explanation of why the GL String is not valid
+                    type: string
+                    example: "HLA-A*01:BLAH is not a valid GL Allele"
+        400:
+          description: Invalid GL String Form
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  message:
+                    description: Describes what went wrong
+                    type: string
+                    example: "Invalid HLA locus"
   /blend:
     post:
       tags:

api.py

@@ -17,18 +17,26 @@ def validate_controller():
             gl_string = request.json["gl_string"]
         except KeyError:
             return {"message": "gl_string not provided"}, 404
-        # Validate
-        try:
-            ard.validate(gl_string)
-            return {"valid": True}, 200
-        except InvalidAlleleError as e:
-            return {
-                "valid": False,
-                "message": f"Provided GL String is invalid: {gl_string}",
-                "cause": e.message,
-            }, 404
-        except PyArdError as e:
-            return {"message": e.message}, 400
+        return validate_gl(gl_string)
+
+
+def validate_controller_get(gl_string: str):
+    return validate_gl(gl_string)
+
+
+def validate_gl(gl_string):
+    # Validate
+    try:
+        ard.validate(gl_string)
+        return "Yes", 200
+    except InvalidAlleleError as e:
+        return {
+            "valid": False,
+            "message": f"Provided GL String is invalid: {gl_string}",
+            "cause": e.message,
+        }, 404
+    except PyArdError as e:
+        return {"message": e.message}, 400
 
 
 def redux_controller():