api

package

v1.2.3 Latest Latest Go to latest Published: Nov 24, 2025 License: AGPL-3.0, AGPL-3.0-or-later Imports: 17 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/btouchard/ackify-ce

Links

Open Source Insights

Documentation ¶

Overview ¶

SPDX-License-Identifier: AGPL-3.0-or-later

Index ¶

func NewRouter(cfg RouterConfig) *chi.Mux
type RouterConfig

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func NewRouter ¶

func NewRouter(cfg RouterConfig) *chi.Mux

NewRouter creates and configures the API v1 router

Types ¶

type RouterConfig ¶

type RouterConfig struct {
	AuthService               *auth.OauthService
	MagicLinkService          *services.MagicLinkService
	SignatureService          *services.SignatureService
	DocumentService           *services.DocumentService
	DocumentRepository        *database.DocumentRepository
	ExpectedSignerRepository  *database.ExpectedSignerRepository
	ReminderService           *services.ReminderAsyncService // Now using async service
	WebhookRepository         *database.WebhookRepository
	WebhookDeliveryRepository *database.WebhookDeliveryRepository
	WebhookPublisher          *services.WebhookPublisher
	BaseURL                   string
	AdminEmails               []string
	AutoLogin                 bool
	OAuthEnabled              bool
	MagicLinkEnabled          bool
	OnlyAdminCanCreate        bool
	AuthRateLimit             int // Global auth rate limit (requests per minute), default: 5
	DocumentRateLimit         int // Document creation rate limit (requests per minute), default: 10
	GeneralRateLimit          int // General API rate limit (requests per minute), default: 100
}

RouterConfig holds configuration for the API router

Source Files ¶

View all Source files

router.go

Directories ¶

Path	Synopsis
admin SPDX-License-Identifier: AGPL-3.0-or-later	SPDX-License-Identifier: AGPL-3.0-or-later
auth SPDX-License-Identifier: AGPL-3.0-or-later	SPDX-License-Identifier: AGPL-3.0-or-later
documents SPDX-License-Identifier: AGPL-3.0-or-later	SPDX-License-Identifier: AGPL-3.0-or-later
health SPDX-License-Identifier: AGPL-3.0-or-later	SPDX-License-Identifier: AGPL-3.0-or-later
shared SPDX-License-Identifier: AGPL-3.0-or-later	SPDX-License-Identifier: AGPL-3.0-or-later
signatures SPDX-License-Identifier: AGPL-3.0-or-later	SPDX-License-Identifier: AGPL-3.0-or-later
users SPDX-License-Identifier: AGPL-3.0-or-later	SPDX-License-Identifier: AGPL-3.0-or-later

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL