oe-python-template-example 0.0.10__tar.gz → 0.1.1__tar.gz

{oe_python_template_example-0.0.10 → oe_python_template_example-0.1.1}/.copier-answers.yml

@@ -1,4 +1,4 @@
-_commit: v0.3.9
+_commit: v0.4.3
 _src_path: gh:helmut-hoffer-von-ankershoffen/oe-python-template
 author_email: helmuthva@gmail.com
 author_github_username: helmut-hoffer-von-ankershoffen

{oe_python_template_example-0.0.10 → oe_python_template_example-0.1.1}/.pre-commit-config.yaml

@@ -14,6 +14,7 @@ repos:
     hooks:
       - id: python-check-blanket-noqa
       - id: python-check-blanket-type-ignore
+        exclude: "^examples/notebook.py$"
       - id: python-check-mock-methods
       - id: python-no-eval
       - id: python-no-log-warn

{oe_python_template_example-0.0.10 → oe_python_template_example-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template-example
-Version: 0.0.10
+Version: 0.1.1
 Summary: 🧠 Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
 Project-URL: Homepage, https://oe-python-template-example.readthedocs.io/en/latest/
 Project-URL: Documentation, https://oe-python-template-example.readthedocs.io/en/latest/
@@ -101,9 +101,9 @@ Use Cases:
 2) Consistent update of already scaffolded projects to benefit from new and improved features.
 3) Dummy CLI application and service demonstrating example usage of the generated directory structure and build pipeline
 
-## Scaffolding Instructions
+## Scaffolding
 
-Step 1: Install uv package manager and copier
+**Step 1**: Install uv package manager and copier
 ```shell
 if [[ "$OSTYPE" == "darwin"* ]]; then                 # Install dependencies for macOS X
   if ! command -v brew &> /dev/null; then             ## Install Homebrew if not present
@@ -119,31 +119,32 @@ fi
 uv tool install copier                                # Install copier as global tool
 ```
 
-Step 2: Now create an empty repo on GitHub and clone it to your local machine in a directory of your choice. Change to that directory.
+**Step 2**: Now create an empty repository on GitHubm, clone to your local machine, and change into it's directory.
 
-Step 3: Scaffold the project
+**Step 3**: Scaffold the project
 ```shell
 copier copy gh:helmut-hoffer-von-ankershoffen/oe-python-template .
 ```
-Step 4: Setup the local environment
+**Step 4**: Setup the local environment
 
 ```shell
 uv run nox -s setup_dev
 ```
 
-Step 5: Perform inital commit and push
+**Step 5**: Perform initial commit and push
 ```shell
 git add .
 git commit -m "feat: Initial commit"
+git push
 ```
 
 Visit your GitHub repository and check the Actions tab. The CI workflow should fail at the SonarQube step,
 as this external service is not yet configured for our new repository.
 
-Step 6: Follow the instructions in SERVICE_CONNECTIONS.md to setup the connections to external services
-such as Cloudcov, SonarQube Cloud, Read The Docs, Docker.io, GHCR.io and Streamlit Community Cloud.
+**Step 6**: Follow the [SERVICE_INSTRUCTIONS.md](instructions) to wire up
+external services such as Cloudcov, SonarQube Cloud, Read The Docs, Docker.io, GHCR.io and Streamlit Community Cloud.
 
-Step 7: Release the first versions
+**Step 7**: Release the first versions
 ```shell
 ./bump
 ```
@@ -166,24 +167,36 @@ If you don't have uv installed follow [these instructions](https://docs.astral.s
 pip install oe-python-template-example        # add dependency to your project
 ```
 
-Executing the command line interface (CLI) is just as easy:
+Executing the command line interface (CLI) in an isolated Python environment is just as easy:
 
 ```shell
-uvx oe-python-template-example
+uvx oe-python-template-example hello-world     # prints "Hello, world! [..]"
+uvx oe-python-template-example serve           # serves webservice API
+uvx oe-python-template-example serve --port=4711 # serves webservice API on port 4711
 ```
 
+Notes:
+* The API is versioned, mounted at ```/api/v1``` resp. ```/api/v2```
+* While serving the webservice API go to [http://127.0.0.1:8000/api/v1/hello-world](http://127.0.0.1:8000/api/v1/hello-world) to see the respons of the ```hello-world``` operation.
+* Interactive documentation is provided at [http://127.0.0.1:8000/api/docs](http://127.0.0.1:8000/api/docs)
+
+
 The CLI provides extensive help:
 
 ```shell
 uvx oe-python-template-example --help                # all CLI commands
 uvx oe-python-template-example hello-world --help    # help for specific command
+uvx oe-python-template-example echo --help
+uvx oe-python-template-example openapi --help
+uvx oe-python-template-example serve --help
 ```
 
 
-## Highlights
+## Operational Excellence
 
-* Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
-* Various Examples:
+This project is designed with operational excellence in mind, using modern Python tooling and practices. It includes:
+
+* Various examples demonstrating usage:
   - [Simple Python script](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/script.py)
   - [Streamlit web application](https://oe-python-template-example.streamlit.app/) deployed on [Streamlit Community Cloud](https://streamlit.io/cloud)
   - [Jupyter](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/notebook.ipynb) and [Marimo](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/notebook.py) notebook
@@ -199,6 +212,9 @@ uvx oe-python-template-example hello-world --help    # help for specific command
 
 ## Usage Examples
 
+The following examples run from source. Clone this repository first using
+`git clone git@github.com:helmut-hoffer-von-ankershoffen/oe-python-template-example.git`.
+
 ### Minimal Python Script:
 
 ```python
@@ -240,7 +256,7 @@ uv run streamlit run examples/streamlit.py          # Serve on localhost:8501, o
 ... or run within VSCode
 
 ```shell
-uv sync --all-extras                                # Install ipykernel dependency part of the examples extra, see pyproject.toml
+uv sync --all-extras                                # Install dependencies required for examples such as Juypyter kernel, see pyproject.toml
 ```
 Install the [Jupyter extension for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter)
 
@@ -337,7 +353,10 @@ docker compose run oe-python-template-example echo "Lorem" --json
 docker compose run oe-python-template-example openapi
 docker compose run oe-python-template-example openapi --output-format=json
 docker compose up
-curl http://127.0.0.1 8000
+curl http://127.0.0.1:8000/api/v1/hello-world
+curl http://127.0.0.1:8000/api/v1/docs
+curl http://127.0.0.1:8000/api/v2/hello-world
+curl http://127.0.0.1:8000/api/v2/docs
 ```
 
 ## Extra: Lorem Ipsum

{oe_python_template_example-0.0.10 → oe_python_template_example-0.1.1}/README.md

@@ -40,9 +40,9 @@ Use Cases:
 2) Consistent update of already scaffolded projects to benefit from new and improved features.
 3) Dummy CLI application and service demonstrating example usage of the generated directory structure and build pipeline
 
-## Scaffolding Instructions
+## Scaffolding
 
-Step 1: Install uv package manager and copier
+**Step 1**: Install uv package manager and copier
 ```shell
 if [[ "$OSTYPE" == "darwin"* ]]; then                 # Install dependencies for macOS X
   if ! command -v brew &> /dev/null; then             ## Install Homebrew if not present
@@ -58,31 +58,32 @@ fi
 uv tool install copier                                # Install copier as global tool
 ```
 
-Step 2: Now create an empty repo on GitHub and clone it to your local machine in a directory of your choice. Change to that directory.
+**Step 2**: Now create an empty repository on GitHubm, clone to your local machine, and change into it's directory.
 
-Step 3: Scaffold the project
+**Step 3**: Scaffold the project
 ```shell
 copier copy gh:helmut-hoffer-von-ankershoffen/oe-python-template .
 ```
-Step 4: Setup the local environment
+**Step 4**: Setup the local environment
 
 ```shell
 uv run nox -s setup_dev
 ```
 
-Step 5: Perform inital commit and push
+**Step 5**: Perform initial commit and push
 ```shell
 git add .
 git commit -m "feat: Initial commit"
+git push
 ```
 
 Visit your GitHub repository and check the Actions tab. The CI workflow should fail at the SonarQube step,
 as this external service is not yet configured for our new repository.
 
-Step 6: Follow the instructions in SERVICE_CONNECTIONS.md to setup the connections to external services
-such as Cloudcov, SonarQube Cloud, Read The Docs, Docker.io, GHCR.io and Streamlit Community Cloud.
+**Step 6**: Follow the [SERVICE_INSTRUCTIONS.md](instructions) to wire up
+external services such as Cloudcov, SonarQube Cloud, Read The Docs, Docker.io, GHCR.io and Streamlit Community Cloud.
 
-Step 7: Release the first versions
+**Step 7**: Release the first versions
 ```shell
 ./bump
 ```
@@ -105,24 +106,36 @@ If you don't have uv installed follow [these instructions](https://docs.astral.s
 pip install oe-python-template-example        # add dependency to your project
 ```
 
-Executing the command line interface (CLI) is just as easy:
+Executing the command line interface (CLI) in an isolated Python environment is just as easy:
 
 ```shell
-uvx oe-python-template-example
+uvx oe-python-template-example hello-world     # prints "Hello, world! [..]"
+uvx oe-python-template-example serve           # serves webservice API
+uvx oe-python-template-example serve --port=4711 # serves webservice API on port 4711
 ```
 
+Notes:
+* The API is versioned, mounted at ```/api/v1``` resp. ```/api/v2```
+* While serving the webservice API go to [http://127.0.0.1:8000/api/v1/hello-world](http://127.0.0.1:8000/api/v1/hello-world) to see the respons of the ```hello-world``` operation.
+* Interactive documentation is provided at [http://127.0.0.1:8000/api/docs](http://127.0.0.1:8000/api/docs)
+
+
 The CLI provides extensive help:
 
 ```shell
 uvx oe-python-template-example --help                # all CLI commands
 uvx oe-python-template-example hello-world --help    # help for specific command
+uvx oe-python-template-example echo --help
+uvx oe-python-template-example openapi --help
+uvx oe-python-template-example serve --help
 ```
 
 
-## Highlights
+## Operational Excellence
 
-* Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
-* Various Examples:
+This project is designed with operational excellence in mind, using modern Python tooling and practices. It includes:
+
+* Various examples demonstrating usage:
   - [Simple Python script](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/script.py)
   - [Streamlit web application](https://oe-python-template-example.streamlit.app/) deployed on [Streamlit Community Cloud](https://streamlit.io/cloud)
   - [Jupyter](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/notebook.ipynb) and [Marimo](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/notebook.py) notebook
@@ -138,6 +151,9 @@ uvx oe-python-template-example hello-world --help    # help for specific command
 
 ## Usage Examples
 
+The following examples run from source. Clone this repository first using
+`git clone git@github.com:helmut-hoffer-von-ankershoffen/oe-python-template-example.git`.
+
 ### Minimal Python Script:
 
 ```python
@@ -179,7 +195,7 @@ uv run streamlit run examples/streamlit.py          # Serve on localhost:8501, o
 ... or run within VSCode
 
 ```shell
-uv sync --all-extras                                # Install ipykernel dependency part of the examples extra, see pyproject.toml
+uv sync --all-extras                                # Install dependencies required for examples such as Juypyter kernel, see pyproject.toml
 ```
 Install the [Jupyter extension for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter)
 
@@ -276,7 +292,10 @@ docker compose run oe-python-template-example echo "Lorem" --json
 docker compose run oe-python-template-example openapi
 docker compose run oe-python-template-example openapi --output-format=json
 docker compose up
-curl http://127.0.0.1 8000
+curl http://127.0.0.1:8000/api/v1/hello-world
+curl http://127.0.0.1:8000/api/v1/docs
+curl http://127.0.0.1:8000/api/v2/hello-world
+curl http://127.0.0.1:8000/api/v2/docs
 ```
 
 ## Extra: Lorem Ipsum

oe_python_template_example-0.1.1/VERSION

@@ -0,0 +1 @@
+0.1.1

{oe_python_template_example-0.0.10 → oe_python_template_example-0.1.1}/_readme_main.md

@@ -5,9 +5,9 @@ Use Cases:
 2) Consistent update of already scaffolded projects to benefit from new and improved features.
 3) Dummy CLI application and service demonstrating example usage of the generated directory structure and build pipeline
 
-## Scaffolding Instructions
+## Scaffolding
 
-Step 1: Install uv package manager and copier
+**Step 1**: Install uv package manager and copier
 ```shell
 if [[ "$OSTYPE" == "darwin"* ]]; then                 # Install dependencies for macOS X
   if ! command -v brew &> /dev/null; then             ## Install Homebrew if not present
@@ -23,31 +23,32 @@ fi
 uv tool install copier                                # Install copier as global tool
 ```
 
-Step 2: Now create an empty repo on GitHub and clone it to your local machine in a directory of your choice. Change to that directory.
+**Step 2**: Now create an empty repository on GitHubm, clone to your local machine, and change into it's directory.
 
-Step 3: Scaffold the project
+**Step 3**: Scaffold the project
 ```shell
 copier copy gh:helmut-hoffer-von-ankershoffen/oe-python-template .
 ```
-Step 4: Setup the local environment
+**Step 4**: Setup the local environment
 
 ```shell
 uv run nox -s setup_dev
 ```
 
-Step 5: Perform inital commit and push
+**Step 5**: Perform initial commit and push
 ```shell
 git add .
 git commit -m "feat: Initial commit"
+git push
 ```
 
 Visit your GitHub repository and check the Actions tab. The CI workflow should fail at the SonarQube step,
 as this external service is not yet configured for our new repository.
 
-Step 6: Follow the instructions in SERVICE_CONNECTIONS.md to setup the connections to external services
-such as Cloudcov, SonarQube Cloud, Read The Docs, Docker.io, GHCR.io and Streamlit Community Cloud.
+**Step 6**: Follow the [SERVICE_INSTRUCTIONS.md](instructions) to wire up
+external services such as Cloudcov, SonarQube Cloud, Read The Docs, Docker.io, GHCR.io and Streamlit Community Cloud.
 
-Step 7: Release the first versions
+**Step 7**: Release the first versions
 ```shell
 ./bump
 ```
@@ -70,24 +71,36 @@ If you don't have uv installed follow [these instructions](https://docs.astral.s
 pip install oe-python-template-example        # add dependency to your project
 ```
 
-Executing the command line interface (CLI) is just as easy:
+Executing the command line interface (CLI) in an isolated Python environment is just as easy:
 
 ```shell
-uvx oe-python-template-example
+uvx oe-python-template-example hello-world     # prints "Hello, world! [..]"
+uvx oe-python-template-example serve           # serves webservice API
+uvx oe-python-template-example serve --port=4711 # serves webservice API on port 4711
 ```
 
+Notes:
+* The API is versioned, mounted at ```/api/v1``` resp. ```/api/v2```
+* While serving the webservice API go to [http://127.0.0.1:8000/api/v1/hello-world](http://127.0.0.1:8000/api/v1/hello-world) to see the respons of the ```hello-world``` operation.
+* Interactive documentation is provided at [http://127.0.0.1:8000/api/docs](http://127.0.0.1:8000/api/docs)
+
+
 The CLI provides extensive help:
 
 ```shell
 uvx oe-python-template-example --help                # all CLI commands
 uvx oe-python-template-example hello-world --help    # help for specific command
+uvx oe-python-template-example echo --help
+uvx oe-python-template-example openapi --help
+uvx oe-python-template-example serve --help
 ```
 
 
-## Highlights
+## Operational Excellence
 
-* Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
-* Various Examples:
+This project is designed with operational excellence in mind, using modern Python tooling and practices. It includes:
+
+* Various examples demonstrating usage:
   - [Simple Python script](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/script.py)
   - [Streamlit web application](https://oe-python-template-example.streamlit.app/) deployed on [Streamlit Community Cloud](https://streamlit.io/cloud)
   - [Jupyter](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/notebook.ipynb) and [Marimo](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/examples/notebook.py) notebook
@@ -103,6 +116,9 @@ uvx oe-python-template-example hello-world --help    # help for specific command
 
 ## Usage Examples
 
+The following examples run from source. Clone this repository first using
+`git clone git@github.com:helmut-hoffer-von-ankershoffen/oe-python-template-example.git`.
+
 ### Minimal Python Script:
 
 ```python
@@ -144,7 +160,7 @@ uv run streamlit run examples/streamlit.py          # Serve on localhost:8501, o
 ... or run within VSCode
 
 ```shell
-uv sync --all-extras                                # Install ipykernel dependency part of the examples extra, see pyproject.toml
+uv sync --all-extras                                # Install dependencies required for examples such as Juypyter kernel, see pyproject.toml
 ```
 Install the [Jupyter extension for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter)
 
@@ -241,7 +257,10 @@ docker compose run oe-python-template-example echo "Lorem" --json
 docker compose run oe-python-template-example openapi
 docker compose run oe-python-template-example openapi --output-format=json
 docker compose up
-curl http://127.0.0.1 8000
+curl http://127.0.0.1:8000/api/v1/hello-world
+curl http://127.0.0.1:8000/api/v1/docs
+curl http://127.0.0.1:8000/api/v2/hello-world
+curl http://127.0.0.1:8000/api/v2/docs
 ```
 
 ## Extra: Lorem Ipsum

oe_python_template_example-0.1.1/docs/source/_static/openapi_v1.json

@@ -0,0 +1,262 @@
+{
+  "openapi": "3.1.0",
+  "info": {
+    "title": "OE Python Template Example",
+    "termsOfService": "https://oe-python-template-example.readthedocs.io/en/latest/",
+    "contact": {
+      "name": "Helmut Hoffer von Ankershoffen",
+      "url": "https://github.com/helmut-hoffer-von-ankershoffen",
+      "email": "helmuthva@gmail.com"
+    },
+    "version": "1.0.0"
+  },
+  "paths": {
+    "/health": {
+      "get": {
+        "tags": [
+          "Observability"
+        ],
+        "summary": "Health",
+        "description": "Check the health of the service.\n\nThis endpoint returns the health status of the service.\nThe health status can be either UP or DOWN.\nIf the service is healthy, the status will be UP.\nIf the service is unhealthy, the status will be DOWN and a reason will be provided.\nThe response will have a 200 OK status code if the service is healthy,\nand a 500 Internal Server Error status code if the service is unhealthy.\n\nArgs:\n    service (Annotated[Service, Depends): _description_\n    response (Response): _description_\n\nReturns:\n    Health: The health status of the service.",
+        "operationId": "health_health_get",
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Health"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/healthz": {
+      "get": {
+        "tags": [
+          "Observability"
+        ],
+        "summary": "Health",
+        "description": "Check the health of the service.\n\nThis endpoint returns the health status of the service.\nThe health status can be either UP or DOWN.\nIf the service is healthy, the status will be UP.\nIf the service is unhealthy, the status will be DOWN and a reason will be provided.\nThe response will have a 200 OK status code if the service is healthy,\nand a 500 Internal Server Error status code if the service is unhealthy.\n\nArgs:\n    service (Annotated[Service, Depends): _description_\n    response (Response): _description_\n\nReturns:\n    Health: The health status of the service.",
+        "operationId": "health_healthz_get",
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Health"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/hello-world": {
+      "get": {
+        "tags": [
+          "Basics"
+        ],
+        "summary": "Hello World",
+        "description": "Return a hello world message.\n\nReturns:\n    HelloWorldResponse: A response containing the hello world message.",
+        "operationId": "hello_world_hello_world_get",
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HelloWorldResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/echo": {
+      "post": {
+        "tags": [
+          "Basics"
+        ],
+        "summary": "Echo",
+        "description": "Echo back the provided text.\n\nArgs:\n    request (EchoRequest): The request containing the text to echo back.\n\nReturns:\n    EchoResponse: A response containing the echoed text.\n\nRaises:\n    422 Unprocessable Entity: If text is not provided or empty.",
+        "operationId": "echo_echo_post",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/EchoRequest"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/EchoResponse"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Validation Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HTTPValidationError"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "EchoRequest": {
+        "properties": {
+          "text": {
+            "type": "string",
+            "minLength": 1,
+            "title": "Text",
+            "description": "The text to echo back",
+            "examples": [
+              "Hello, world!"
+            ]
+          }
+        },
+        "type": "object",
+        "required": [
+          "text"
+        ],
+        "title": "EchoRequest",
+        "description": "Request model for echo endpoint."
+      },
+      "EchoResponse": {
+        "properties": {
+          "message": {
+            "type": "string",
+            "minLength": 1,
+            "title": "Message",
+            "description": "The message content",
+            "examples": [
+              "Hello, world!"
+            ]
+          }
+        },
+        "type": "object",
+        "required": [
+          "message"
+        ],
+        "title": "EchoResponse",
+        "description": "Response model for echo endpoint."
+      },
+      "HTTPValidationError": {
+        "properties": {
+          "detail": {
+            "items": {
+              "$ref": "#/components/schemas/ValidationError"
+            },
+            "type": "array",
+            "title": "Detail"
+          }
+        },
+        "type": "object",
+        "title": "HTTPValidationError"
+      },
+      "Health": {
+        "properties": {
+          "status": {
+            "$ref": "#/components/schemas/_HealthStatus"
+          },
+          "reason": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Reason"
+          }
+        },
+        "type": "object",
+        "required": [
+          "status"
+        ],
+        "title": "Health",
+        "description": "Health status model.\n\nArgs:\n    BaseModel (_type_): _description_"
+      },
+      "HelloWorldResponse": {
+        "properties": {
+          "message": {
+            "type": "string",
+            "title": "Message",
+            "description": "The hello world message",
+            "examples": [
+              "Hello, world!"
+            ]
+          }
+        },
+        "type": "object",
+        "required": [
+          "message"
+        ],
+        "title": "HelloWorldResponse",
+        "description": "Response model for hello-world endpoint."
+      },
+      "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"
+      },
+      "_HealthStatus": {
+        "type": "string",
+        "enum": [
+          "UP",
+          "DOWN"
+        ],
+        "title": "_HealthStatus",
+        "description": "Health status enumeration.\n\nArgs:\n    StrEnum (_type_): _description_"
+      }
+    }
+  }
+}