Skip to main content

API Reference & Documentation

This section contains API documentation, notification templates, and other reference materials for the Axiom Genesis platform.

Contents​

Notification Email Templates​

  • Notification Email Templates - Handlebars-based email templates for workflow approvals including:
    • Approval Completed notifications
    • Approval Pending (action required)
    • Approval Pushback (revision requested)
    • Approval Rejected notifications

Template Files Location: axiom-genesis-middleware/templates/

Swagger/OpenAPI Documentation​

Note: Complete Swagger/OpenAPI documentation is maintained in the middleware for API reference and is auto-generated from route definitions.

  • Located in: axiom-genesis-middleware/docs/functional/
  • Files: swagger.json, swagger.js, Postman collections
  • Access Swagger UI: Start the middleware with npm run dev and navigate to /api-docs

API Endpoints​

For REST API endpoint documentation, see:

  • Middleware Routes: axiom-genesis-middleware/routes/ directory
  • Controllers: axiom-genesis-middleware/controllers/ directory
  • Swagger Docs: Auto-generated documentation available when middleware is running

Integration Points​

Email Notifications​

Templates are integrated with the workflow notification service:

  • Service: axiom-genesis-middleware/services/notification/email.service.js
  • Queue: axiom-genesis-middleware/queue/ for async delivery

API Documentation Generation​

  • Tool: swagger-autogen (configured in axiom-genesis-middleware/swagger.js)
  • Output: axiom-genesis-middleware/docs/functional/swagger.json
  • Postman Collections: Available in middleware for API testing

Adding Documentation​

When adding new API features:

  1. Document the endpoint in the appropriate controller file with JSDoc comments
  2. Swagger auto-generation will pick it up on next build
  3. Update this index if adding new major sections
  4. Follow existing patterns for consistency with other endpoints

Last Updated: March 14, 2026