Skip to content

feat: bump OpenAPI spec to 3.2.0 - #1277

Open
grdsdev wants to merge 5 commits into
masterfrom
feat/openapi-3-2-0
Open

feat: bump OpenAPI spec to 3.2.0#1277
grdsdev wants to merge 5 commits into
masterfrom
feat/openapi-3-2-0

Conversation

@grdsdev

@grdsdev grdsdev commented Jul 28, 2026

Copy link
Copy Markdown

Summary

  • Bump declared OpenAPI version from 3.1.0 to 3.2.0 in src/app.ts and src/admin-app.ts.
  • Update the corresponding spec-version assertions in src/app.test.ts / src/admin-app.test.ts.
  • Add a new script for validating generated openapi spec is valid

Test plan

  • npm run test:unit passes (public/admin app suites green; one pre-existing flaky pprof timeout test unrelated to this change).
  • Regenerated static/api.json / static/api-admin.json via npm run docs:export, confirmed "openapi":"3.2.0".
  • Validated both generated docs against the official OAS 3.2 meta-schema (@hyperjump/json-schema/openapi-3-2) — both valid.

grdsdev added 2 commits July 28, 2026 17:50
3.2 is a strict superset of 3.1 for our purposes; validated the
generated docs against the official OAS 3.2 meta-schema.
@coveralls

coveralls commented Jul 28, 2026

Copy link
Copy Markdown

Coverage Report for CI Build 30402221115

Coverage decreased (-0.005%) to 80.405%

Details

  • Coverage decreased (-0.005%) from the base build.
  • Patch coverage: No coverable lines changed in this PR.
  • No coverage regressions found.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

No coverage regressions found.


Coverage Stats

Coverage Status
Relevant Lines: 12820
Covered Lines: 10748
Line Coverage: 83.84%
Relevant Branches: 7532
Covered Branches: 5616
Branch Coverage: 74.56%
Branches in Coverage %: Yes
Coverage Strength: 413.77 hits per line

💛 - Coveralls

Builds both apps, fetches their /documentation/json, and validates
against the official OAS 3.2 meta-schema (@hyperjump/json-schema).
@grdsdev
grdsdev marked this pull request as ready for review July 28, 2026 20:59
@grdsdev
grdsdev requested a review from a team as a code owner July 28, 2026 20:59
Comment thread src/app.ts
Comment thread src/scripts/validate-openapi.ts Outdated
grdsdev added 2 commits July 28, 2026 18:43
schema-base recursively validates Schema Objects against the OAS 3.2
dialect; schema alone only checks them as opaque objects.
OpenAPI 3.2 Schema Objects are pure JSON Schema 2020-12, which has no
nullable keyword — it's silently ignored, so these fields were
documented as non-nullable despite AJV still accepting null at
runtime. Use type: [X, 'null'] instead.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants