Skip to content

GET /version response drifts from openapi.yml Version schema #870

Description

@hf-krechan

Summary

The root GET /version endpoint's actual response fields don't match the Version schema documented in openapi.yml.

Details

src/server.ts (server.get('/version', ...)) returns:

{
  "buildDate": "...",
  "commitDate": "...",
  "commitId": "...",
  "version": "...",
  "environment": "...",
  "name": "ahb-tabellen"
}

openapi.yml's Version schema documents:

Version:
  type: object
  properties:
    version:
      type: string
    buildDate:
      type: string
    commitHash:
      type: string
    commitDate:
      type: string
    buildBranch:
      type: string

Mismatches:

  • commitHash (documented) vs commitId (actual) — field name mismatch
  • buildBranch is documented but never returned by the code
  • environment and name are returned by the code but not documented

This predates the docs/openapi-health-endpoint branch — introduced in be876ba2 (PR #722, "feat: implement comparison logic").

Suggested fix

Either rename commitIdcommitHash and add buildBranch in src/server.ts, or update the Version schema in openapi.yml to match the actual response (adding environment/name, dropping/renaming commitHash/buildBranch as appropriate) — whichever reflects the intended contract.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions