chore(api): use static version example in health endpoint OpenAPI spec

[FSM1]

Summary

• Replace dynamic openApiVersion with static 1.0.0 in the health endpoint's version example field
• Prevents the OpenAPI spec from drifting on release bumps (follow-up to fix(ci): exclude openapi.json version from spec verification #434)

🤖 Generated with Claude Code

Summary by CodeRabbit

• Bug Fixes
  • Updated the health endpoint response to use a fixed version value instead of a dynamically computed value.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: b1f28534-1eea-47e6-94bf-71b11355b9bc

📥 Commits

Reviewing files that changed from the base of the PR and between 4471b1b and fc45447.

⛔ Files ignored due to path filters (1)

• packages/api-client/openapi.json is excluded by !packages/api-client/**

📒 Files selected for processing (1)

• apps/api/scripts/generate-openapi.ts

---

Walkthrough

The /health endpoint response schema in the OpenAPI generation script has its version field example value changed from a dynamically computed reference to a fixed hardcoded string '1.0.0'.

Changes

Cohort / File(s)	Summary
OpenAPI Health Endpoint Schema apps/api/scripts/generate-openapi.ts	Modified the /health endpoint response schema's version field example from dynamic openApiVersion to fixed value '1.0.0'

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• feat(api): expose API version on /health endpoint #429: Added the version property with an example to the /health response schema; this PR modifies that example value
• chore(ci): align api-client versions with API and fix OpenAPI versioning #428: Previously modified OpenAPI version handling in the same file; this PR changes how the version example is defined

Suggested labels

release:api:feat

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'chore(api): use static version example in health endpoint OpenAPI spec' clearly and specifically describes the main change: replacing dynamic version with a static example in the health endpoint's OpenAPI specification.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch chore/static-openapi-version-example

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[github-actions]

Release Preview

No version bumps detected. All changes are in unversioned paths or use exempt commit types.

[Copilot]

Pull request overview

Updates the generated OpenAPI specification to keep the /health response version example stable across release bumps, avoiding spec drift caused by dynamic package version injection (follow-up to #434).

Changes:

• Replace dynamic openApiVersion with a static '1.0.0' example for the /health response version field in the OpenAPI generation script.
• Regenerate/commit the corresponding change in packages/api-client/openapi.json.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File	Description
apps/api/scripts/generate-openapi.ts	Pins the /health response version schema example to a static string instead of openApiVersion.
packages/api-client/openapi.json	Updates the committed OpenAPI spec to reflect the new static example value for /health.version.

[Copilot]

The /health response version reflects the running service version (API_VERSION from package.json/env). Using a fixed example of 1.0.0 is likely to mislead readers since it won’t match the real value and also differs from info.version in the same OpenAPI document. Consider using an obvious placeholder (e.g. 0.0.0 / x.y.z) or adding clarifying wording so consumers don’t interpret it as the current API version.

Suggested change

	version: { type: 'string', example: '1.0.0' },
	version: { type: 'string', example: 'x.y.z' },

[Copilot]

This fixed example (1.0.0) for the /health version field is inconsistent with the OpenAPI document’s info.version and with the endpoint’s actual runtime behavior (it returns the service/package version). Consider switching to an obvious placeholder (e.g. 0.0.0 / x.y.z) or clarifying that the example is not meant to track the deployed version.

Suggested change

	"example": "1.0.0"
	"example": "x.y.z"