Skip to content

docs(openapi): add /v1/onboarding/health to spec#43

Merged
btwshivam merged 1 commit into
mainfrom
docs/openapi-onboarding-health
May 29, 2026
Merged

docs(openapi): add /v1/onboarding/health to spec#43
btwshivam merged 1 commit into
mainfrom
docs/openapi-onboarding-health

Conversation

@btwshivam
Copy link
Copy Markdown
Member

@btwshivam btwshivam commented May 29, 2026

Summary

Adds the /v1/onboarding/health path so the backend openapi-parity gate (on optiqor/optiqor#41) passes.

Schema is additionalProperties: true for now — the blockers + service-health shape will tighten once it stabilises post-design-partner. Backend handler is on optiqor/optiqor#41.

Test plan

  • `bash ../optiqor/scripts/check-openapi-parity.sh` reports 22 / 22 routes documented
  • `yq` parse still clean (file remains valid YAML)

Backend PR optiqor/optiqor#41 adds the funnel-position + blockers
endpoint. Without the spec entry the openapi-parity gate fails on
that PR — CI requires every Go route to appear in the spec.

Schema is intentionally `additionalProperties: true` for now; the
blockers + service-health hints fields will tighten once they
stabilise post-design-partner.

Signed-off-by: btwshivam <shivam200446@gmail.com>
@github-actions github-actions Bot added documentation Improvements or additions to documentation size/S 11–50 lines labels May 29, 2026
@btwshivam btwshivam enabled auto-merge (squash) May 29, 2026 02:35
@btwshivam btwshivam disabled auto-merge May 29, 2026 02:35
@btwshivam btwshivam merged commit c810719 into main May 29, 2026
12 of 14 checks passed
@btwshivam btwshivam deleted the docs/openapi-onboarding-health branch May 29, 2026 02:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/S 11–50 lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant