Merge pull request #158 from Eastern-Research-Group/update-openapi-an…

…d-build-node-ver Updated build node version and made openapi files consistent
Eastern-Research-Group · Nov 25, 2024 · 2b81012 · 2b81012
2 parents e4b1ed9 + c74d840
commit 2b81012
Show file tree

Hide file tree

Showing 5 changed files with 91 additions and 5 deletions.
diff --git a/.github/workflows/dev.yml b/.github/workflows/dev.yml
@@ -66,7 +66,7 @@ jobs:
       # Set up node and npm
       - uses: actions/setup-node@v4
         with:
-          node-version: "20"
+          node-version: "22"
 
       - name: Install dependencies
         run: npm install

diff --git a/.github/workflows/production.yml b/.github/workflows/production.yml
@@ -24,7 +24,7 @@ jobs:
       # Set up node and npm
       - uses: actions/setup-node@v4
         with:
-          node-version: "20"
+          node-version: "22"
 
       - name: Install dependencies
         run: npm install --omit=dev

diff --git a/.github/workflows/staging.yml b/.github/workflows/staging.yml
@@ -67,7 +67,7 @@ jobs:
       # Set up node and npm
       - uses: actions/setup-node@v4
         with:
-          node-version: "20"
+          node-version: "22"
 
       - name: Install dependencies
         run: npm install

diff --git a/app/app/public/api-docs/lew_openapi.json b/app/app/public/api-docs/lew_openapi.json
@@ -84,6 +84,38 @@
           }
         }
       }
+    },
+    "/v1/health": {
+      "get": {
+        "tags": ["Rainfall Erosivity"],
+        "summary": "Healthcheck",
+        "description": "Healthcheck.",
+        "operationId": "healthCheck",
+        "parameters": [
+          {
+            "in": "header",
+            "name": "X-Api-Key",
+            "description": "API key used to access EPA web service resources. The below default value key is used for testing purposes only. Web service consumers should <a target=\"_blank\" href=\"..\\api_key_signup.html\">obtain their own API key</a>",
+            "schema": {
+              "type": "string",
+              "default": "yCM9DKRltA4gTGovk2naSvodO5iUDBCT7FAJ3CF5"
+            },
+            "required": true
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HealthCheckOutput"
+                }
+              }
+            }
+          }
+        }
+      }
     }
   },
   "externalDocs": {
@@ -142,7 +174,18 @@
             "example": 0.476
           }
         },
-        "required": ["factor"]
+        "required": ["rfactor"]
+      },
+      "HealthCheckOutput": {
+        "type": "object",
+        "title": "HealthCheck Output",
+        "properties": {
+          "status": {
+            "type": "string",
+            "example": "UP"
+          }
+        },
+        "required": ["status"]
       }
     }
   }

diff --git a/app/app/public/api-docs/lew_openapi_all.json b/app/app/public/api-docs/lew_openapi_all.json
@@ -96,6 +96,38 @@
           }
         }
       }
+    },
+    "/v1/health": {
+      "get": {
+        "tags": ["Rainfall Erosivity"],
+        "summary": "Healthcheck",
+        "description": "Healthcheck.",
+        "operationId": "healthCheck",
+        "parameters": [
+          {
+            "in": "header",
+            "name": "X-Api-Key",
+            "description": "API key used to access EPA web service resources. The below default value key is used for testing purposes only. Web service consumers should <a target=\"_blank\" href=\"..\\api_key_signup.html\">obtain their own API key</a>",
+            "schema": {
+              "type": "string",
+              "default": "yCM9DKRltA4gTGovk2naSvodO5iUDBCT7FAJ3CF5"
+            },
+            "required": true
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HealthCheckOutput"
+                }
+              }
+            }
+          }
+        }
+      }
     }
   },
   "externalDocs": {
@@ -154,7 +186,18 @@
             "example": 0.476
           }
         },
-        "required": ["factor"]
+        "required": ["rfactor"]
+      },
+      "HealthCheckOutput": {
+        "type": "object",
+        "title": "HealthCheck Output",
+        "properties": {
+          "status": {
+            "type": "string",
+            "example": "UP"
+          }
+        },
+        "required": ["status"]
       }
     }
   }