Update OpenAPI docs to include new Formio PDF submission routes

USEPA · Jan 23, 2025 · f5abb29 · f5abb29
1 parent 1680023
commit f5abb29
Showing 1 changed file with 63 additions and 0 deletions.
diff --git a/docs/csb-openapi.json b/docs/csb-openapi.json
@@ -373,6 +373,27 @@
         }
       }
     },
+    "/api/formio/2022/pdf/{formType}/{mongoId}": {
+      "get": {
+        "summary": "Download a PDF of a 2022 form submission.",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/formType"
+          },
+          {
+            "$ref": "#/components/parameters/mongoId"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK"
+          },
+          "401": {
+            "$ref": "#/components/responses/Unauthorized"
+          }
+        }
+      }
+    },
     "/api/formio/2022/frf-submissions": {
       "get": {
         "summary": "Get user's 2022 FRF submissions from Formio.",
@@ -744,6 +765,27 @@
         }
       }
     },
+    "/api/formio/2023/pdf/{formType}/{mongoId}": {
+      "get": {
+        "summary": "Download a PDF of a 2023 form submission.",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/formType"
+          },
+          {
+            "$ref": "#/components/parameters/mongoId"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK"
+          },
+          "401": {
+            "$ref": "#/components/responses/Unauthorized"
+          }
+        }
+      }
+    },
     "/api/formio/2023/frf-submissions": {
       "get": {
         "summary": "Get user's 2023 FRF submissions from Formio.",
@@ -1108,6 +1150,27 @@
         }
       }
     },
+    "/api/formio/2024/pdf/{formType}/{mongoId}": {
+      "get": {
+        "summary": "Download a PDF of a 2024 form submission.",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/formType"
+          },
+          {
+            "$ref": "#/components/parameters/mongoId"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK"
+          },
+          "401": {
+            "$ref": "#/components/responses/Unauthorized"
+          }
+        }
+      }
+    },
     "/api/formio/2024/frf-submissions": {
       "get": {
         "summary": "Get user's 2024 FRF submissions from Formio.",