api

package

v0.52.0 Latest Latest Go to latest Published: Mar 11, 2026 License: MPL-2.0 Imports: 18 Imported by: 0

Documentation ¶

Overview ¶

Package api package

Index ¶

func AddRoutes(router chi.Router, controller controllers.Controller)
func BuildRouter(cfg *config.Config, logger logger.Logger, respWriter response.Writer, ...) (chi.Router, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func AddRoutes ¶ added in v0.39.0

func AddRoutes(router chi.Router, controller controllers.Controller)

AddRoutes adds the controllers routes to the path

func BuildRouter ¶ added in v0.39.0

func BuildRouter(
	cfg *config.Config,
	logger logger.Logger,
	respWriter response.Writer,
	pluginCatalog *plugin.Catalog,
	authenticator auth.Authenticator,
	serviceCatalog *services.Catalog,
	searchManager universalsearch.Manager,
	userSessionManager auth.UserSessionManager,
	signingKeyManager auth.SigningKeyManager,
) (chi.Router, error)

BuildRouter builds the http router for the API server

Types ¶

This section is empty.

Source Files ¶

View all Source files

routes.go

Directories ¶

Path	Synopsis
controllers Package controllers adds support for RESTful endpoints.	Package controllers adds support for RESTful endpoints.
graphql Package graphql package	Package graphql package
loader Package loader package	Package loader package
resolver Package resolver contains functionality for interacting with the API via GraphQL.	Package resolver contains functionality for interacting with the API via GraphQL.
schema Package schema contains all of the Schema Definition Files (abbreviated SDL) which define this API.	Package schema contains all of the Schema Definition Files (abbreviated SDL) which define this API.
grpc Package grpc implements gRPC functionality.	Package grpc implements gRPC functionality.
interceptors Package interceptors contains the GRPC interceptors	Package interceptors contains the GRPC interceptors
reader Package reader implements a size-limited reader for uploading templates of multiple kinds.	Package reader implements a size-limited reader for uploading templates of multiple kinds.
servers Package servers implements the gRPC servers.	Package servers implements the gRPC servers.
middleware Package middleware allows adding custom middleware(s) to the RESTful API, such as, JWT based authentication.	Package middleware allows adding custom middleware(s) to the RESTful API, such as, JWT based authentication.
response Package response providers support for returning http responses	Package response providers support for returning http responses

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