mirror of
https://github.com/Such-Software/smirk-backend-core.git
synced 2026-10-17 15:31:38 +02:00
jwinterm
143f00701b
- minimal Axum server exposing GET /health - OpenAPI contract generated from handlers (gen_openapi -> openapi.json), drift-gated in CI so the spec can never silently diverge from the code - CI: secret-scan + gitleaks, openapi drift gate, fmt/clippy/build/test/doc-test, cargo-deny - Cargo.lock tracked for reproducible builds; publish=false; pinned toolchain - README, SECURITY.md, deny.toml, .env.example
63 lines
1.4 KiB
JSON
63 lines
1.4 KiB
JSON
{
|
|
"openapi": "3.1.0",
|
|
"info": {
|
|
"title": "smirk-backend-core",
|
|
"description": "Open, self-hostable backend for the Smirk non-custodial multi-chain wallet.",
|
|
"contact": {
|
|
"name": "John Winter Murphy",
|
|
"email": "jw@such.software"
|
|
},
|
|
"license": {
|
|
"name": ""
|
|
},
|
|
"version": "0.3.0"
|
|
},
|
|
"paths": {
|
|
"/health": {
|
|
"get": {
|
|
"tags": [
|
|
"system"
|
|
],
|
|
"summary": "Liveness probe.",
|
|
"description": "Returns `200` with `{ \"status\": \"ok\" }` whenever the server is up. Used by\nload balancers and uptime checks; requires no authentication.",
|
|
"operationId": "health",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Service is up",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HealthResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"components": {
|
|
"schemas": {
|
|
"HealthResponse": {
|
|
"type": "object",
|
|
"description": "Liveness response.",
|
|
"required": [
|
|
"status"
|
|
],
|
|
"properties": {
|
|
"status": {
|
|
"type": "string",
|
|
"description": "Always `\"ok\"` when the service is reachable."
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
{
|
|
"name": "system",
|
|
"description": "Service health and metadata."
|
|
}
|
|
]
|
|
}
|