Skip to content

Releases: newbpydev/go-sentinel

Go Sentinel v0.1.0 — First Documented API Release

12 May 20:43
@newbpydev newbpydev
v0.1.0
ca114e8
Compare
Choose a tag to compare
Go Sentinel v0.1.0 — First Documented API Release Pre-release
Pre-release

🚀 Go Sentinel v0.1.0 — First Documented API Release

Highlights

  • OpenAPI Documentation
    All major endpoints (/health, /metrics, /docs, /ws) are now fully documented using an OpenAPI YAML spec, making it easy for developers to understand and integrate with the API.

  • /docs Endpoint
    The /docs endpoint serves the OpenAPI YAML directly, providing a single source of truth for API consumers and tooling.

  • Interactive Swagger UI
    Explore and test the API interactively at /docs/ui using Swagger UI, which is automatically kept in sync with the OpenAPI spec.

  • GoDoc Comments
    All handlers and exported types are now annotated with GoDoc comments, paving the way for future automated documentation and improved developer experience.

  • .gitignore Improvements
    The repository is now cleaner and more maintainable, with Swagger UI build artifacts, temp files, and generated OpenAPI YAML excluded from version control.

What’s Next

This is an early, pre-stable release (0.1.0). The API and its documentation will continue to evolve. Upcoming milestones include:

  • Advanced UI features and coverage visualization
  • Additional endpoints and API enhancements
  • Continuous improvements based on user feedback

How to Upgrade

  • Pull the latest changes and check out the v0.1.0 tag.
  • Visit /docs for the OpenAPI YAML or /docs/ui for the interactive Swagger UI.
  • Review the updated documentation and changelog for details.

Thank you for trying Go Sentinel! Your feedback will help shape the next releases.

Loading