openfgav1gateway

Documentation

Overview

Package openfgav1gateway is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Deprecated: This package has moved to "buf.build/gen/go/openfga/api/grpc-ecosystem/gateway/v2/openfga/v1/openfgav1gateway". Use that import path instead.

Index

• Variables

Variables

var (

	// RegisterOpenFGAServiceHandlerServer registers the http handlers for service OpenFGAService to "mux".
	// UnaryRPC     :call OpenFGAServiceServer directly.
	// StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906.
	// Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterOpenFGAServiceHandlerFromEndpoint instead.
	// GRPC interceptors will not work for this type of registration. To use interceptors, you must use the "runtime.WithMiddlewares" option in the "runtime.NewServeMux" call.
	RegisterOpenFGAServiceHandlerServer = gateway.RegisterOpenFGAServiceHandlerServer

	// RegisterOpenFGAServiceHandlerFromEndpoint is same as RegisterOpenFGAServiceHandler but
	// automatically dials to "endpoint" and closes the connection when "ctx" gets done.
	RegisterOpenFGAServiceHandlerFromEndpoint = gateway.RegisterOpenFGAServiceHandlerFromEndpoint

	// RegisterOpenFGAServiceHandler registers the http handlers for service OpenFGAService to "mux".
	// The handlers forward requests to the grpc endpoint over "conn".
	RegisterOpenFGAServiceHandler = gateway.RegisterOpenFGAServiceHandler

	// RegisterOpenFGAServiceHandlerClient registers the http handlers for service OpenFGAService
	// to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "openfgav1grpc.OpenFGAServiceClient".
	// Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "openfgav1grpc.OpenFGAServiceClient"
	// doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in
	// "openfgav1grpc.OpenFGAServiceClient" to call the correct interceptors. This client ignores the HTTP middlewares.
	RegisterOpenFGAServiceHandlerClient = gateway.RegisterOpenFGAServiceHandlerClient
)