initial commit
All checks were successful
Build and Publish TechDocs / build-and-publish (push) Successful in 1m18s

Change-Id: I95ca3434b80e3f1f3d817b33be8656db244c320c
This commit is contained in:
Scaffolder
2026-04-20 16:55:01 +00:00
commit 13e8f01848
16 changed files with 1403 additions and 0 deletions

20
docs/api.md Normal file
View File

@@ -0,0 +1,20 @@
# API Reference
Base URL: `https://test-for-174--015.kyndemo.live`
## Items `/api/items`
| Method | Path | Body | Response |
|--------|------|------|----------|
| GET | `/api/items` | — | Array of items |
| POST | `/api/items` | `{"name":"...","description":"..."}` | Created item (201) |
| GET | `/api/items/{id}` | — | Item or 404 |
| PUT | `/api/items/{id}` | `{"name":"...","description":"..."}` | Updated item |
| DELETE | `/api/items/{id}` | — | `{"deleted":id}` |
## Observability
| Path | Description |
|------|-------------|
| `/actuator/health` | Health check — `{"status":"UP"}` |
| `/metrics` | Prometheus exposition format |

30
docs/architecture.md Normal file
View File

@@ -0,0 +1,30 @@
# Architecture
`test-for-174--015` is a `java-springboot` service.
| Component | Detail |
|-----------|--------|
| Runtime | `java-springboot` |
| Container port | `8080` |
| Health check | `/actuator/health` |
| Metrics | `/metrics` (Prometheus format) |
| Image | Azure Container Registry (`bstagecjotdevacr`) |
## Deployment flow
```
Push to dev/staging/prod
→ build-push.yml (build + test → push image to ACR)
→ deploy-humanitec.yml (hctl score deploy)
```
## Branch model
| Branch | Purpose |
|--------|---------|
| `main` | System of record — catalog, docs, score.yaml, platform config |
| `dev` | Active development |
| `staging` | Pre-production (lazy-created on first promote) |
| `prod` | Production (lazy-created on first promote) |
Promotions between environments are triggered from the Backstage CI/CD tab.

45
docs/index.md Normal file
View File

@@ -0,0 +1,45 @@
# test-for-174--015
Test for issue 174 PR
## Overview
This service was scaffolded from the **Create Microservice** golden-path template on the Kyndryl Platform.
- **Runtime**: `java-springboot`
- **Owner**: group:default/platform-lead
- **Deployment profile**: `stateless`
## Architecture
See [architecture.md](architecture.md) for the full architecture diagram.
At a glance:
```
┌──────────────────────────────────────┐
│ Gitea Actions CI/CD │
│ ┌─────────────┐ ┌───────────────┐ │
│ │ build-push │→ │ deploy- │ │
│ │ .yml │ │ humanitec.yml │ │
│ └─────────────┘ └───────────────┘ │
└──────────────────────────────────────┘
│ │
▼ ▼
Azure ACR Humanitec API
AKS (via Score)
┌──────────────────────────┐
│ test-for-174--015 │
│ :8080 │
│ /api/items │
│ /actuator/health │
└──────────────────────────┘
```
## API Reference
See [api.md](api.md) for the full OpenAPI reference.