Skip to content

json-api-codegen: v1.0.0

Choose a tag to compare

View all tags
@github-actions github-actions released this 13 Jul 10:50
json-api-codegen-v1.0.0
c852e7b
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

1.0.0 (2026-07-13)

⚠ BREAKING CHANGES

  • client: a document action's generated input is now flat resource input (not the raw envelope) and its result is the materialised resource (not the raw document); regenerate the client to pick up the new types.
  • read query types are narrower. get(id, query) no longer accepts filter/sort/page; list(query)'s filter keys and sort tokens must be ones the type's OpenAPI document advertises (an unadvertised key/token, or any filter/sort on a type that advertises none, is now a compile error). Regenerate the client from your /docs.json to pick up the new descriptor fields.

Features

  • client: carry per-relation withCount + report the real empty-page kind (#22) (1b8f082)
  • client: custom actions + atomic transaction builder + per-relation verb gating (#7) (3c7e15e)
  • client: derive the custom-action surface from the descriptor (#20) (f66d6d4)
  • client: finalize reads — sparse fieldsets, withCount, cursor, content negotiation (#9) (9974b55)
  • client: the read runtime — transport, materialise, pagination, typed fluent reads (#4) (662c40b)
  • client: type meta.pivot from the descriptor instead of erasing it to a boolean (#23) (424c4f3)
  • client: writes — flat-input envelope, pointer remapping, create/update/delete + relationship mutation (#6) (2e4afc9)
  • codegen: carry OpenAPI descriptions into the generated client as JSDoc (#3) (2132332)
  • codegen: generate a typed descriptor and client from the OpenAPI spec (#1) (003289d)
  • codegen: stamp provenance and add a --check drift gate (#27) (bacc7a3)
  • narrow include/sort/filter to the OpenAPI-advertised values (#16) (0804af5)
  • opt-in validation seam — emitted schemas, validate? hook, ajv adapter (#11) (3a88dd2)

Bug Fixes

  • client: make the descriptor faithful to per-relation exposure + structured filters (#21) (a797240)
  • codegen: detect cursor pagination from page[after]/page[before] (#25) (7d6d0f9)
  • codegen: resolve a related collection's paginator per relation (#30) (8521cb5)

Dependencies

  • The following workspace dependencies were updated
    • dependencies
      • @haddowg/json-api-client bumped to 1.0.0
Assets 2
Loading