Skip to content

v0.6.6 – Adoption Guides & Documentation Enhancements

Choose a tag to compare

View all tags
@bsayli bsayli released this 30 Sep 18:25
· 85 commits to main since this release
v0.6.6
71eb816

Refinement over v0.6.5 with a strong focus on documentation and adoption guidance, enabling teams to integrate the generics-aware client pattern seamlessly into their own projects.

Highlights

📘 New Adoption Guides:

  • Added docs/adoption/server-side-adoption.md — step-by-step guide to enabling wrapper schema registration in your microservice.
  • Added docs/adoption/client-side-adoption.md — instructions to generate clients with generics-aware wrappers using Mustache overlays.
  • Both guides include copy-paste ready snippets (Java + Maven + Mustache templates).

📄 Root README Updates:

  • Added 📘 Adoption Guides section with direct links to server-side and client-side docs.
  • Expanded Table of Contents for easier navigation.
  • Improved clarity on how to reproduce the client build locally (mvn clean install) and inspect generated wrappers.

Why it matters

  • Lowers the barrier for teams adopting generics-aware OpenAPI clients.
  • Provides a clear reference for server-side producers and client-side consumers alike.
  • Ensures documentation stays actionable and aligned with the evolving codebase.

Next Steps

  • Prepare groundwork for packaging into standalone artifacts:
    • io.github.bsayli:openapi-generics-autoreg (server-side)
    • io.github.bsayli:openapi-generics-templates (client-side)

➡️ This release emphasizes ease of adoption and sets the stage for broader community usage.

Assets 2
Loading