initial commit
All checks were successful
Build and Push to ACR / Build and Push (push) Successful in 46s
All checks were successful
Build and Push to ACR / Build and Push (push) Successful in 46s
Change-Id: I15e0d095273278f8531caa7399565fe92857a7ad
This commit is contained in:
22
docs/api.md
Normal file
22
docs/api.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# API Reference
|
||||
|
||||
Base URL: `https://test-alex-1.kyndemo.live`
|
||||
|
||||
Interactive docs: `/docs` (Swagger UI) · `/redoc` (ReDoc)
|
||||
|
||||
## Items
|
||||
|
||||
| Method | Path | Description |
|
||||
|--------|------|-------------|
|
||||
| GET | `/api/items` | List items |
|
||||
| POST | `/api/items` | Create item `{"name":"..","description":".."}` |
|
||||
| GET | `/api/items/{id}` | Get by ID |
|
||||
| PUT | `/api/items/{id}` | Update |
|
||||
| DELETE | `/api/items/{id}` | Delete |
|
||||
|
||||
## Observability
|
||||
|
||||
| Path | Description |
|
||||
|------|-------------|
|
||||
| `/health` | `{"status":"UP"}` |
|
||||
| `/metrics` | Prometheus text format |
|
||||
32
docs/architecture.md
Normal file
32
docs/architecture.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# Architecture
|
||||
|
||||
`test-alex-1` is a Python 3.12 **FastAPI** application served by **Uvicorn**.
|
||||
|
||||
## Components
|
||||
|
||||
| Component | Technology |
|
||||
|-----------|-----------|
|
||||
| Web framework | FastAPI 0.111 |
|
||||
| ASGI server | Uvicorn |
|
||||
| Metrics | prometheus-fastapi-instrumentator → `/metrics` |
|
||||
| Validation | Pydantic v2 models |
|
||||
| Health | Custom `/health` endpoint |
|
||||
| API docs | Built-in Swagger UI at `/docs` |
|
||||
|
||||
## Deployment flow
|
||||
|
||||
```
|
||||
Push to main
|
||||
│
|
||||
▼
|
||||
build-push.yml
|
||||
docker build (python:3.12-slim)
|
||||
docker push → ACR (OIDC)
|
||||
│
|
||||
▼
|
||||
deploy-humanitec.yml
|
||||
humctl score deploy → Humanitec
|
||||
│
|
||||
▼
|
||||
AKS pod :8000
|
||||
```
|
||||
9
docs/index.md
Normal file
9
docs/index.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# Home
|
||||
|
||||
test-alex-1 — test-alex-1
|
||||
|
||||
- **Runtime**: Python 3.12 · FastAPI · Uvicorn
|
||||
- **Owner**: group:default/platform-engineering
|
||||
- **Deployment profile**: `stateless`
|
||||
|
||||
See [Architecture](architecture.md) and [API Reference](api.md).
|
||||
Reference in New Issue
Block a user