Merge pull request #1277 from Sage-Bionetworks/develop-version-endpoint-FDS-698

Add API endpoint that returns the current version of schematic

Author: GiaJordan

.github/workflows/docker_build.yml

@@ -25,6 +25,9 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v2
 
+      - name: Set env variable for version tag
+        run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
+
       - name: Log in to the Container registry
         uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9
         with:
@@ -41,10 +44,14 @@ jobs:
             type=ref,event=branch
             type=ref,event=pr
             type=semver,pattern={{raw}}
+
       - name: Build and push Docker image
         uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc
         with:
           file: schematic_api/Dockerfile
           push: true
           tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}
+          labels: ${{ steps.meta.outputs.labels }}
+          build-args: |
+            TAG=${{ env.RELEASE_VERSION }}
+            

schematic_api/Dockerfile

@@ -1,5 +1,8 @@
 FROM tiangolo/uwsgi-nginx-flask:python3.10
 
+# add version tag as a build argument
+ARG TAG
+
 # the environment variables defined here are the default
 # and can be overwritten by docker run -e VARIABLE = XX
 # or can be overwritten by .env when using docker compose
@@ -15,7 +18,8 @@ ENV PYTHONFAULTHANDLER=1 \
     APP_DIR=/app/app \
     ROOT=/ \
     UWSGI_INI=/app/uwsgi.ini \
-    NGINX_WORKER_PROCESSES=1
+    NGINX_WORKER_PROCESSES=1 \
+    VERSION=$TAG
 
 # Note: 
 # The starting number of uWSGI processes is controlled by the variable UWSGI_CHEAPER, by default set to 2.

schematic_api/api/openapi/api.yaml

@@ -1262,4 +1262,22 @@ paths:
                           Family History,FamilyHistory,TBD,False,True,," If Diagnosis is ""Cancer"" then ""Family History"" is required",Patient                  
       tags:
         - Visualization Operations
+
+  /version:
+    get:
+      summary: Get the version of schematic currently being used
+      description: >-
+        Get the version of schematic that is currently deployed and being used
+      operationId: schematic_api.api.routes.get_schematic_version
+      responses:
+        "200":
+          description: Returns a JSON String containing the version of schematic.
+          content:
+            text/plain:
+              schema:
+                type: string
+        "500":
+          description: Schematic version was not able to be identified.
+      tags:
+        - Version
 

schematic_api/api/routes.py

@@ -815,3 +815,14 @@ def get_nodes_display_names(schema_url: str, node_list: list[str]) -> list:
     node_display_names = gen.get_nodes_display_names(node_list, mm_graph)
     return node_display_names
 
+def get_schematic_version() -> str:
+    """
+    Return the current version of schematic
+    """
+    if "VERSION" in os.environ:
+        version = os.environ["VERSION"]
+    else:
+        raise NotImplementedError(
+            "Using this endpoint to check the version of schematic is only supported when the API is running in a docker container."
+        )
+    return version