api

package

v0.0.0-...-b9a5b38 Latest Latest Go to latest Published: Oct 16, 2026 License: MIT Imports: 11 Imported by: 0

Details

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

Repository

github.com/Tony5897/opsgrid

Links

Open Source Insights

Documentation ¶

Overview ¶

Package api adapts the generated OpenAPI strict-server interface (internal/api/gen) to OpsGrid's HTTP platform: request decoding errors and handler errors become RFC 9457 problems through httpx.WriteError, and the generated routes mount on a standard ServeMux.

Domain modules implement their slice of gen.StrictServerInterface in their own http.go adapters; Server composes them.

Index ¶

func Handler(srv gen.StrictServerInterface, mux *http.ServeMux, log *slog.Logger) http.Handler
type Server

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Handler ¶

func Handler(srv gen.StrictServerInterface, mux *http.ServeMux, log *slog.Logger) http.Handler

Handler mounts the generated routes on mux with OpsGrid error handling.

Types ¶

type Server ¶

type Server struct {
	Identity *identity.Service
	Tenancy  *tenancy.Service
}

Server implements gen.StrictServerInterface.

func (*Server) GetMe ¶

func (s *Server) GetMe(ctx context.Context, _ gen.GetMeRequestObject) (gen.GetMeResponseObject, error)

GetMe returns the authenticated caller and active memberships.

func (*Server) GetMeta ¶

func (*Server) GetMeta(context.Context, gen.GetMetaRequestObject) (gen.GetMetaResponseObject, error)

GetMeta returns build information.

func (*Server) GetOrganization ¶

func (s *Server) GetOrganization(ctx context.Context, req gen.GetOrganizationRequestObject) (gen.GetOrganizationResponseObject, error)

GetOrganization returns an org the caller may access.

Source Files ¶

View all Source files

api.go

Directories ¶

Path	Synopsis
apitest Package apitest validates HTTP exchanges against the OpenAPI contract.	Package apitest validates HTTP exchanges against the OpenAPI contract.
gen Package gen provides primitives to interact with the openapi HTTP API.	Package gen provides primitives to interact with the openapi HTTP API.

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