Skip to content

armgit / Ix

Public Imported from GitHub
0

Understand any codebase instantly. System intelligence for codebases, built for humans and AI.

docs(api): document release_version on /v1/health (#602)

Alot1z36c80e546b76
diff --git a/docs/api/README.md b/docs/api/README.md
index db775749..1eb5dd75 100644
--- a/docs/api/README.md
+++ b/docs/api/README.md
@@ -81,7 +81,7 @@ curl -s -X POST http://localhost:8090/v1/context \
| Method | Path | Client | Purpose |
|---|---|---|---|
-| GET | `/v1/health` | `health()` | Liveness, status, `schema_version` |
+| GET | `/v1/health` | `health()` | Liveness, status, `schema_version`, `release_version` |
| GET | `/v1/capabilities` | `capabilities()` | Pro feature flags |
| POST | `/v1/context` | `query()` | Structured-context QA |
@@ -91,14 +91,17 @@ curl -s -X POST http://localhost:8090/v1/context \
#### GET `/v1/health`
-Liveness probe. Returns `{"status": "ok", "schema_version": 3}`. A client whose
-expected schema version differs forces a clean re-ingest (e.g. after the
-absolute→relative `source_uri` migration).
+Liveness probe. Returns `{"status": "ok", "schema_version": 3, "release_version": "1.0.28"}`.
+A client whose expected schema version differs forces a clean re-ingest (e.g. after the
+absolute→relative `source_uri` migration). `release_version` is the semver the running
+container was built as, when it knows — the container's own claim, not proof (it is an
+env var, so `docker run -e` can override it); clients fall back to the release they
+tracked when the field is absent.
**Response**
```json
-{ "status": "ok", "schema_version": 3 }
+{ "status": "ok", "schema_version": 3, "release_version": "1.0.28" }
```
#### GET `/v1/capabilities`
@@ -764,7 +767,7 @@ interface PatchCommitResult { status: string; rev: number; }
### HealthResponse
```ts
-interface HealthResponse { status: string; schema_version?: number; }
+interface HealthResponse { status: string; schema_version?: number; release_version?: string; }
```
### CapabilitiesResponse
diff --git a/docs/api/openapi.yaml b/docs/api/openapi.yaml
index a9a3ca38..efb95e95 100644
--- a/docs/api/openapi.yaml
+++ b/docs/api/openapi.yaml
@@ -977,6 +977,7 @@ components:
properties:
status: { type: string }
schema_version: { type: integer, description: On-disk graph format version }
+ release_version: { type: string, description: Backend release semver }
CapabilitiesResponse:
type: object
properties: