|
1 | | -Traceback (most recent call last): |
2 | | - File "/Users/helmut/Code/oe-python-template-example/.nox/docs-3-13/bin/oe-python-template-example", line 4, in <module> |
3 | | - from oe_python_template_example.cli import cli |
4 | | - File "/Users/helmut/Code/oe-python-template-example/src/oe_python_template_example/cli.py", line 7, in <module> |
5 | | - import typer |
6 | | - File "/Users/helmut/Code/oe-python-template-example/.nox/docs-3-13/lib/python3.13/site-packages/typer/__init__.py", line 29, in <module> |
7 | | - from .main import Typer as Typer |
8 | | - File "<frozen importlib._bootstrap>", line 1360, in _find_and_load |
9 | | - File "<frozen importlib._bootstrap>", line 1331, in _find_and_load_unlocked |
10 | | - File "<frozen importlib._bootstrap>", line 935, in _load_unlocked |
11 | | - File "<frozen importlib._bootstrap_external>", line 1022, in exec_module |
12 | | - File "<frozen importlib._bootstrap_external>", line 1118, in get_code |
13 | | - File "<frozen importlib._bootstrap_external>", line 1218, in get_data |
14 | | -KeyboardInterrupt |
| 1 | +components: |
| 2 | + schemas: |
| 3 | + EchoRequest: |
| 4 | + description: Request model for echo endpoint. |
| 5 | + properties: |
| 6 | + text: |
| 7 | + description: The text to echo back |
| 8 | + examples: |
| 9 | + - Hello, world! |
| 10 | + minLength: 1 |
| 11 | + title: Text |
| 12 | + type: string |
| 13 | + required: |
| 14 | + - text |
| 15 | + title: EchoRequest |
| 16 | + type: object |
| 17 | + EchoResponse: |
| 18 | + description: Response model for echo endpoint. |
| 19 | + properties: |
| 20 | + message: |
| 21 | + description: The message content |
| 22 | + examples: |
| 23 | + - Hello, world! |
| 24 | + minLength: 1 |
| 25 | + title: Message |
| 26 | + type: string |
| 27 | + required: |
| 28 | + - message |
| 29 | + title: EchoResponse |
| 30 | + type: object |
| 31 | + HTTPValidationError: |
| 32 | + properties: |
| 33 | + detail: |
| 34 | + items: |
| 35 | + $ref: '#/components/schemas/ValidationError' |
| 36 | + title: Detail |
| 37 | + type: array |
| 38 | + title: HTTPValidationError |
| 39 | + type: object |
| 40 | + Health: |
| 41 | + description: Health status model. |
| 42 | + properties: |
| 43 | + reason: |
| 44 | + anyOf: |
| 45 | + - type: string |
| 46 | + - type: 'null' |
| 47 | + title: Reason |
| 48 | + status: |
| 49 | + $ref: '#/components/schemas/_HealthStatus' |
| 50 | + required: |
| 51 | + - status |
| 52 | + title: Health |
| 53 | + type: object |
| 54 | + HelloWorldResponse: |
| 55 | + description: Response model for hello-world endpoint. |
| 56 | + properties: |
| 57 | + message: |
| 58 | + description: The hello world message |
| 59 | + examples: |
| 60 | + - Hello, world! |
| 61 | + title: Message |
| 62 | + type: string |
| 63 | + required: |
| 64 | + - message |
| 65 | + title: HelloWorldResponse |
| 66 | + type: object |
| 67 | + ValidationError: |
| 68 | + properties: |
| 69 | + loc: |
| 70 | + items: |
| 71 | + anyOf: |
| 72 | + - type: string |
| 73 | + - type: integer |
| 74 | + title: Location |
| 75 | + type: array |
| 76 | + msg: |
| 77 | + title: Message |
| 78 | + type: string |
| 79 | + type: |
| 80 | + title: Error Type |
| 81 | + type: string |
| 82 | + required: |
| 83 | + - loc |
| 84 | + - msg |
| 85 | + - type |
| 86 | + title: ValidationError |
| 87 | + type: object |
| 88 | + _HealthStatus: |
| 89 | + description: Health status enumeration. |
| 90 | + enum: |
| 91 | + - UP |
| 92 | + - DOWN |
| 93 | + title: _HealthStatus |
| 94 | + type: string |
| 95 | +info: |
| 96 | + contact: |
| 97 | + email: helmuthva@gmail.com |
| 98 | + name: Helmut Hoffer von Ankershoffen |
| 99 | + url: https://github.com/helmut-hoffer-von-ankershoffen |
| 100 | + termsOfService: https://oe-python-template-example.readthedocs.io/en/latest/ |
| 101 | + title: OE Python Template Example |
| 102 | + version: 1.0.0 |
| 103 | +openapi: 3.1.0 |
| 104 | +paths: |
| 105 | + /echo: |
| 106 | + post: |
| 107 | + description: "Echo back the provided text.\n\nArgs:\n request |
| 108 | +(EchoRequest):\ |
| 109 | + \ The request containing the text to echo back.\n\nReturns:\n |
| 110 | +EchoResponse:\ |
| 111 | + \ A response containing the echoed text.\n\nRaises:\n 422 |
| 112 | +Unprocessable\ |
| 113 | + \ Entity: If text is not provided or empty." |
| 114 | + operationId: echo_echo_post |
| 115 | + requestBody: |
| 116 | + content: |
| 117 | + application/json: |
| 118 | + schema: |
| 119 | + $ref: '#/components/schemas/EchoRequest' |
| 120 | + required: true |
| 121 | + responses: |
| 122 | + '200': |
| 123 | + content: |
| 124 | + application/json: |
| 125 | + schema: |
| 126 | + $ref: '#/components/schemas/EchoResponse' |
| 127 | + description: Successful Response |
| 128 | + '422': |
| 129 | + content: |
| 130 | + application/json: |
| 131 | + schema: |
| 132 | + $ref: '#/components/schemas/HTTPValidationError' |
| 133 | + description: Validation Error |
| 134 | + summary: Echo |
| 135 | + tags: |
| 136 | + - Basics |
| 137 | + /health: |
| 138 | + get: |
| 139 | + description: "Check the health of the service.\n\nThis endpoint returns |
| 140 | +the\ |
| 141 | + \ health status of the service.\nThe health status can be either UP or |
| 142 | +DOWN.\n\ |
| 143 | + If the service is healthy, the status will be UP.\nIf the service is |
| 144 | +unhealthy,\ |
| 145 | + \ the status will be DOWN and a reason will be provided.\nThe response |
| 146 | +will\ |
| 147 | + \ have a 200 OK status code if the service is healthy,\nand a 500 |
| 148 | +Internal\ |
| 149 | + \ Server Error status code if the service is unhealthy.\n\nReturns:\n |
| 150 | +Health:\ |
| 151 | + \ The health status of the service." |
| 152 | + operationId: health_health_get |
| 153 | + responses: |
| 154 | + '200': |
| 155 | + content: |
| 156 | + application/json: |
| 157 | + schema: |
| 158 | + $ref: '#/components/schemas/Health' |
| 159 | + description: Successful Response |
| 160 | + summary: Health |
| 161 | + tags: |
| 162 | + - Observability |
| 163 | + /healthz: |
| 164 | + get: |
| 165 | + description: "Check the health of the service.\n\nThis endpoint returns |
| 166 | +the\ |
| 167 | + \ health status of the service.\nThe health status can be either UP or |
| 168 | +DOWN.\n\ |
| 169 | + If the service is healthy, the status will be UP.\nIf the service is |
| 170 | +unhealthy,\ |
| 171 | + \ the status will be DOWN and a reason will be provided.\nThe response |
| 172 | +will\ |
| 173 | + \ have a 200 OK status code if the service is healthy,\nand a 500 |
| 174 | +Internal\ |
| 175 | + \ Server Error status code if the service is unhealthy.\n\nReturns:\n |
| 176 | +Health:\ |
| 177 | + \ The health status of the service." |
| 178 | + operationId: health_healthz_get |
| 179 | + responses: |
| 180 | + '200': |
| 181 | + content: |
| 182 | + application/json: |
| 183 | + schema: |
| 184 | + $ref: '#/components/schemas/Health' |
| 185 | + description: Successful Response |
| 186 | + summary: Health |
| 187 | + tags: |
| 188 | + - Observability |
| 189 | + /hello-world: |
| 190 | + get: |
| 191 | + description: "Return a hello world message.\n\nReturns:\n |
| 192 | +HelloWorldResponse:\ |
| 193 | + \ A response containing the hello world message." |
| 194 | + operationId: hello_world_hello_world_get |
| 195 | + responses: |
| 196 | + '200': |
| 197 | + content: |
| 198 | + application/json: |
| 199 | + schema: |
| 200 | + $ref: '#/components/schemas/HelloWorldResponse' |
| 201 | + description: Successful Response |
| 202 | + summary: Hello World |
| 203 | + tags: |
| 204 | + - Basics |
0 commit comments