Merge pull request #223 from Eastern-Research-Group/feature/update-op…

…enapi-documentation Feature/update openapi documentation
USEPA · Aug 24, 2022 · 27c311d · 27c311d
2 parents d4b3055 + 7243c95
commit 27c311d
Showing 1 changed file with 98 additions and 33 deletions.
diff --git a/docs/csb-openapi.json b/docs/csb-openapi.json
@@ -275,6 +275,47 @@
         "parameters": [{ "$ref": "#/components/parameters/scan" }]
       }
     },
+    "/api/csb-data": {
+      "get": {
+        "summary": "/api/csb-data",
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "enrollmentClosed": {
+                      "type": "boolean",
+                      "example": true
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "message": {
+                      "type": "string",
+                      "example": "Unauthorized"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "tags": [],
+        "parameters": [{ "$ref": "#/components/parameters/scan" }]
+      }
+    },
     "/api/epa-data": {
       "get": {
         "summary": "/api/epa-data",
@@ -284,7 +325,21 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "type": "object"
+                  "type": "object",
+                  "properties": {
+                    "mail": {
+                      "type": "string",
+                      "example": "[email protected]"
+                    },
+                    "memberof": {
+                      "type": "string",
+                      "example": "csb_admin,csb_helpdesk"
+                    },
+                    "exp": {
+                      "type": "number",
+                      "example": 1661376902
+                    }
+                  }
                 }
               }
             }
@@ -310,18 +365,33 @@
         "parameters": [{ "$ref": "#/components/parameters/scan" }]
       }
     },
-    "/api/sam-data": {
+    "/api/bap-data": {
       "get": {
-        "summary": "/api/sam-data",
+        "summary": "/api/bap-data",
         "responses": {
           "200": {
             "description": "OK",
             "content": {
               "application/json": {
                 "schema": {
-                  "type": "array",
-                  "items": {
-                    "type": "object"
+                  "type": "object",
+                  "properties": {
+                    "samResults": {
+                      "type": "boolean",
+                      "example": true
+                    },
+                    "samEntities": {
+                      "type": "array",
+                      "items": {
+                        "type": "object"
+                      }
+                    },
+                    "rebateSubmissions": {
+                      "type": "array",
+                      "items": {
+                        "type": "object"
+                      }
+                    }
                   }
                 }
               }
@@ -351,9 +421,9 @@
         "parameters": [{ "$ref": "#/components/parameters/scan" }]
       }
     },
-    "/api/{bapComboKey}/storage/s3": {
+    "/api/{id}/{comboKey}/storage/s3": {
       "get": {
-        "summary": "/api/{bapComboKey}/storage/s3",
+        "summary": "/api/{id}/{comboKey}/storage/s3",
         "responses": {
           "200": {
             "description": "OK"
@@ -362,7 +432,15 @@
         "tags": [],
         "parameters": [
           {
-            "name": "bapComboKey",
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "comboKey",
             "in": "path",
             "required": true,
             "schema": {
@@ -373,7 +451,7 @@
         ]
       },
       "post": {
-        "summary": "/api/{bapComboKey}/storage/s3",
+        "summary": "/api/{id}/{comboKey}/storage/s3",
         "responses": {
           "200": {
             "description": "OK"
@@ -382,7 +460,15 @@
         "tags": [],
         "parameters": [
           {
-            "name": "bapComboKey",
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "comboKey",
             "in": "path",
             "required": true,
             "schema": {
@@ -505,28 +591,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "type": "object",
-                  "properties": {
-                    "userAccess": {
-                      "type": "boolean",
-                      "example": true
-                    },
-                    "formSchema": {
-                      "type": "object",
-                      "properties": {
-                        "url": {
-                          "type": "string",
-                          "example": "https://formmio/project/form/id"
-                        },
-                        "json": {
-                          "type": "object"
-                        }
-                      }
-                    },
-                    "submissionData": {
-                      "type": "object"
-                    }
-                  }
+                  "type": "object"
                 }
               }
             }