fix lint errs

Signed-off-by: Steve Taylor <[email protected]>

Author: sbtaylor15

.vscode/launch.json

@@ -7,7 +7,7 @@
       "request": "launch",
       "program": "${file}",
       "console": "integratedTerminal",
-      "env": {"DB_PASS": "InS0mn1a+15", "DB_PORT": "55432"}
+      "env": { "DB_PASS": "InS0mn1a+15", "DB_PORT": "55432" }
     }
   ]
 }

README.md

@@ -19,18 +19,18 @@ RestAPI endpoint for retrieving SBOM data to a component
 
 ## Path Table
 
-| Method | Path | Description |
-| --- | --- | --- |
-| GET | [/health](#gethealth) | Health |
-| GET | [/msapi/sbom](#getmsapisbom) | Export Sbom |
+| Method | Path                         | Description |
+|--------|------------------------------|-------------|
+| GET    | [/health](#gethealth)        | Health      |
+| GET    | [/msapi/sbom](#getmsapisbom) | Export Sbom |
 
 ## Reference Table
 
-| Name | Path | Description |
-| --- | --- | --- |
-| HTTPValidationError | [#/components/schemas/HTTPValidationError](#componentsschemashttpvalidationerror) |  |
-| StatusMsg | [#/components/schemas/StatusMsg](#componentsschemasstatusmsg) |  |
-| ValidationError | [#/components/schemas/ValidationError](#componentsschemasvalidationerror) |  |
+| Name                | Path                                                                              | Description |
+|---------------------|-----------------------------------------------------------------------------------|-------------|
+| HTTPValidationError | [#/components/schemas/HTTPValidationError](#componentsschemashttpvalidationerror) |             |
+| StatusMsg           | [#/components/schemas/StatusMsg](#componentsschemasstatusmsg)                     |             |
+| ValidationError     | [#/components/schemas/ValidationError](#componentsschemasvalidationerror)         |             |
 
 ## Path Details
 

openapi.json

@@ -1 +1,136 @@
-{"openapi":"3.1.0","info":{"title":"ms-sbom-export","description":"RestAPI endpoint for retrieving SBOM data to a component","contact":{"name":"DeployHub SBOM Export","url":"https://github.com/DeployHubProject/DeployHub-Pro/issues","email":"[email protected]"},"license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0.html"},"version":"10.0.0"},"servers":[{"url":"http://localhost:5004","description":"Local Server"}],"paths":{"/health":{"get":{"tags":["health"],"summary":"Health","description":"This health check end point used by Kubernetes","operationId":"health_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusMsg"}}}}}}},"/msapi/sbom":{"get":{"tags":["sbom"],"summary":"Export Sbom","description":"This is the end point used to create PDF of the Application/Component SBOM","operationId":"export_sbom_msapi_sbom_get","parameters":[{"name":"compid","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Compid"}},{"name":"appid","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Appid"}},{"name":"envid","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Envid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"StatusMsg":{"properties":{"status":{"type":"string","title":"Status","default":""},"service_name":{"type":"string","title":"Service Name","default":""}},"type":"object","title":"StatusMsg"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"tags":[{"name":"health","description":"health check end point"},{"name":"sbom","description":"Retrieve Package Dependencies end point"}]}
+{
+  "openapi": "3.1.0",
+  "info": {
+    "title": "ms-sbom-export",
+    "description": "RestAPI endpoint for retrieving SBOM data to a component",
+    "contact": {
+      "name": "DeployHub SBOM Export",
+      "url": "https://github.com/DeployHubProject/DeployHub-Pro/issues",
+      "email": "[email protected]"
+    },
+    "license": {
+      "name": "Apache 2.0",
+      "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
+    },
+    "version": "10.0.0"
+  },
+  "servers": [
+    { "url": "http://localhost:5004", "description": "Local Server" }
+  ],
+  "paths": {
+    "/health": {
+      "get": {
+        "tags": ["health"],
+        "summary": "Health",
+        "description": "This health check end point used by Kubernetes",
+        "operationId": "health_health_get",
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": { "$ref": "#/components/schemas/StatusMsg" }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/msapi/sbom": {
+      "get": {
+        "tags": ["sbom"],
+        "summary": "Export Sbom",
+        "description": "This is the end point used to create PDF of the Application/Component SBOM",
+        "operationId": "export_sbom_msapi_sbom_get",
+        "parameters": [
+          {
+            "name": "compid",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "anyOf": [{ "type": "string" }, { "type": "null" }],
+              "title": "Compid"
+            }
+          },
+          {
+            "name": "appid",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "anyOf": [{ "type": "string" }, { "type": "null" }],
+              "title": "Appid"
+            }
+          },
+          {
+            "name": "envid",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "anyOf": [{ "type": "string" }, { "type": "null" }],
+              "title": "Envid"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": { "application/json": { "schema": {} } }
+          },
+          "422": {
+            "description": "Validation Error",
+            "content": {
+              "application/json": {
+                "schema": { "$ref": "#/components/schemas/HTTPValidationError" }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "HTTPValidationError": {
+        "properties": {
+          "detail": {
+            "items": { "$ref": "#/components/schemas/ValidationError" },
+            "type": "array",
+            "title": "Detail"
+          }
+        },
+        "type": "object",
+        "title": "HTTPValidationError"
+      },
+      "StatusMsg": {
+        "properties": {
+          "status": { "type": "string", "title": "Status", "default": "" },
+          "service_name": {
+            "type": "string",
+            "title": "Service Name",
+            "default": ""
+          }
+        },
+        "type": "object",
+        "title": "StatusMsg"
+      },
+      "ValidationError": {
+        "properties": {
+          "loc": {
+            "items": { "anyOf": [{ "type": "string" }, { "type": "integer" }] },
+            "type": "array",
+            "title": "Location"
+          },
+          "msg": { "type": "string", "title": "Message" },
+          "type": { "type": "string", "title": "Error Type" }
+        },
+        "type": "object",
+        "required": ["loc", "msg", "type"],
+        "title": "ValidationError"
+      }
+    }
+  },
+  "tags": [
+    { "name": "health", "description": "health check end point" },
+    { "name": "sbom", "description": "Retrieve Package Dependencies end point" }
+  ]
+}